STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

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: Use on element: AllergyIntolerance

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product: 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.
Use on element: AllergyIntolerance
... substance1..1CodeableConceptCode 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.
... exposureRisk1..1CodeableConceptThe presence or absence of a known exposure risk of the patient for an adverse reaction (allergy or intolerance) to the specified substance/product.

doco Documentation for this format

Fulle Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product: 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.
Use on element: AllergyIntolerance
... extension 1..1ExtensionSubstance (or pharmaceutical product)
.... extension 0..0
.... url 1..1uri"substance"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Substance Code (example)
... extension 1..1Extensionknown-reaction-risk | no-known-reaction-risk
.... extension 0..0
.... url 1..1uri"exposureRisk"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: AllergyIntoleranceSubstanceExposureRisk (required)
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="substance"> 1..1 Extension  <!-- 1..1 Substance (or pharmaceutical product) -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="exposureRisk"> 1..1 Extension  <!-- 1..1 known-reaction-risk | no-known-reaction-risk -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Substance (or pharmaceutical product) // R! 
        // from Element: extension
        "url" : "substance", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      },
      { // known-reaction-risk | no-known-reaction-risk // R! 
        // from Element: extension
        "url" : "exposureRisk", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product: 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.
Use on element: AllergyIntolerance
... substance1..1CodeableConceptCode 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.
... exposureRisk1..1CodeableConceptThe presence or absence of a known exposure risk of the patient for an adverse reaction (allergy or intolerance) to the specified substance/product.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product: 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.
Use on element: AllergyIntolerance
... extension 1..1ExtensionSubstance (or pharmaceutical product)
.... extension 0..0
.... url 1..1uri"substance"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Substance Code (example)
... extension 1..1Extensionknown-reaction-risk | no-known-reaction-risk
.... extension 0..0
.... url 1..1uri"exposureRisk"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: AllergyIntoleranceSubstanceExposureRisk (required)
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="substance"> 1..1 Extension  <!-- 1..1 Substance (or pharmaceutical product) -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="exposureRisk"> 1..1 Extension  <!-- 1..1 known-reaction-risk | no-known-reaction-risk -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Substance (or pharmaceutical product) // R! 
        // from Element: extension
        "url" : "substance", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      },
      { // known-reaction-risk | no-known-reaction-risk // R! 
        // from Element: extension
        "url" : "exposureRisk", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
  • inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted. (xpath: exists(f:substanceExposureRisk) and not(exists(f:code)))