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 - JSON Representation

Active as of 2024-10-30

Raw json | Download

{
  "resourceType" : "ConceptMap",
  "id" : "segment-al1-to-allergyintolerance",
  "text" : {
    "status" : "generated",
    "div" : "<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?\n\nCould other be used for:\nMiscellaneous allergy\nMiscellaneous contraindication\nAnimal Allergy\n\nHL70127 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>"
  },
  "extension" : [
    {
      "extension" : [
        {
          "url" : "type",
          "valueCode" : "derived-from"
        },
        {
          "url" : "label",
          "valueString" : "Segment AL1 to AllergyIntolerance.fsh"
        },
        {
          "url" : "url",
          "valueUri" : "https://docs.google.com/spreadsheets/d/10aUgY2Kw3sYlbaw-QHykWri8J3Fb3J_Xc7DvCY_nzyE/edit?usp=sharing"
        }
      ],
      "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/RelatedArtifact"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/v2mappings/segment-al1-to-allergyintolerance",
  "version" : "1.0.0-ballot",
  "name" : "SegmentAL1ToAllergyIntolerance",
  "title" : "Segment AL1 to AllergyIntolerance Map",
  "status" : "active",
  "experimental" : true,
  "date" : "2024-10-30",
  "publisher" : "HL7 International / Orders and Observations",
  "contact" : [
    {
      "name" : "HL7 Orders and Observations Workgroup",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/orders"
        }
      ]
    }
  ],
  "description" : "This ConceptMap represents a mapping from the HL7 V2 Segment AL1 to the FHIR AllergyIntolerance Resource.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "copyright" : "Copyright (c) 2020, HL7 International, Inc., All Rights Reserved.",
  "sourceUri" : "AL1",
  "targetUri" : "AllergyIntolerance",
  "group" : [
    {
      "element" : [
        {
          "code" : "AL1",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "code"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "clinicalStatus.coding.code",
              "display" : "clinicalStatus.coding.code",
              "equivalence" : "equivalent",
              "comment" : "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."
            }
          ]
        },
        {
          "code" : "AL1",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "uri"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "clinicalStatus.coding.system",
              "display" : "clinicalStatus.coding.system",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-2",
          "display" : "Allergen Type Code",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "code"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : -1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "category",
              "display" : "category",
              "equivalence" : "equivalent",
              "comment" : "The FHIR table has a \"required\" binding. Do we need to expand the values in the FHIR table?\n\nCould other be used for:\nMiscellaneous allergy\nMiscellaneous contraindication\nAnimal Allergy\n\nHL70127 is a user defined table\\"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-2",
          "display" : "Allergen Type Code",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "uri"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 1
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "category.extension[1].url",
              "display" : "category.extension[1].url",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-2",
          "display" : "Allergen Type Code",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "CodeableConcept"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 1
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "category.extension[1].valueCodeableConcept",
              "display" : "category.extension[1].valueCodeableConcept",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-2",
          "display" : "Allergen Type Code",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "code"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "type",
              "display" : "type",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-3",
          "display" : "Allergen Code/Mnemonic/Description",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "CodeableConcept"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "code",
              "display" : "code",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-4",
          "display" : "Allergy Severity Code",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "code"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "criticality",
              "display" : "criticality",
              "equivalence" : "equivalent",
              "comment" : "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."
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-4",
          "display" : "Allergy Severity Code",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "uri"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 1
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "criticality.extension[1].url",
              "display" : "criticality.extension[1].url",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-4",
          "display" : "Allergy Severity Code",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "CodeableConcept"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 1
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "criticality.extension[1].valueCodeableConcept",
              "display" : "criticality.extension[1].valueCodeableConcept",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-4",
          "display" : "Allergy Severity Code",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "code"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "reaction.severity",
              "display" : "reaction.severity",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "ST"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : -1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : -1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-5",
          "display" : "Allergy Reaction Code",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "CodeableConcept"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "reaction.manifestation.text",
              "display" : "reaction.manifestation.text",
              "equivalence" : "equivalent",
              "comment" : "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.\\"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "DT"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "AL1-6",
          "display" : "Identification Date",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "dateTime"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "code" : "onsetDateTime",
              "display" : "onsetDateTime",
              "equivalence" : "equivalent",
              "comment" : "Withdrawn as of 2.7, Refer to IAM-11 Onset or IAM-13 Reported Date"
            }
          ]
        }
      ]
    }
  ]
}