This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
1.13.3 Data Type Formal Definitions
This page provides mappings for the data types. There are mappings to HL7 v2, v3, and (where appropraite) vCard.
Element Identifier HumanName Address Contact Schedule Quantity Attachment Range Period Ratio CodeableConcept Coding SampledData Age Distance Duration Count Money
1.13.3.1 Attachment
See also Base Definition , Examples and Formal Definitions .
1.13.3.2 Mappings for HL7 v2 (http://hl7.org/v2)
Attachment ED/RP
contentType ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
language
data ED.5
url RP.1+RP.2 - if they refer to a URL (see v2.6)
size
hash
title
1.13.3.3 Mappings for RIM (http://hl7.org/v3)
Attachment ED
contentType ./mediaType, ./charset
language ./language
data ./data
url ./reference/literal
size N/A (needs data type R3 proposal)
hash .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
title ./title/data
1.13.3.4 Identifier
See also Base Definition , Examples and Formal Definitions .
1.13.3.5 Mappings for HL7 v2 (http://hl7.org/v2)
Identifier CX / EI (occasionally, more often EI maps to a resource id or a URL)
use CX.5
label N/A
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)
1.13.3.6 Mappings for RIM (http://hl7.org/v3)
Identifier II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs
use N/A - this is sometimes implied by context
label N/A - this is sometimes implied by context
system II.root
value II.extension or II.root if system indicates OID or GUID
period N/A - this is sometimes implied by context
assigner II.assigningAuthorityName but note that this is an improper use by the definition of the field
1.13.3.7 Mappings for ServD (http://www.omg.org/spec/ServD/1.0/)
Identifier Identifier
use
label
system ./IdentifierType
value ./Value
period ./StartDate and ./EndDate
assigner ./IdentifierIssuingAuthority
1.13.3.8 Coding
See also Base Definition , Examples and Formal Definitions .
1.13.3.9 Mappings for HL7 v2 (http://hl7.org/v2)
Coding CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
system C*E.3
version C*E.7
code C*E.1
display C*E.2 - but note this is not well followed
primary Sometimes implied by being first
valueSet C*E.16 - .19
1.13.3.10 Mappings for RIM (http://hl7.org/v3)
Coding CV
system ./codeSystem
version ./codeSystemVersion
code ./code
display CV.displayName
primary CD.codingRationale
valueSet CD.valueSet / CD.valueSetVersion
1.13.3.11 CodeableConcept
See also Base Definition , Examples and Formal Definitions .
1.13.3.12 Mappings for HL7 v2 (http://hl7.org/v2)
CodeableConcept CE/CNE/CWE
coding C*E.1-8, C*E.10-22
text C*E.9. But note many systems use C*E.2 for this
1.13.3.13 Mappings for RIM (http://hl7.org/v3)
CodeableConcept CD
coding union(., ./translation)
text ./originalText[mediaType/code="text/plain"]/data
1.13.3.14 Quantity
See also Base Definition , Examples and Formal Definitions .
1.13.3.15 Mappings for HL7 v2 (http://hl7.org/v2)
Quantity SN (see also Range) or CQ
value SN.2 / CQ - N/A
comparator SN.1 / CQ.1
units (see OBX.6 etc) / CQ.2
system (see OBX.6 etc) / CQ.2
code (see OBX.6 etc) / CQ.2
1.13.3.16 Mappings for RIM (http://hl7.org/v3)
Quantity PQ, IVL<PQ>, MO, CO, depending on the values
value PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
comparator IVL properties
units PQ.unit
system CO.codeSystem, PQ.translation.codeSystem
code PQ.code, MO.currency, PQ.translation.code
1.13.3.17 Range
See also Base Definition , Examples and Formal Definitions .
1.13.3.18 Mappings for HL7 v2 (http://hl7.org/v2)
Range NR and also possibly SN (but see also quantity)
low NR.1
high NR.2
1.13.3.19 Mappings for RIM (http://hl7.org/v3)
Range IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>
low ./low
high ./high
1.13.3.20 Ratio
See also Base Definition , Examples and Formal Definitions .
1.13.3.21 Mappings for HL7 v2 (http://hl7.org/v2)
Ratio N/A
numerator
denominator
1.13.3.22 Mappings for RIM (http://hl7.org/v3)
Ratio RTO
numerator .numerator
denominator .denominator
1.13.3.23 Period
See also Base Definition , Examples and Formal Definitions .
1.13.3.24 Mappings for HL7 v2 (http://hl7.org/v2)
Period DR
start DR.1
end DR.2
1.13.3.25 Mappings for RIM (http://hl7.org/v3)
Period IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
start ./low
end ./high
1.13.3.26 SampledData
See also Base Definition , Examples and Formal Definitions .
1.13.3.27 Mappings for HL7 v2 (http://hl7.org/v2)
SampledData N/A (but see section 7.14 in v2.7)
origin
period
factor
lowerLimit
upperLimit
dimensions
data
1.13.3.28 Mappings for RIM (http://hl7.org/v3)
SampledData SLIST + GLIST
origin SLIST.origin
period GLIST.increment
factor SLIST.factor
lowerLimit N/A (use SLIST.digits.nullFlavor)
upperLimit N/A (use SLIST.digits.nullFlavor)
dimensions N/A (fixed to 1)
data SLIST.digits
1.13.3.29 HumanName
See also Base Definition , Examples and Formal Definitions .
1.13.3.30 Mappings for HL7 v2 (http://hl7.org/v2)
HumanName XPN
use XPN.7, but often indicated by which field contains the name
text implied by XPN.11
family XPN.1
given XPN.2 + XPN.3
prefix XPN.5
suffix XPN/4
period XPN.13 + XPN.14
1.13.3.31 Mappings for RIM (http://hl7.org/v3)
HumanName EN (actually, PN)
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>"]
1.13.3.32 Mappings for ServD (http://www.omg.org/spec/ServD/1.0/)
HumanName ProviderName
use ./NamePurpose
text
family ./FamilyName
given ./GivenNames
prefix ./TitleCode
suffix
period ./StartDate and ./EndDate
vCard Mappings
HumanName.text = vCard "FN" field
HumanName.use = use of the vCard "TYPE" parameter
HumanName.family, .given, .prefix, .suffix = parts of vCard "N" field. Note that there is no FHIR equivalent for the poorly defined "additional" name field. In FHIR, given names go in "middle" names
The vCard nickname corresponds to a name with the use "nickname"
1.13.3.33 Address
See also Base Definition , Examples and Formal Definitions .
1.13.3.34 Mappings for HL7 v2 (http://hl7.org/v2)
Address XAD
use XAD.7
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
state XAD.4
zip XAD.5
country XAD.6
period XAD.12 / XAD.13 + XAD.14
1.13.3.35 Mappings for RIM (http://hl7.org/v3)
Address AD
use unique(./use)
text ./formatted
line AD.part[parttype = AL]
city AD.part[parttype = CTY]
state AD.part[parttype = STA]
zip AD.part[parttype = ZIP]
country AD.part[parttype = CNT]
period ./usablePeriod[type="IVL<TS>"]
1.13.3.36 Mappings for vCard (http://w3.org/vcard)
Address
use
text
line street address
city locality
state region
zip postal code
country country name
period
1.13.3.37 Mappings for ServD (http://www.omg.org/spec/ServD/1.0/)
Address Address
use ./AddressPurpose
text
line ./StreetAddress (newline delimitted)
city ./Jurisdiction
state ./Region
zip ./PostalIdentificationCode
country ./Country
period ./StartDate and ./EndDate
vCard Mappings
Address.text = vCard "ADDRESS" "LABEL" parameter
Address.use = vCard "TYPE" parameter
Address.line = vCard "street" list component
Address.city = vCard "locality" list component
Address.state = vCard "region" list component
Address.zip = vCard "code" list component
Address.country = vCard "country" list component
1.13.3.38 Contact
See also Base Definition , Examples and Formal Definitions .
1.13.3.39 Mappings for HL7 v2 (http://hl7.org/v2)
Contact XTN
system XTN.3
value XTN.1 (or XTN.12)
use XTN.2 - but often indicated by field
period N/A
1.13.3.40 Mappings for RIM (http://hl7.org/v3)
Contact TEL
system ./scheme
value ./url
use unique(./use)
period ./useablePeriod[type="IVL<TS>"]
1.13.3.41 Mappings for ServD (http://www.omg.org/spec/ServD/1.0/)
Contact ContactPoint
system ./ContactPointType
value ./Value
use ./ContactPointPurpose
period ./StartDate and ./EndDate
1.13.3.42 Schedule
See also Base Definition , Examples and Formal Definitions .
1.13.3.43 Mappings for HL7 v2 (http://hl7.org/v2)
Schedule N/A
event
repeat
frequency
when
duration
units
count
end
1.13.3.44 Mappings for RIM (http://hl7.org/v3)
Schedule QSET<TS> (GTS)
event QLIST<TS> or PIVL.offset
repeat Implies PIVL or EIVL
frequency PIVL.phase
when EIVL.event
duration PIVL.phase / EIVL.offset
units PIVL.phase.unit
count PIVL.count
end N/A