HL7 Version 2 to FHIR
1.0.0-ballot - ballot International flag

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

: Segment AL1 to AllergyIntolerance Map - XML Representation

Active as of 2024-10-30

Raw xml | Download


<ConceptMap xmlns="http://hl7.org/fhir">
  <id value="segment-al1-to-allergyintolerance"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: ConceptMap segment-al1-to-allergyintolerance</b></p><a name="segment-al1-to-allergyintolerance"> </a><a name="hcsegment-al1-to-allergyintolerance"> </a><a name="segment-al1-to-allergyintolerance-en-US"> </a><p>Mapping from AL1 to <a href="http://hl7.org/fhir/R4/allergyintolerance.html">AllergyIntolerance</a></p><br/><p><b>Group 1 </b>Mapping from <code>unspecified code system</code> to <code>unspecified code system</code></p><table class="grid"><tr><td><b>Source Code</b></td><td><b>Relationship</b></td><td><b>Target Code</b></td><td><b>Comment</b></td></tr><tr><td>AL1</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>clinicalStatus.coding.code</td><td>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 &quot;entered-in-error&quot; based on the data in AL1.</td></tr><tr><td>AL1</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>clinicalStatus.coding.system</td><td/></tr><tr><td>AL1-2 (Allergen Type Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>category</td><td>The FHIR table has a &quot;required&quot; 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\</td></tr><tr><td>AL1-2 (Allergen Type Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>category.extension[1].url</td><td/></tr><tr><td>AL1-2 (Allergen Type Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>category.extension[1].valueCodeableConcept</td><td/></tr><tr><td>AL1-2 (Allergen Type Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>type</td><td/></tr><tr><td>AL1-3 (Allergen Code/Mnemonic/Description)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>code</td><td/></tr><tr><td>AL1-4 (Allergy Severity Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>criticality</td><td>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.</td></tr><tr><td>AL1-4 (Allergy Severity Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>criticality.extension[1].url</td><td/></tr><tr><td>AL1-4 (Allergy Severity Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>criticality.extension[1].valueCodeableConcept</td><td/></tr><tr><td>AL1-4 (Allergy Severity Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>reaction.severity</td><td/></tr><tr><td>AL1-5 (Allergy Reaction Code)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>reaction.manifestation.text</td><td>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.\</td></tr><tr><td>AL1-6 (Identification Date)</td><td><a href="http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent" title="equivalent">is equivalent to</a></td><td>onsetDateTime</td><td>Withdrawn as of 2.7, Refer to IAM-11 Onset or IAM-13 Reported Date</td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/RelatedArtifact">
    <extension url="type">
      <valueCode value="derived-from"/>
    </extension>
    <extension url="label">
      <valueString value="Segment AL1 to AllergyIntolerance.fsh"/>
    </extension>
    <extension url="url">
      <valueUri
                value="https://docs.google.com/spreadsheets/d/10aUgY2Kw3sYlbaw-QHykWri8J3Fb3J_Xc7DvCY_nzyE/edit?usp=sharing"/>
    </extension>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/v2mappings/segment-al1-to-allergyintolerance"/>
  <version value="1.0.0-ballot"/>
  <name value="SegmentAL1ToAllergyIntolerance"/>
  <title value="Segment AL1 to AllergyIntolerance Map"/>
  <status value="active"/>
  <experimental value="true"/>
  <date value="2024-10-30"/>
  <publisher value="HL7 International / Orders and Observations"/>
  <contact>
    <name value="HL7 Orders and Observations Workgroup"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/orders"/>
    </telecom>
  </contact>
  <description
               value="This ConceptMap represents a mapping from the HL7 V2 Segment AL1 to the FHIR AllergyIntolerance Resource."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <copyright
             value="Copyright (c) 2020, HL7 International, Inc., All Rights Reserved."/>
  <sourceUri value="AL1"/>
  <targetUri value="AllergyIntolerance"/>
  <group>
    <element>
      <code value="AL1"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="code"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="0"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="clinicalStatus.coding.code"/>
        <display value="clinicalStatus.coding.code"/>
        <equivalence value="equivalent"/>
        <comment
                 value="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 &quot;entered-in-error&quot; based on the data in AL1."/>
      </target>
    </element>
    <element>
      <code value="AL1"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="uri"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="0"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="clinicalStatus.coding.system"/>
        <display value="clinicalStatus.coding.system"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="CWE"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-2"/>
      <display value="Allergen Type Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="code"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="0"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="-1"/>
          </extension>
        </extension>
        <code value="category"/>
        <display value="category"/>
        <equivalence value="equivalent"/>
        <comment
                 value="The FHIR table has a &quot;required&quot; 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\"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="CWE"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-2"/>
      <display value="Allergen Type Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="uri"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="category.extension[1].url"/>
        <display value="category.extension[1].url"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="CWE"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-2"/>
      <display value="Allergen Type Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="CodeableConcept"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="category.extension[1].valueCodeableConcept"/>
        <display value="category.extension[1].valueCodeableConcept"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="CWE"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-2"/>
      <display value="Allergen Type Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="code"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="0"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="type"/>
        <display value="type"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="CWE"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-3"/>
      <display value="Allergen Code/Mnemonic/Description"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="CodeableConcept"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="0"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="code"/>
        <display value="code"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="CWE"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-4"/>
      <display value="Allergy Severity Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="code"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="0"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="criticality"/>
        <display value="criticality"/>
        <equivalence value="equivalent"/>
        <comment
                 value="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."/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="CWE"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-4"/>
      <display value="Allergy Severity Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="uri"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="criticality.extension[1].url"/>
        <display value="criticality.extension[1].url"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="CWE"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-4"/>
      <display value="Allergy Severity Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="CodeableConcept"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="1"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="criticality.extension[1].valueCodeableConcept"/>
        <display value="criticality.extension[1].valueCodeableConcept"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="CWE"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-4"/>
      <display value="Allergy Severity Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="code"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="0"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="reaction.severity"/>
        <display value="reaction.severity"/>
        <equivalence value="equivalent"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="ST"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="-1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="-1"/>
        </extension>
      </extension>
      <code value="AL1-5"/>
      <display value="Allergy Reaction Code"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="CodeableConcept"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="0"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="reaction.manifestation.text"/>
        <display value="reaction.manifestation.text"/>
        <equivalence value="equivalent"/>
        <comment
                 value="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.\"/>
      </target>
    </element>
    <element>
      <extension
                 url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
        <extension url="type">
          <valueCode value="DT"/>
        </extension>
        <extension url="cardinalityMin">
          <valueInteger value="1"/>
        </extension>
        <extension url="cardinalityMax">
          <valueInteger value="1"/>
        </extension>
      </extension>
      <code value="AL1-6"/>
      <display value="Identification Date"/>
      <target>
        <extension
                   url="http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo">
          <extension url="type">
            <valueCode value="dateTime"/>
          </extension>
          <extension url="cardinalityMin">
            <valueInteger value="0"/>
          </extension>
          <extension url="cardinalityMax">
            <valueInteger value="1"/>
          </extension>
        </extension>
        <code value="onsetDateTime"/>
        <display value="onsetDateTime"/>
        <equivalence value="equivalent"/>
        <comment
                 value="Withdrawn as of 2.7, Refer to IAM-11 Onset or IAM-13 Reported Date"/>
      </target>
    </element>
  </group>
</ConceptMap>