FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Extension: AllergyIntolerance Substance Exposure Risk

Patient Care Work Group Maturity Level: 1Trial UseUse Context: Any
Official URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk Version: 5.0.0-cibuild
draft as of 2015-02-21 Computable Name: AISubstanceExposureRisk
Flags: Non-Modifier OID: 2.16.840.1.113883.4.642.5.1296

Context of Use: Use on Element ID AllergyIntolerance

Definition

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. AISubstanceExposureRisk0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
AISubstanceExposureRisk: 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..1CodeableConceptSubstance (or pharmaceutical product)

Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).


... exposureRisk1..1CodeableConceptknown-reaction-risk | no-known-reaction-risk

Binding: AllergyIntoleranceSubstanceExposureRisk (required): The risk of an adverse reaction (allergy or intolerance) for this patient upon exposure to the substance (including pharmaceutical products).



doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
AISubstanceExposureRisk: 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
... Slices for extension 0..*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: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).

... extension:exposureRisk 1..1Extensionknown-reaction-risk | no-known-reaction-risk
.... 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).

... value[x] 0..0

doco Documentation for this format

XML Template

<!-- AISubstanceExposureRisk -->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"> I 1..1 Extension  <!-- I 1..1 Substance (or pharmaceutical product) -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="exposureRisk"> I 1..1 Extension  <!-- I 1..1 known-reaction-risk | no-known-reaction-risk -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

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

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. AISubstanceExposureRisk0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
AISubstanceExposureRisk: 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..1CodeableConceptSubstance (or pharmaceutical product)

Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).


... exposureRisk1..1CodeableConceptknown-reaction-risk | no-known-reaction-risk

Binding: AllergyIntoleranceSubstanceExposureRisk (required): The risk of an adverse reaction (allergy or intolerance) for this patient upon exposure to the substance (including pharmaceutical products).



doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
AISubstanceExposureRisk: 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
... Slices for extension 0..*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: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).

... extension:exposureRisk 1..1Extensionknown-reaction-risk | no-known-reaction-risk
.... 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).

... value[x] 0..0

doco Documentation for this format

XML Template

<!-- AISubstanceExposureRisk -->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"> I 1..1 Extension  <!-- I 1..1 Substance (or pharmaceutical product) -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="exposureRisk"> I 1..1 Extension  <!-- I 1..1 known-reaction-risk | no-known-reaction-risk -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

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

 

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

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.