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/segment-al1-to-allergyintolerance | Version: 1.0.0-ballot | |||
| Active as of 2024-03-22 | Computable Name: SegmentAL1ToAllergyIntolerance | |||
Copyright/Legal: Copyright (c) 2020, HL7 International, Inc., All Rights Reserved. |
||||
This ConceptMap represents a mapping from the HL7 V2 Segment AL1 to the FHIR AllergyIntolerance Resource.
This ConceptMap represents the mapping from the HL7 V2 AL1 Segment to the FHIR AllergyIntolerance Resource. 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 | Extension | Data Type | Cardinality - Min | Cardinality - Max | Data Type Mapping | Vocabulary Mapping (IS, ID, CE, CEN, CWE) | Assignment | |
| 0 | AL1 | AllergyIntolerance.clinicalStatus.coding.code | AllergyIntolerance.code | 0 | 1 | "active" | While .clinicalStatus is not required, constraint ait-1 (AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.) does necessitate populating this element in the map as it's not possible to infer a verificationStatus of "entered-in-error" based on the data in AL1. | ||||||||||
| 0 | AL1 | AllergyIntolerance.clinicalStatus.coding.system | AllergyIntolerance.uri | 0 | 1 | "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" | |||||||||||
| 1 | AL1-1 | Set ID - AL1 | SI | 1 | 1 | This field doesn't warrant mapping | |||||||||||
| 2 | AL1-2 | Allergen Type Code | CWE | 0 | 1 | AllergyIntolerance.category | AllergyIntolerance.code | 0 | -1 | CWE[code] | AllergenType[AllergyIntoleranceCategory] | The FHIR table has a "required" binding. Do we need to expand the values in the FHIR table? Could other be used for: Miscellaneous allergy Miscellaneous contraindication Animal Allergy HL70127 is a user defined table | |||||
| 2 | AL1-2 | Allergen Type Code | CWE | 0 | 1 | AllergyIntolerance.category.extension.url | AllergyIntolerance.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/alternate-codes" | |||||||
| 2 | AL1-2 | Allergen Type Code | CWE | 0 | 1 | AllergyIntolerance.category.extension.valueCodeableConcept | AllergyIntolerance.CodeableConcept | 1 | 1 | CWE[CodeableConcept] | AllergenType[AllergyIntoleranceOriginalCategory] | ||||||
| 2 | AL1-2 | Allergen Type Code | CWE | 0 | 1 | AllergyIntolerance.type | AllergyIntolerance.code | 0 | 1 | CWE[code] | AllergyType | ||||||
| 3 | AL1-3 | Allergen Code/Mnemonic/Description | CWE | 1 | 1 | AllergyIntolerance.code | AllergyIntolerance.CodeableConcept | 0 | 1 | CWE[CodeableConcept] | |||||||
| 4 | AL1-4 | Allergy Severity Code | CWE | 0 | 1 | If severity was used equivalent to criticality | AllergyIntolerance.criticality | AllergyIntolerance.code | 0 | 1 | CWE[code] | AllergySeverity[AllergyIntolerance.criticality] | Note that AllergyIntolerance.reaction.severity is available in FHIR but from a base standard perspective that is actually not the most appropriate and would require that AL1-6 is valued as well. However, a local implementation may have used vocabulary that better fits AllergyIntolerance.reaction.severity and should then consider that instead as a local variation. Note that the .reaction though is at a particular time, while .criticality is an overall assement that matches HL7 v2 generally better. | ||||
| 4 | AL1-4 | Allergy Severity Code | CWE | 0 | 1 | If severity was used equivalent to criticality | AllergyIntolerance.criticality.extension.url | AllergyIntolerance.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/alternate-codes" | ||||||
| 4 | AL1-4 | Allergy Severity Code | CWE | 0 | 1 | If severity was used equivalent to criticality | AllergyIntolerance.criticality.extension.valueCodeableConcept | AllergyIntolerance.CodeableConcept | 1 | 1 | CWE[CodeableConcept] | AllergyTyp[AllergyIntolerance.criticality-original] | |||||
| 4 | AL1-4 | Allergy Severity Code | CWE | 0 | 1 | If severity was not used equivalent to criticality | Need a local implementation extension. | While AllergyIntolerance.reaction.severity would provide a potential mapping target, that is not clearly and unambiguously known at the standard level as the mapping to .criticality should be the "normal" mapping per the standard. Please enter a JIRA against the guide to help determine whether an HL7 extension would be appropriate to create. | |||||||||
| 5 | AL1-5 | Allergy Reaction Code | ST | 0 | -1 | AllergyIntolerance.reaction.manifestation.text | AllergyIntolerance.CodeableConcept | 0 | 1 | ST[CodeableConcept] | AllergyIntolerance.reaction can repeat, presumably to capture both multiple manifestations of the reaction (rash and nausea) as well as reactions to independent exposures (last week and last month) - we may want to confirm this understanding. | ||||||
| 6 | AL1-6 | Identification Date | DT | 1 | 1 | AllergyIntolerance.onsetDateTime | AllergyIntolerance.dateTime | 0 | 1 | Withdrawn as of 2.7, Refer to IAM-11 Onset or IAM-13 Reported Date | |||||||
Mapping from AL1 to AllergyIntolerance
ACTIVE (not intended for production usage). Published on 2024-03-22 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 Segment AL1 to the FHIR AllergyIntolerance Resource.
Group 1 Mapping from unspecified code system to unspecified code system
| Source Concept Details | Relationship | Target Concept Details | Comment | Properties | ||||||||
| Codes from | vocabularymap | value | datatypemap | Codes from | narrative | |||||||
| AL1 | "active" | is equivalent to | clinicalStatus.coding.code | clinicalStatus.coding.code | While .clinicalStatus is not required, constraint ait-1 (AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.) does necessitate populating this element in the map as it's not possible to infer a verificationStatus of "entered-in-error" based on the data in AL1. | |||||||
| AL1 | "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" | is equivalent to | clinicalStatus.coding.system | clinicalStatus.coding.system | ||||||||
| AL1-2 | Allergen Type Code | AllergenType[AllergyIntoleranceCategory] | CWE[code] | is equivalent to | category | category | The FHIR table has a "required" binding. Do we need to expand the values in the FHIR table? Could other be used for: Miscellaneous allergy Miscellaneous contraindication Animal Allergy HL70127 is a user defined table\ | |||||
| AL1-2 | Allergen Type Code | "http://hl7.org/fhir/StructureDefinition/alternate-codes" | is equivalent to | category.extension[1].url | category.extension[1].url | |||||||
| AL1-2 | Allergen Type Code | AllergenType[AllergyIntoleranceOriginalCategory] | CWE[CodeableConcept] | is equivalent to | category.extension[1].valueCodeableConcept | category.extension[1].valueCodeableConcept | ||||||
| AL1-2 | Allergen Type Code | AllergyType | CWE[code] | is equivalent to | type | type | ||||||
| AL1-3 | Allergen Code/Mnemonic/Description | CWE[CodeableConcept] | is equivalent to | code | code | |||||||
| AL1-4 | Allergy Severity Code | AllergySeverity[AllergyIntolerance.criticality] | CWE[code] | is equivalent to | criticality | criticality | If severity was used equivalent to criticality | Note that AllergyIntolerance.reaction.severity is available in FHIR but from a base standard perspective that is actually not the most appropriate and would require that AL1-6 is valued as well. However, a local implementation may have used vocabulary that better fits AllergyIntolerance.reaction.severity and should then consider that instead as a local variation. Note that the .reaction though is at a particular time, while .criticality is an overall assement that matches HL7 v2 generally better. | ||||
| AL1-4 | Allergy Severity Code | "http://hl7.org/fhir/StructureDefinition/alternate-codes" | is equivalent to | criticality.extension[1].url | criticality.extension[1].url | If severity was used equivalent to criticality | ||||||
| AL1-4 | Allergy Severity Code | AllergyTyp[AllergyIntolerance.criticality-original] | CWE[CodeableConcept] | is equivalent to | criticality.extension[1].valueCodeableConcept | criticality.extension[1].valueCodeableConcept | If severity was used equivalent to criticality | |||||
| AL1-5 | Allergy Reaction Code | ST[CodeableConcept] | is equivalent to | reaction.manifestation.text | reaction.manifestation.text | AllergyIntolerance.reaction can repeat, presumably to capture both multiple manifestations of the reaction (rash and nausea) as well as reactions to independent exposures (last week and last month) - we may want to confirm this understanding.\ | ||||||
| AL1-6 | Identification Date | is equivalent to | onsetDateTime | onsetDateTime | Withdrawn as of 2.7, Refer to IAM-11 Onset or IAM-13 Reported Date | |||||||
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-09
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change