FHIR General Extensions IG
0.1.0 - Working Copy International flag

This page is part of the FHIR Core Extensions Registry (v0.1.0: Releases Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Extension: AllergyIntolerance Substance Exposure Risk

Official URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: AISubstanceExposureRisk
Other Identifiers: id: urn:oid:2.16.840.1.113883.4.642.5.1296

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

This extension may be used on the following element(s):

  • Element ID AllergyIntolerance

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Mandatory: 4 elements
Fixed Value: 3 elements
Prohibited: 3 elements

Maturity: 1

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C0..1ExtensionExposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted.
... extension:substance 1..1ExtensionSubstance (or pharmaceutical product)
.... extension 0..0
.... url 1..1uri"substance"
.... value[x] 1..1CodeableConceptValue of extension
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

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

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C0..1ExtensionExposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted.
... id 0..1idUnique id for inter-element referencing
... 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: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

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

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 4 elements
Fixed Value: 3 elements
Prohibited: 3 elements

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C0..1ExtensionExposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted.
... extension:substance 1..1ExtensionSubstance (or pharmaceutical product)
.... extension 0..0
.... url 1..1uri"substance"
.... value[x] 1..1CodeableConceptValue of extension
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

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

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C0..1ExtensionExposure risk of adverse reaction (allergy or intolerance) to the specified substance/product
inv-1: If the substanceExposureRisk extension element is present, the AllergyIntolerance.code element must be omitted.
... id 0..1idUnique id for inter-element referencing
... 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: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

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

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:substance.value[x]exampleSubstanceCode
Extension.extension:exposureRisk.value[x]requiredAllergyIntoleranceSubstanceExposureRisk (a valid code from AllergyIntolerance substance exposure risk)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Search Parameters for this Extension

(none found)

;