FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: AllergyIntolerance Substance Exposure Risk

Official URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Patient Care Computable Name: AISubstanceExposureRisk
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1296

The ‘substanceExposureRisk’ extension is a structured and more flexible alternative to AllergyIntolerance.code for making positive or negative allergy or intolerance statements. This extension provides the capability to make “no known allergy” (or “no risk of adverse reaction”) statements regarding any coded substance/product (including cases when a pre-coordinated “no allergy to x” concept for that substance/product does not exist). If the ‘substanceExposureRisk’ extension is present, the AllergyIntolerance.code element SHALL be omitted.

Context of Use

This extension may be used on the following element(s):

  • Element ID AllergyIntolerance

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • The resource metadata has changed (publisher, description)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: The 'substanceExposureRisk' extension is a structured and more flexible alternative to AllergyIntolerance.code for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.

    • substance: CodeableConcept: Code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk or is known not to have an associated risk of an adverse reaction upon exposure.
    • exposureRisk: CodeableConcept: The presence or absence of a known exposure risk of the patient for an adverse reaction (allergy or intolerance) to the specified substance/product.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    ... Slices for extension Content/Rules for all slices
    .... extension:substance 1..1 Extension Substance (or pharmaceutical product)
    ..... extension 0..0
    ..... url 1..1 uri "substance"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

    .... extension:exposureRisk 1..1 Extension known-reaction-risk | no-known-reaction-risk
    ..... extension 0..0
    ..... url 1..1 uri "exposureRisk"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: AllergyIntoleranceSubstanceExposureRisk (required): The risk of an adverse reaction (allergy or intolerance) for this patient upon exposure to the substance (including pharmaceutical products).

    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:substance 1..1 Extension Substance (or pharmaceutical product)
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "substance"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

    .... extension:exposureRisk 1..1 Extension known-reaction-risk | no-known-reaction-risk
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "exposureRisk"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: AllergyIntoleranceSubstanceExposureRisk (required): The risk of an adverse reaction (allergy or intolerance) for this patient upon exposure to the substance (including pharmaceutical products).

    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: The 'substanceExposureRisk' extension is a structured and more flexible alternative to AllergyIntolerance.code for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.

    • substance: CodeableConcept: Code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk or is known not to have an associated risk of an adverse reaction upon exposure.
    • exposureRisk: CodeableConcept: The presence or absence of a known exposure risk of the patient for an adverse reaction (allergy or intolerance) to the specified substance/product.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    ... Slices for extension Content/Rules for all slices
    .... extension:substance 1..1 Extension Substance (or pharmaceutical product)
    ..... extension 0..0
    ..... url 1..1 uri "substance"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

    .... extension:exposureRisk 1..1 Extension known-reaction-risk | no-known-reaction-risk
    ..... extension 0..0
    ..... url 1..1 uri "exposureRisk"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: AllergyIntoleranceSubstanceExposureRisk (required): The risk of an adverse reaction (allergy or intolerance) for this patient upon exposure to the substance (including pharmaceutical products).

    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:substance 1..1 Extension Substance (or pharmaceutical product)
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "substance"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

    .... extension:exposureRisk 1..1 Extension known-reaction-risk | no-known-reaction-risk
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "exposureRisk"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: AllergyIntoleranceSubstanceExposureRisk (required): The risk of an adverse reaction (allergy or intolerance) for this patient upon exposure to the substance (including pharmaceutical products).

    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:substance.value[x]exampleSubstanceCode
    http://hl7.org/fhir/ValueSet/substance-code
    from the FHIR Standard
    Extension.extension:exposureRisk.value[x]requiredAllergyIntoleranceSubstanceExposureRisk (a valid code from AllergyIntolerance substance exposure risk codesystem)
    http://hl7.org/fhir/ValueSet/allerg-intol-substance-exp-risk
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)