FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.3.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 : 1 Informative Use 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.

Context of Use: Use on element: Element ID AllergyIntolerance

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = 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: Element ID AllergyIntolerance
. . . substance 1..1 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 1..1 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.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = 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: Element ID AllergyIntolerance
. . . extension 1..1 Extension Substance (or pharmaceutical product)
. . . . url 1..1 uri "substance" "substance"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Substance Code ( example )
. . . extension 1..1 Extension known-reaction-risk | no-known-reaction-risk
. . . . url 1..1 uri "exposureRisk" "exposureRisk"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: AllergyIntoleranceSubstanceExposureRisk ( required )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk" "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>

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

  <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 48:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = 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: Element ID AllergyIntolerance
. . . substance 1..1 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 1..1 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.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = 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: Element ID AllergyIntolerance
. . . extension 1..1 Extension Substance (or pharmaceutical product)
. . . . url 1..1 uri "substance" "substance"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Substance Code ( example )
. . . extension 1..1 Extension known-reaction-risk | no-known-reaction-risk
. . . . url 1..1 uri "exposureRisk" "exposureRisk"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: AllergyIntoleranceSubstanceExposureRisk ( required )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk" "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>

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

  <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 48:
  }

 

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