• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: AllergyIntolerance Substance Exposure Risk

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
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
AISubstanceExposureRisk		0..1	Extension	URL = 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
substance		1..1	CodeableConcept	Substance (or pharmaceutical product) Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).
exposureRisk		1..1	CodeableConcept	known-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).
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = 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..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:substance		1..1	Extension	Substance (or pharmaceutical product)
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"substance"
value[x]		1..1	CodeableConcept	Value of extension Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).
extension:exposureRisk		1..1	Extension	known-reaction-risk | no-known-reaction-risk
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"exposureRisk"
value[x]		1..1	CodeableConcept	Value 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..1	uri	"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"
value[x]		0..0
Documentation for this format

XML Template

<!-- AISubstanceExposureRisk -->

<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

Name	Flags	Card.	Type	Description & Constraints
AISubstanceExposureRisk		0..1	Extension	URL = 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
substance		1..1	CodeableConcept	Substance (or pharmaceutical product) Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).
exposureRisk		1..1	CodeableConcept	known-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).
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = 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..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:substance		1..1	Extension	Substance (or pharmaceutical product)
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"substance"
value[x]		1..1	CodeableConcept	Value of extension Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).
extension:exposureRisk		1..1	Extension	known-reaction-risk | no-known-reaction-risk
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"exposureRisk"
value[x]		1..1	CodeableConcept	Value 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..1	uri	"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"
value[x]		0..0
Documentation for this format

XML Template

<!-- AISubstanceExposureRisk -->

<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: hasValue() or (children().count() > id.count()))
• ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
• inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted. (xpath: substanceExposureRisk.exists() and code.empty())
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
• ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
• ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
• ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

Examples of this extension

No examples found.