This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: substanceExposureRisk

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

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
substanceExposureRisk		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 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.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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 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
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
Documentation for this format

XML Template

<!-- substanceExposureRisk -->

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

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

Summary

Name	Flags	Card.	Type	Description & Constraints
substanceExposureRisk		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 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.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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 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
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
Documentation for this format

XML Template

<!-- substanceExposureRisk -->

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

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

Constraints

• ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters)
• 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)))
• 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)