FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R4 R3 R2

2.26.3 2.24.3 Data Type Mappings

FHIR Infrastructure Work Group Maturity Level : N/A Ballot Standards Status : Informative

This page provides mappings for the data types. There are mappings to HL7 v2 , HL7 v3 , and (where appropriate) vCard. vCard (see Mappings to Other Standards for further information & status).

Table of Contents

Primitive Types
Element instant time date dateTime decimal boolean integer string uri base64Binary code id oid unsignedInt positiveInt markdown url canonical uuid 		Complex Types
Element Identifier HumanName Address ContactPoint Timing Quantity SimpleQuantity Attachment Range Period Ratio CodeableConcept Coding SampledData Age Distance Duration Count Money MoneyQuantity Annotation Signature BackboneElement

2.26.3.1 2.24.3.1 Primitive Types

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

Data Type V2 RIM
base64Binary ~ED BIN
boolean n/a BL
date DT TS
dateTime DTM TS
decimal ~NM REAL
instant DTM TS
integer ~NM/~SI INT
string ST ST
time TM n/a
uri n/a URL

2.26.3.2 2.24.3.2 Attachment

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

2.26.3.3 2.24.3.3 Mappings for HL7 v2 Mapping (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
    creation

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

.integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
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
    creation N/A (needs data type R3 proposal)

2.26.3.5 2.24.3.5 Identifier

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

Identifier CX / EI (occasionally, more often EI maps to a resource id or a URL)
    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)

2.26.3.7 2.24.3.7 Mappings for RIM Mapping (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. Also maps to Role[classCode=IDENT]
    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

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

Identifier Identifier
    use
    type
    system ./IdentifierType
    value ./Value
    period ./StartDate and ./EndDate
    assigner ./IdentifierIssuingAuthority

2.24.3.8.1 V3 Mapping Issues for Identifier

When mapping an HL7 v3 II data type to a FHIR Identifier, there are two possibilities:

  • If the II has only a root and no extension, the FHIR Identifier will have a system of 'urn:ietf:rfc:3986' and the II.root will appear in Identifier.value
  • If the II has both a root and an extension, the II.root will be mapped to a URI - either a human-friendly URL or URN or (less preferred) an OID expressed as a urn, and the II.extension will be sent in Identifier.value

To search on a CDA II.root - which may appear in either Identifier.system or Identifier.value , use the syntax identifier=|[root],[root] .

See v3 Mapping examples

2.26.3.9 2.24.3.9 Coding

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

2.26.3.10 2.24.3.10 Mappings for Ontological RIM Mapping (http://hl7.org/orim)

Coding fhir:Coding rdfs:subClassOf dt:CDCoding
    system fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
    version fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
    code fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
    display fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
    userSelected fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; "true"; fhir:target dt:CDCoding.codingRationale\#O ]

2.26.3.11 2.24.3.11 Mappings for HL7 v2 Mapping (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
    userSelected Sometimes implied by being first

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

Coding CV
    system ./codeSystem
    version ./codeSystemVersion
    code ./code
    display CV.displayName
    userSelected CD.codingRationale

2.26.3.13 2.24.3.13 CodeableConcept

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

2.26.3.14 2.24.3.14 Mappings for Ontological RIM Mapping (http://hl7.org/orim)

CodeableConcept fhir:CodeableConcept rdfs:subClassOf dt:CD
    coding fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
    text fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

2.26.3.15 2.24.3.15 Mappings for HL7 v2 Mapping (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

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

./originalText[mediaType/code="text/plain"]/data
CodeableConcept CD
    coding union(., ./translation)
    text ./originalText[mediaType/code="text/plain"]/data

2.26.3.17 2.24.3.17 Quantity

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

Quantity SN (see also Range) or CQ
    value SN.2 / CQ - N/A
    comparator SN.1 / CQ.1
    unit (see OBX.6 etc.) / CQ.2
    system (see OBX.6 etc.) / CQ.2
    code (see OBX.6 etc.) / CQ.2

2.26.3.19 2.24.3.19 Mappings for RIM Mapping (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
    unit PQ.unit
    system CO.codeSystem, PQ.translation.codeSystem
    code PQ.code, MO.currency, PQ.translation.code

2.24.3.20 Money

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

2.24.3.21 HL7 v2 Mapping (http://hl7.org/v2)

Money
    value MO.Value
    currency MO.Currency

2.24.3.22 RIM Mapping (http://hl7.org/v3)

Money MO

2.26.3.20 2.24.3.23 Range

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

Range NR and also possibly SN (but see also quantity)
    low NR.1
    high NR.2

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

Range IVL<QTY[not(type="TS")]> [lowClosed="true" IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]> highClosed="true"]or URG<QTY[not(type="TS")]>
    low ./low
    high ./high

2.26.3.23 2.24.3.26 Ratio

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

Ratio N/A

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

Ratio RTO
    numerator .numerator
    denominator .denominator

2.26.3.26 2.24.3.29 Period

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

Period DR
    start DR.1
    end DR.2

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

Period IVL<TS>[lowClosed="true" IVL<TS>[lowClosed="true" and highClosed="true"] highClosed="true"] or URG<TS>[lowClosed="true" URG<TS>[lowClosed="true" and highClosed="true"] highClosed="true"]
    start ./low
    end ./high

2.26.3.29 2.24.3.32 SampledData

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

SampledData N/A (but see section 7.14 in v2.7)
    origin
    period
    factor
    lowerLimit
    upperLimit
    dimensions
    data

2.26.3.31 2.24.3.34 Mappings for RIM Mapping (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

2.26.3.32 2.24.3.35 HumanName

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

2.26.3.33 2.24.3.36 Mappings for HL7 v2 Mapping (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/FN.1
    given XPN.2 + XPN.3
    prefix XPN.5
    suffix XPN/4
    period XPN.13 + XPN.14

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

./usablePeriod[type="IVL<TS>"]
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>"]

2.26.3.35 2.24.3.38 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" "FN" field
  • HumanName.use = use of the vCard "TYPE" "TYPE" parameter
  • HumanName.family, .given, .prefix, .suffix = parts of vCard "N" "N" field. Note that there is no FHIR equivalent for the poorly defined "additional" "additional" name field. In FHIR, given names go in "middle" "middle" names
  • The vCard nickname corresponds to a name with the use "nickname" "nickname"

2.26.3.36 2.24.3.39 Address

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

Address XAD
    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

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

./usablePeriod[type="IVL<TS>"]
Address AD
    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>"]

2.26.3.39 2.24.3.42 Mappings for vCard Mapping (http://w3.org/vcard)

Address
    use
    type address type parameter
    text address label parameter
    line street
    city locality
    district
    state region
    postalCode code
    country country
    period

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

Address Address
    use ./AddressPurpose
    type
    text
    line ./StreetAddress (newline delimitted)
    city ./Jurisdiction
    district
    state ./Region
    postalCode ./PostalIdentificationCode
    country ./Country
    period ./StartDate and ./EndDate

2.26.3.41 2.24.3.44 ContactPoint

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

ContactPoint XTN
    system XTN.3
    value XTN.1 (or XTN.12)
    use XTN.2 - but often indicated by field
    rank n/a
    period N/A

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

./usablePeriod[type="IVL<TS>"]
ContactPoint TEL
    system ./scheme
    value ./url
    use unique(./use)
    rank n/a
    period ./usablePeriod[type="IVL<TS>"]

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

ContactPoint ContactPoint
    system ./ContactPointType
    value ./Value
    use ./ContactPointPurpose
    rank
    period ./StartDate and ./EndDate

2.26.3.45 2.24.3.48 Timing

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

Timing N/A

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

Timing QSET<TS> (GTS)
    event QLIST<TS>
    repeat Implies PIVL or EIVL
        bounds[x] IVL(TS) used in a QSI
        count PIVL.count
        countMax PIVL.count
        duration PIVL.phase
        durationMax PIVL.phase
        durationUnit PIVL.phase.unit
        frequency PIVL.phase
        frequencyMax PIVL.phase
        period PIVL.phase
        periodMax PIVL.phase
        periodUnit PIVL.phase.unit
        dayOfWeek n/a
        timeOfDay n/a
        when EIVL.event
        offset EIVL.offset
    code QSC.code

2.26.3.48 2.24.3.51 Signature

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

Signature N/A

2.26.3.50 2.24.3.53 Annotation

See also Base Definition , Examples , Profiles & Extensions , Detailed Descriptions and R2 Conversions .

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

Annotation N/A

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

Annotation Act
    author[x] Act.participant[typeCode=AUT].role
    time Act.effectiveTime
    text Act.text