FHIR Extensions Pack
5.1.0-cibuild - Working Copy International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This is not an authorized publication; it is the continuous build for version 5.1.0-cibuild). 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.1.0-cibuild
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Patient Care Computable Name: AISubstanceExposureRisk
Other Identifiers: id: urn:oid:2.16.840.1.113883.4.642.5.1296

A complex extension allowing structured capture of the exposure risk of the patient for an adverse reaction (allergy or intolerance) to the specified substance/product.

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)

    • 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: A complex extension allowing structured capture of the exposure risk of the patient for an adverse reaction (allergy or intolerance) to the specified substance/product.

    • 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 C0..1ExtensionExposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted.
    ... extension:substance 1..1ExtensionSubstance (or pharmaceutical product)
    .... extension 0..0
    .... url 1..1uri"substance"
    .... value[x] 1..1CodeableConceptValue of extension
    Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

    ... extension:exposureRisk 1..1Extensionknown-reaction-risk | no-known-reaction-risk
    .... extension 0..0
    .... url 1..1uri"exposureRisk"
    .... value[x] 1..1CodeableConceptValue 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..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension C0..1ExtensionExposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted.
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 2..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:substance 1..1ExtensionSubstance (or pharmaceutical product)
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"substance"
    .... value[x] 1..1CodeableConceptValue of extension
    Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"exposureRisk"
    .... value[x] 1..1CodeableConceptValue 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..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: A complex extension allowing structured capture of the exposure risk of the patient for an adverse reaction (allergy or intolerance) to the specified substance/product.

    • 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 C0..1ExtensionExposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted.
    ... extension:substance 1..1ExtensionSubstance (or pharmaceutical product)
    .... extension 0..0
    .... url 1..1uri"substance"
    .... value[x] 1..1CodeableConceptValue of extension
    Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

    ... extension:exposureRisk 1..1Extensionknown-reaction-risk | no-known-reaction-risk
    .... extension 0..0
    .... url 1..1uri"exposureRisk"
    .... value[x] 1..1CodeableConceptValue 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..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension C0..1ExtensionExposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted.
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 2..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:substance 1..1ExtensionSubstance (or pharmaceutical product)
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"substance"
    .... value[x] 1..1CodeableConceptValue of extension
    Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"exposureRisk"
    .... value[x] 1..1CodeableConceptValue 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..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSet
    Extension.extension:substance.value[x]exampleSubstanceCode
    Extension.extension:exposureRisk.value[x]requiredAllergyIntoleranceSubstanceExposureRisk (a valid code from AllergyIntolerance substance exposure risk codesystem)

    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()
    inv-1errorExtensionIf the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted.
    : substanceExposureRisk.exists() and code.empty()

    Search Parameters for this Extension

    (none found)