HL7 Version 2 to FHIR
1.0.0 - STU 1
HL7 Version 2 to FHIR
1.0.0 - STU 1
HL7 Version 2 to FHIR, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2-to-fhir/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/v2mappings/ConceptMap/datatype-xad-to-address | Version: 1.0.0 | |||
| Standards status: Informative | Computable Name: DatatypeXADToAddress | |||
Copyright/Legal: Copyright (c) 2025, HL7 International, Inc., All Rights Reserved. |
||||
This ConceptMap represents a mapping from the HL7 V2 Datatype XAD to the FHIR Address Data Type.
This ConceptMap represents the mapping from the HL7 V2 XAD Data Type to the FHIR Address Data Type. See also the FHIR Shorthand or the CSV Source.
| HL7 v2 | Condition (IF True, args) | HL7 FHIR | Comments | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Sort Order | Identifier | Name | Data Type | Cardinality - Min | Cardinality - Max | Computable ANTLR | Computable FHIRPath | Narrative | FHIR Attribute | Proposed Extension | Data Type | Cardinality - Min | Cardinality - Max | Data Type Mapping | Vocabulary Mapping (IS, ID, CE, CEN, CWE) | Assignment | |
| 1 | XAD.1 | Street Address | SAD | 0 | 1 | Address.line | string | 0 | -1 | SAD[Address] | |||||||
| 2 | XAD.2 | Other Designation | ST | 0 | 1 | Address.line | string | 0 | -1 | Note that XAD.1 is mapped to Address.line as well using the SAD data type. That may yield up to three address lines. | |||||||
| 3 | XAD.3 | City | ST | 0 | 1 | Address.city | string | 0 | 1 | ||||||||
| 4 | XAD.4 | State or Province | ST | 0 | 1 | Address.state | string | 0 | 1 | ||||||||
| 5 | XAD.5 | Zip or Postal Code | ST | 0 | 1 | Address.postalCode | string | 0 | 1 | ||||||||
| 6 | XAD.6 | Country | ID | 0 | 1 | Address.country | string | 0 | 1 | ||||||||
| 7 | XAD.7 | Address Type | ID | 0 | 1 | IF XAD.7 IN ("M", "SH") | Address.type | code | 0 | 1 | AddressType[Type] | ||||||
| 7 | XAD.7 | Address Type | ID | 0 | 1 | IF XAD.7 IN ("BA", "BI", "C", "B", "H", "O") | Address.use | code | 0 | 1 | AddressType[Use] | ||||||
| 7 | XAD.7 | Address Type | ID | 0 | 1 | IF XAD.7 EQUALS "HV" | Address.extension.url | uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/iso21090-AD-use" | ||||||
| 7 | XAD.7 | Address Type | ID | 0 | 1 | IF XAD.7 EQUALS "HV" | Address.extension.valueCode | code | 1 | 1 | |||||||
| 7 | XAD.7 | Address Type | ID | 0 | 1 | Address.extension.uri | |||||||||||
| 7 | XAD.7 | Address Type | ID | 0 | 1 | Address.extension.valueCodeableConcept.coding.value | code | ||||||||||
| 7 | XAD.7 | Address Type | ID | 0 | 1 | Address.extension.valueCodeableConcept.coding.system | uri | "http://terminology.hl7.org/CodeSystem/v2-0190" | |||||||||
| 8 | XAD.8 | Other Geographic Designation | ST | 0 | 1 | ||||||||||||
| 9 | XAD.9 | County/Parish Code | CWE | 0 | 1 | Address.district | string | 0 | 1 | CWE[string] | |||||||
| 10 | XAD.10 | Census Tract | CWE | 0 | 1 | Address.extension.url | uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract" | |||||||
| 10 | XAD.10 | Census Tract | CWE | 0 | 1 | Address.extension.valueCode | string | 1 | 1 | CWE[string] | |||||||
| 11 | XAD.11 | Address Representation Code | ID | 0 | 1 | ||||||||||||
| 12 | XAD.12 | Address Validity Range | DR | 0 | 1 | Period | Period | 0 | 1 | DR[Period] | |||||||
| 13 | XAD.13 | Effective Date | DTM | 0 | 1 | Address.period.start | dateTime | 0 | 1 | ||||||||
| 14 | XAD.14 | Expiration Date | DTM | 0 | 1 | Address.period.end | dateTime | 0 | 1 | ||||||||
| 15 | XAD.15 | Expiration Reason | CWE | 0 | 1 | ||||||||||||
| 16 | XAD.16 | Temporary Indicator | ID | 0 | 1 | Overlaps with Address.use and Address.type | |||||||||||
| 17 | XAD.17 | Bad Address Indicator | ID | 0 | 1 | Overlaps with Address.use and Address.type | |||||||||||
| 18 | XAD.18 | Address Usage | ID | 0 | 1 | Overlaps with Address.use and Address.type | |||||||||||
| 19 | XAD.19 | Addressee | ST | 0 | 1 | Address.line | string | 0 | -1 | There is an existing ADXP extension if we prefer | |||||||
| 20 | XAD.20 | Comment | ST | 0 | 1 | ||||||||||||
| 21 | XAD.21 | Preference Order | NM | 0 | 1 | ||||||||||||
| 22 | XAD.22 | Protection Code | CWE | 0 | 1 | ||||||||||||
| 23 | XAD.23 | Address Identifier | EI | 0 | 1 | ||||||||||||
Mapping from (not specified) to (not specified)
Group 1 Mapping from unspecified code system to unspecified code system
| Source Concept Details | Relationship | Target Concept Details | Comment | |||
| Codes from | ComputableANTLR | Codes from | ||||
| XAD.1 | Street Address | is equivalent to | line[1-3] | line[1-3] | ||
| XAD.2 | Other Designation | is equivalent to | line[4] | line[4] | Note that XAD.1 is mapped to Address.line as well using the SAD data type. That may yield up to three address lines. | |
| XAD.3 | City | is equivalent to | city | city | ||
| XAD.4 | State or Province | is equivalent to | state | state | ||
| XAD.5 | Zip or Postal Code | is equivalent to | postalCode | postalCode | ||
| XAD.6 | Country | is equivalent to | country | country | ||
| XAD.7 | Address Type | IF XAD.7 IN ("M", "SH") | is equivalent to | type | type | |
| XAD.7 | Address Type | IF XAD.7 IN ("BA", "BI", "C", "B", "H", "O") | is equivalent to | use | use | |
| XAD.7 | Address Type | IF XAD.7 EQUALS "HV" | is equivalent to | extension[1].url | extension[1].url | |
| XAD.7 | Address Type | IF XAD.7 EQUALS "HV" | is equivalent to | extension[1].valueCode | extension[1].valueCode | |
| XAD.7 | Address Type | is equivalent to | extension[2].uri | extension[2].uri | ||
| XAD.7 | Address Type | is equivalent to | extension[2].valueCodeableConcept.coding.value | extension[2].valueCodeableConcept.coding.value | ||
| XAD.7 | Address Type | is equivalent to | extension[2].valueCodeableConcept.coding.system | extension[2].valueCodeableConcept.coding.system | ||
| XAD.9 | County/Parish Code | is equivalent to | district | district | ||
| XAD.10 | Census Tract | is equivalent to | extension[3].url | extension[3].url | ||
| XAD.10 | Census Tract | is equivalent to | extension[3].valueCode | extension[3].valueCode | ||
| XAD.12 | Address Validity Range | is equivalent to | period | period | ||
| XAD.13 | Effective Date | is equivalent to | period.start | period.start | ||
| XAD.14 | Expiration Date | is equivalent to | period.end | period.end | ||
| XAD.19 | Addressee | is equivalent to | line[5] | line[5] | There is an existing ADXP extension if we prefer | |
IG © 2020+ HL7 International / Orders and Observations. Package hl7.fhir.uv.v2mappings#1.0.0 based on FHIR 4.0.1. Generated 2025-08-25
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change