HL7 Version 2 to FHIR
1.0.0-ballot - ballot
HL7 Version 2 to FHIR
1.0.0-ballot - ballot
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-ballot 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/message-adt-a17-to-bundle | Version: 1.0.0-ballot | |||
| Active as of 2024-04-24 | Computable Name: MessageADT_A17ToBundle | |||
Copyright/Legal: Copyright (c) 2020, HL7 International, Inc., All Rights Reserved. |
||||
This ConceptMap represents a mapping from the HL7 V2 Message ADT_A17 to the FHIR Message Bundle.
This ConceptMap represents the mapping from the HL7 V2 ADT_A17 Message to the FHIR Message Bundle. See also the FHIR Shorthand or the CSV Source.
| HL7 v2 | Condition (IF True, args) | HL7 FHIR | Comments | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Sort Order | Identifier | Syntax | Name | Cardinality - Min | Cardinality - Max | Computable ANTLR | Computable FHIRPath | Narrative | Primary Target | Segment Map | References | </thead>|
| 1 | ADT_A17.MSH | MSH | Message Header | 1 | 1 | Bundle | MSH[Bundle] | |||||
| 1 | ADT_A17.MSH | MSH | Message Header | 1 | 1 | MessageHeader | MSH[MessageHeader] | Processing of the MSH segment results in the creation of a new MessageHeader resource. | ||||
| 1 | ADT_A17.MSH | MSH | Message Header | 1 | 1 | If there is a source in MSH-4, or known based on the configuration. | Provenance | MSH[Provenance-Source] | Provenance[1].target.reference=Bundle.id; Provenance[1].target.reference=MessageHeader[1].id | If the FHIR transformation does not yield a FHIR message, but only a set of resource (APIs, repository, etc.) than one should consider attaching this Proviance resource instance to the relevant FHIR resources generated. | ||
| 1 | ADT_A17.MSH | MSH | Message Header | 1 | 1 | Provenance | MSH[Provenance-Transformation] | Provenance[2].target.reference=Bundle.id | If the FHIR transformation does not yield a FHIR Bunlde, but only a set of resource (APIs, repository, etc.) than one should consider attaching this Provenance resource instance to the relevant FHIR resources generated. | |||
| 2 | ADT_A17.ARV | [{ ARV }] | Access Restrictions | 0 | -1 | |||||||
| 3 | ADT_A17.SFT | [{ SFT }] | Software Segment | 0 | -1 | If the software does represent not the original source system | Provenance.entity.what(Device) | SFT[Device] | Provenance[1].entity.what.reference=Device.id Provenance[1].entity.role="derivation" | |||
| 3 | ADT_A17.SFT | [{ SFT }] | Software Segment | 0 | -1 | If the software represents the original source system | Provenance.entity.what(Device) | SFT[Device] | Provenance[1].entity.what.reference=Device.id Provenance[1].entity.role="source" | |||
| 4 | ADT_A17.UAC | [ UAC ] | User Authentication Credential | 0 | 1 | |||||||
| 5 | ADT_A17.EVN | EVN | Event Type | 1 | 1 | Provenance | EVN[Provenance] | Provenance[3].target.reference=MessageHeader[1].id | ||||
| 5 | ADT_A17.EVN | EVN | Event Type | 1 | 1 | IF EVN-5 NOT VALUED AND (MSH-22 IS VALUED OR MSH-4 IS VALUED) | Provenance | MSH[Provenance-Operator] | Provenance[3].target.reference=MessageHeader[1].id | If EVN-5 is not valued, then the MSH may have either the sending responsible organization (MSH-22) or the sending facility (MSH-4) to reasonable approximate the agent relevant for this Provenance instance. | ||
| 6 | ADT_A17.PID | PID | Patient Identification | 1 | 1 | Patient | PID[Patient] | Processing of the PID segment results in the creation of a new Patient resource | ||||
| 6 | ADT_A17.PID | PID | Patient Identification | 1 | 1 | Account | PID[Account] | Account[1].subject.reference=Patient[1].id | ||||
| 6 | ADT_A17.PID | PID | Patient Identification | 1 | 1 | IF PID-33 AND PID-34 VALUED | One may drop PID-33 from the condition if PID-34 Last Update Facility is still sufficient without a date. | Provenance | PID[Provenance-Patient] | Provenance[4].target.reference=Patient[1].id | ||
| 7 | ADT_A17.PD1 | [ PD1 ] | Additional Demographics | 0 | 1 | Patient | PD1[Patient] | Incorporate PD1 content into the Patient created from the PID segment. | ||||
| 8 | ADT_A17.PV1 | PV1 | Patient Visit | 1 | 1 | Encounter | PV1[Encounter] | Encounter[1].subject.reference=Patient[1].id | Processing of the PV1 segment results in the creation of a new Encounter resource | |||
| 8 | ADT_A17.PV1 | PV1 | Patient Visit | 1 | 1 | Patient | PV1[Patient] | |||||
| 9 | ADT_A17.PV2 | [ PV2 ] | Patient Visit - Additional Info. | 0 | 1 | Encounter | PV2[Encounter] | Incorporate PV2 content into the Encounter created from the PV1 segment. | ||||
| 10 | ADT_A17.DB1 | [{ DB1 }] | Disability Information | 0 | -1 | |||||||
| 12 | ADT_A17.OBSERVATION | [{ | --- OBSERVATION begin | 0 | -1 | |||||||
| 12.1 | ADT_A17.OBSERVATION.OBX | OBX | Observation/Result | 0 | -1 | Based on profiles, such as Vital Signs, certain observations are represented on the Observation, while others on its components. No computable guidance available yet. | Observation | OBX[Observation] | Observation[1].subject.reference=Patient[1].id | One cannot determine whether this observation made during the PV1/PV2 communicated above, or from a prior visit/stay. It is therefore up to the implementer whether to populate Observation.encounter.reference with the Encounter[1].id or not. Only when the ADT message involves an event before the encounter occurs, e.g., the intiial registration, it is clear that the observation is NOT associated with Encounter[1]. | ||
| 12.1 | ADT_A17.OBSERVATION.OBX | OBX | Observation/Result | 0 | -1 | Based on profiles, such as Vital Signs, certain observations are represented on the Observation, while others on its components. No computable guidance available yet. | Observation | OBX[Observation-Component] | Observation[1].subject.reference=Patient[1].id | One cannot determine whether this observation made during the PV1/PV2 communicated above, or from a prior visit/stay. It is therefore up to the implementer whether to populate Observation.encounter.reference with the Encounter[1].id or not. Only when the ADT message involves an event before the encounter occurs, e.g., the intiial registration, it is clear that the observation is NOT associated with Encounter[1]. | ||
| 12.2 | ADT_A17.OBSERVATION.PRT | [{ PRT }] | Participation | 0 | -1 | |||||||
| 12.3 | /ADT_A17.OBSERVATION | }] | --- OBSERVATION end | |||||||||
| 13 | ADT_A17.PID | PID | Patient Identification | 1 | 1 | Patient | PID[Patient] | Processing of the PID segment results in the creation of a new Patient resource | ||||
| 13 | ADT_A17.PID | PID | Patient Identification | 1 | 1 | Account | PID[Account] | Account[2].subject.reference=Patient[2].id | ||||
| 13 | ADT_A17.PID | PID | Patient Identification | 1 | 1 | IF PID-33 AND PID-34 VALUED | One may drop PID-33 from the condition if PID-34 Last Update Facility is still sufficient without a date. | Provenance | PID[Provenance-Patient] | Provenance[5].target.reference=Patient[2].id | ||
| 14 | ADT_A17.PD1 | [ PD1 ] | Additional Demographics | 0 | 1 | Patient | PD1[Patient] | Incorporate PD1 content into the Patient created from the PID segment. | ||||
| 15 | ADT_A17.PV1 | PV1 | Patient Visit | 1 | 1 | Encounter | PV1[Encounter] | Encounter[2].subject.reference=Patient[2].id | Processing of the PV1 segment results in the creation of a new Encounter resource | |||
| 15 | ADT_A17.PV1 | PV1 | Patient Visit | 1 | 1 | Patient | PV1[Patient] | |||||
| 16 | ADT_A17.PV2 | [ PV2 ] | Patient Visit - Additional Info. | 0 | 1 | Encounter | PV2[Encounter] | Incorporate PV2 content into the Encounter created from the PV1 segment. | ||||
| 17 | ADT_A17.DB1 | [{ DB1 }] | Disability Information | 0 | -1 | |||||||
| 18 | ADT_A17.OBSERVATION | [{ | --- OBSERVATION begin | 0 | -1 | |||||||
| 18.1 | ADT_A17.OBSERVATION.OBX | OBX | Observation/Result | 0 | -1 | Based on profiles, such as Vital Signs, certain observations are represented on the Observation, while others on its components. No computable guidance available yet. | Observation | OBX[Observation] | Observation[2].subject.reference=Patient[2].id | One cannot determine whether this observation made during the PV1/PV2 communicated above, or from a prior visit/stay. It is therefore up to the implementer whether to populate Observation.encounter.reference with the Encounter[1].id or not. Only when the ADT message involves an event before the encounter occurs, e.g., the intiial registration, it is clear that the observation is NOT associated with Encounter[1]. | ||
| 18.1 | ADT_A17.OBSERVATION.OBX | OBX | Observation/Result | 0 | -1 | Based on profiles, such as Vital Signs, certain observations are represented on the Observation, while others on its components. No computable guidance available yet. | Observation | OBX[Observation-Component] | Observation[2].subject.reference=Patient[2].id | One cannot determine whether this observation made during the PV1/PV2 communicated above, or from a prior visit/stay. It is therefore up to the implementer whether to populate Observation.encounter.reference with the Encounter[1].id or not. Only when the ADT message involves an event before the encounter occurs, e.g., the intiial registration, it is clear that the observation is NOT associated with Encounter[1]. | ||
| 18.2 | ADT_A17.OBSERVATION.PRT | [{ PRT }] | Participation | 0 | -1 | |||||||
| 18.3 | /ADT_A17.OBSERVATION | }] | --- OBSERVATION end | |||||||||
Mapping from ADT_A17 to Bundle
ACTIVE (not intended for production usage). Published on 2024-04-24 by HL7 International / Orders and Observations (HL7 Orders and Observations Workgroup: http://www.hl7.org/Special/com..., Keith W. Boone: kboone@ainq.com, Rob Hausam: rrhausam@gmail.com). Copyright (c) 2020, HL7 International, Inc., All Rights Reserved.
This ConceptMap represents a mapping from the HL7 V2 Message ADT_A17 to the FHIR Message Bundle.
Group 1 Mapping from unspecified code system to unspecified code system
| Source Concept Details | Relationship | Target Concept Details | Comment | Properties | |||||||||
| Codes from | segmentmap | references | Codes from | narrative | antlr | ||||||||
| ADT_A17.MSH | Message Header | MSH[Bundle] | is equivalent to | Bundle | Bundle | ||||||||
| ADT_A17.MSH | Message Header | MSH[MessageHeader] | is equivalent to | MessageHeader[1] | MessageHeader[1] | Processing of the MSH segment results in the creation of a new MessageHeader resource. | |||||||
| ADT_A17.MSH | Message Header | MSH[Provenance-Source] | Provenance[1].target.reference=Bundle.id; Provenance[1].target.reference=MessageHeader[1].id | is equivalent to | Provenance[1] | Provenance[1] | If there is a source in MSH-4, or known based on the configuration. | If the FHIR transformation does not yield a FHIR message, but only a set of resource (APIs, repository, etc.) than one should consider attaching this Proviance resource instance to the relevant FHIR resources generated. | |||||
| ADT_A17.MSH | Message Header | MSH[Provenance-Transformation] | Provenance[2].target.reference=Bundle.id | is equivalent to | Provenance[2] | Provenance[2] | If the FHIR transformation does not yield a FHIR Bunlde, but only a set of resource (APIs, repository, etc.) than one should consider attaching this Provenance resource instance to the relevant FHIR resources generated. | ||||||
| ADT_A17.SFT | Software Segment | SFT[Device] | Provenance[1].entity.what.reference=Device.id Provenance[1].entity.role="derivation"\ | is equivalent to | Provenance[1].entity.what(Device) | Provenance[1].entity.what(Device) | If the software does represent not the original source system | ||||||
| ADT_A17.SFT | Software Segment | SFT[Device] | Provenance[1].entity.what.reference=Device.id Provenance[1].entity.role="source"\ | is equivalent to | Provenance[1].entity.what(Device) | Provenance[1].entity.what(Device) | If the software represents the original source system | ||||||
| ADT_A17.EVN | Event Type | EVN[Provenance] | Provenance[3].target.reference=MessageHeader[1].id | is equivalent to | Provenance[3] | Provenance[3] | |||||||
| ADT_A17.EVN | Event Type | MSH[Provenance-Operator] | Provenance[3].target.reference=MessageHeader[1].id | is equivalent to | Provenance[3] | Provenance[3] | IF EVN-5 NOT VALUED AND (MSH-22 IS VALUED OR MSH-4 IS VALUED) | If EVN-5 is not valued, then the MSH may have either the sending responsible organization (MSH-22) or the sending facility (MSH-4) to reasonable approximate the agent relevant for this Provenance instance. | |||||
| ADT_A17.PID | Patient Identification | PID[Patient] | is equivalent to | Patient[1] | Patient[1] | Processing of the PID segment results in the creation of a new Patient resource | |||||||
| ADT_A17.PID | Patient Identification | PID[Account] | Account[1].subject.reference=Patient[1].id | is equivalent to | Account[1] | Account[1] | |||||||
| ADT_A17.PID | Patient Identification | PID[Provenance-Patient] | Provenance[4].target.reference=Patient[1].id | is equivalent to | Provenance[4] | Provenance[4] | One may drop PID-33 from the condition if PID-34 Last Update Facility is still sufficient without a date. | IF PID-33 AND PID-34 VALUED | |||||
| ADT_A17.PD1 | Additional Demographics | PD1[Patient] | is equivalent to | Patient[1] | Patient[1] | Incorporate PD1 content into the Patient created from the PID segment. | |||||||
| ADT_A17.PV1 | Patient Visit | PV1[Encounter] | Encounter[1].subject.reference=Patient[1].id | is equivalent to | Encounter[1] | Encounter[1] | Processing of the PV1 segment results in the creation of a new Encounter resource | ||||||
| ADT_A17.PV1 | Patient Visit | PV1[Patient] | is equivalent to | Patient[1] | Patient[1] | ||||||||
| ADT_A17.PV2 | Patient Visit - Additional Info. | PV2[Encounter] | is equivalent to | Encounter[1] | Encounter[1] | Incorporate PV2 content into the Encounter created from the PV1 segment. | |||||||
| ADT_A17.OBSERVATION.OBX | Observation/Result | OBX[Observation] | Observation[1].subject.reference=Patient[1].id | is equivalent to | Observation[1] | Observation[1] | Based on profiles, such as Vital Signs, certain observations are represented on the Observation, while others on its components. No computable guidance available yet. | One cannot determine whether this observation made during the PV1/PV2 communicated above, or from a prior visit/stay. It is therefore up to the implementer whether to populate Observation.encounter.reference with the Encounter[1].id or not. Only when the ADT message involves an event before the encounter occurs, e.g., the intiial registration, it is clear that the observation is NOT associated with Encounter[1]. | |||||
| ADT_A17.OBSERVATION.OBX | Observation/Result | OBX[Observation-Component] | Observation[1].subject.reference=Patient[1].id | is equivalent to | Observation[1] | Observation[1] | Based on profiles, such as Vital Signs, certain observations are represented on the Observation, while others on its components. No computable guidance available yet. | One cannot determine whether this observation made during the PV1/PV2 communicated above, or from a prior visit/stay. It is therefore up to the implementer whether to populate Observation.encounter.reference with the Encounter[1].id or not. Only when the ADT message involves an event before the encounter occurs, e.g., the intiial registration, it is clear that the observation is NOT associated with Encounter[1]. | |||||
| ADT_A17.PID | Patient Identification | PID[Patient] | is equivalent to | Patient[2] | Patient[2] | Processing of the PID segment results in the creation of a new Patient resource | |||||||
| ADT_A17.PID | Patient Identification | PID[Account] | Account[2].subject.reference=Patient[2].id | is equivalent to | Account[2] | Account[2] | |||||||
| ADT_A17.PID | Patient Identification | PID[Provenance-Patient] | Provenance[5].target.reference=Patient[2].id | is equivalent to | Provenance[5] | Provenance[5] | One may drop PID-33 from the condition if PID-34 Last Update Facility is still sufficient without a date. | IF PID-33 AND PID-34 VALUED | |||||
| ADT_A17.PD1 | Additional Demographics | PD1[Patient] | is equivalent to | Patient[2] | Patient[2] | Incorporate PD1 content into the Patient created from the PID segment. | |||||||
| ADT_A17.PV1 | Patient Visit | PV1[Encounter] | Encounter[2].subject.reference=Patient[2].id | is equivalent to | Encounter[2] | Encounter[2] | Processing of the PV1 segment results in the creation of a new Encounter resource | ||||||
| ADT_A17.PV1 | Patient Visit | PV1[Patient] | is equivalent to | Patient[2] | Patient[2] | ||||||||
| ADT_A17.PV2 | Patient Visit - Additional Info. | PV2[Encounter] | is equivalent to | Encounter[2] | Encounter[2] | Incorporate PV2 content into the Encounter created from the PV1 segment. | |||||||
| ADT_A17.OBSERVATION.OBX | Observation/Result | OBX[Observation] | Observation[2].subject.reference=Patient[2].id | is equivalent to | Observation[2] | Observation[2] | Based on profiles, such as Vital Signs, certain observations are represented on the Observation, while others on its components. No computable guidance available yet. | One cannot determine whether this observation made during the PV1/PV2 communicated above, or from a prior visit/stay. It is therefore up to the implementer whether to populate Observation.encounter.reference with the Encounter[1].id or not. Only when the ADT message involves an event before the encounter occurs, e.g., the intiial registration, it is clear that the observation is NOT associated with Encounter[1]. | |||||
| ADT_A17.OBSERVATION.OBX | Observation/Result | OBX[Observation-Component] | Observation[2].subject.reference=Patient[2].id | is equivalent to | Observation[2] | Observation[2] | Based on profiles, such as Vital Signs, certain observations are represented on the Observation, while others on its components. No computable guidance available yet. | One cannot determine whether this observation made during the PV1/PV2 communicated above, or from a prior visit/stay. It is therefore up to the implementer whether to populate Observation.encounter.reference with the Encounter[1].id or not. Only when the ADT message involves an event before the encounter occurs, e.g., the intiial registration, it is clear that the observation is NOT associated with Encounter[1]. | |||||
IG © 2020+ HL7 International / Orders and Observations. Package hl7.fhir.uv.v2mappings#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-04-24
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change