BBMRI.de/GBA Implementation Guide - Local Development build (v1.2.0). See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Biobank - Mappings

Active as of 2023-09-01

Mappings for the Biobank resource profile.

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

Biobank
Organization	(also see master files messages)
identifier	XON.10 / XON.3
identifier (Bbmri-EricId)	XON.10 / XON.3
use	N/A
type	CX.5
system	CX.4 / EI-2-4
value	CX.1 / EI.1
period	CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
active	No equivalent in HL7 v2
type	No equivalent in v2
name	XON.1
telecom	ORC-22?
telecom (url)	ORC-22?
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
address	ORC-23?
use	XAD.7
type	XAD.18
text	XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
line	XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
city	XAD.3
district	XAD.9
state	XAD.4
postalCode	XAD.5
country	XAD.6
period	XAD.12 / XAD.13 + XAD.14
partOf	No equivalent in HL7 v2
contact
purpose
name	PID-5, PID-9
telecom	PID-13, PID-14
address	PID-11
contact (head)
purpose
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
name	PID-5, PID-9
use	XPN.7, but often indicated by which field contains the name
text	implied by XPN.11
family	XPN.1/FN.1
given	XPN.2 + XPN.3
prefix	XPN.5
suffix	XPN/4
period	XPN.13 + XPN.14
telecom	PID-13, PID-14
address	PID-11
contact (contact)
purpose
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
name	PID-5, PID-9
use	XPN.7, but often indicated by which field contains the name
text	implied by XPN.11
family	XPN.1/FN.1
given	XPN.2 + XPN.3
prefix	XPN.5
suffix	XPN/4
period	XPN.13 + XPN.14
telecom	PID-13, PID-14
telecom (phone)	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (email)	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
address	PID-11
use	XAD.7
type	XAD.18
text	XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
line	XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
city	XAD.3
district	XAD.9
state	XAD.4
postalCode	XAD.5
country	XAD.6
period	XAD.12 / XAD.13 + XAD.14

Mappings for RIM Mapping (http://hl7.org/v3)

Biobank
Organization	Entity. Role, or Act, Organization(classCode=ORG, determinerCode=INST)
text	Act.text?
contained	N/A
modifierExtension	N/A
identifier	.scopes[Role](classCode=IDENT)
identifier (Bbmri-EricId)	.scopes[Role](classCode=IDENT)
id	n/a
extension	n/a
use	Role.code or implied by context
type	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	Role.effectiveTime or implied by context
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
active	.status
type	.code
name	.name
alias	.name
telecom	.telecom
telecom (url)	.telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
address	.address
id	n/a
use	unique(./use)
type	unique(./use)
text	./formatted
line	AD.part[parttype = AL]
city	AD.part[parttype = CTY]
district	AD.part[parttype = CNT | CPA]
state	AD.part[parttype = STA]
postalCode	AD.part[parttype = ZIP]
country	AD.part[parttype = CNT]
period	./usablePeriod[type="IVL<TS>"]
partOf	.playedBy[classCode=Part].scoper
contact	.contactParty
id	n/a
extension	n/a
modifierExtension	N/A
purpose	./type
name	./name
telecom	./telecom
address	./addr
contact (head)	.contactParty
id	n/a
modifierExtension	N/A
purpose	./type
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
name	./name
id	n/a
extension	n/a
use	unique(./use)
text	./formatted
family	./part[partType = FAM]
given	./part[partType = GIV]
prefix	./part[partType = PFX]
suffix	./part[partType = SFX]
period	./usablePeriod[type="IVL<TS>"]
telecom	./telecom
address	./addr
contact (contact)	.contactParty
id	n/a
extension	n/a
modifierExtension	N/A
purpose	./type
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
name	./name
id	n/a
extension	n/a
use	unique(./use)
text	./formatted
family	./part[partType = FAM]
given	./part[partType = GIV]
prefix	./part[partType = PFX]
suffix	./part[partType = SFX]
period	./usablePeriod[type="IVL<TS>"]
telecom	./telecom
telecom (phone)	./telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (email)	./telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
address	./addr
id	n/a
extension	n/a
use	unique(./use)
type	unique(./use)
text	./formatted
line	AD.part[parttype = AL]
city	AD.part[parttype = CTY]
district	AD.part[parttype = CNT | CPA]
state	AD.part[parttype = STA]
postalCode	AD.part[parttype = ZIP]
country	AD.part[parttype = CNT]
period	./usablePeriod[type="IVL<TS>"]
endpoint	n/a

Mappings for ServD (http://www.omg.org/spec/ServD/1.0/)

Biobank
Organization	Organization
identifier	./Identifiers
identifier (Bbmri-EricId)	./Identifiers
system	./IdentifierType
value	./Value
period	./StartDate and ./EndDate
assigner	./IdentifierIssuingAuthority
active	./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
type	n/a
name	.PreferredName/Name
telecom	./ContactPoints
telecom (url)	./ContactPoints
system	./ContactPointType
value	./Value
use	./ContactPointPurpose
period	./StartDate and ./EndDate
address	./PrimaryAddress and ./OtherAddresses
use	./AddressPurpose
line	./StreetAddress (newline delimitted)
city	./Jurisdiction
state	./Region
postalCode	./PostalIdentificationCode
country	./Country
period	./StartDate and ./EndDate
partOf	n/a
contact
name
telecom
address
contact (head)
name
use	./NamePurpose
family	./FamilyName
given	./GivenNames
prefix	./TitleCode
period	./StartDate and ./EndDate
telecom
address
contact (contact)
name
use	./NamePurpose
family	./FamilyName
given	./GivenNames
prefix	./TitleCode
period	./StartDate and ./EndDate
telecom
telecom (phone)
system	./ContactPointType
value	./Value
use	./ContactPointPurpose
period	./StartDate and ./EndDate
telecom (email)
system	./ContactPointType
value	./Value
use	./ContactPointPurpose
period	./StartDate and ./EndDate
address
use	./AddressPurpose
line	./StreetAddress (newline delimitted)
city	./Jurisdiction
state	./Region
postalCode	./PostalIdentificationCode
country	./Country
period	./StartDate and ./EndDate

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

Biobank
Organization
identifier	FiveWs.identifier
identifier (Bbmri-EricId)	FiveWs.identifier
active	FiveWs.status
type	FiveWs.class