R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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: substanceExposureRisk

Patient Care Work Group Maturity Level: 1InformativeUse Context: Any

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.

Comment:

This extension is available and is intended to be used as a more completely structured and flexible alternative to the 'code' element for representing positive and negative allergy and intolerance statements. If this extension element is present, the AllergyIntolerance.code element SHALL be omitted (see invariant "code or substanceExposureRisk").

Context of Use: Use on Element ID AllergyIntolerance

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. substanceExposureRisk0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
substanceExposureRisk: 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 ID 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
substanceExposureRisk: 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 ID AllergyIntolerance
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension 1..1ExtensionSubstance (or pharmaceutical product)
.... extension 0..0
.... url 1..1uri"substance"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Substance Code (example)
... extension 1..1Extensionknown-reaction-risk | no-known-reaction-risk
.... extension 0..0
.... url 1..1uri"exposureRisk"
.... valueCodeableConcept 0..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

<!-- substanceExposureRisk -->doco

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

JSON Template

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

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. substanceExposureRisk0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
substanceExposureRisk: 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 ID 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
substanceExposureRisk: 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 ID AllergyIntolerance
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension 1..1ExtensionSubstance (or pharmaceutical product)
.... extension 0..0
.... url 1..1uri"substance"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Substance Code (example)
... extension 1..1Extensionknown-reaction-risk | no-known-reaction-risk
.... extension 0..0
.... url 1..1uri"exposureRisk"
.... valueCodeableConcept 0..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

<!-- substanceExposureRisk -->doco

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

JSON Template

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

 

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)))