Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.3.0: R4B - STU ). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: substanceExposureRisk AllergyIntolerance Substance Exposure Risk

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

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG 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").

Context of Use: Use on Element ID AllergyIntolerance

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . substanceExposureRisk AISubstanceExposureRisk 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
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 Code for a substance or Substance (or pharmaceutical product that is considered to be responsible for product)

Binding: Substance Code ( example ): Codes defining the adverse reaction risk or is known not to have an associated risk type of an adverse reaction upon exposure. the substance (including pharmaceutical products).


. . . exposureRisk 1..1 CodeableConcept known-reaction-risk | no-known-reaction-risk

Binding: AllergyIntoleranceSubstanceExposureRisk ( required ): The presence or absence of a known exposure risk of the patient for an adverse reaction (allergy or intolerance) for this patient upon exposure to the specified substance/product. substance (including pharmaceutical products).



doco Documentation for this format

Full Structure

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
Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
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).

. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- substanceExposureRisk -->

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

 <extension url="substance"> I 1..1 Extension  <!-- I 1..1 Substance (or pharmaceutical product) -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>

 </extension>
 <
  <</valueCodeableConcept>

 <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 doco
. . substanceExposureRisk AISubstanceExposureRisk 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
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 Code for a substance or Substance (or pharmaceutical product that is considered to be responsible for product)

Binding: Substance Code ( example ): Codes defining the adverse reaction risk or is known not to have an associated risk type of an adverse reaction upon exposure. the substance (including pharmaceutical products).


. . . exposureRisk 1..1 CodeableConcept known-reaction-risk | no-known-reaction-risk

Binding: AllergyIntoleranceSubstanceExposureRisk ( required ): The presence or absence of a known exposure risk of the patient for an adverse reaction (allergy or intolerance) for this patient upon exposure to the specified substance/product. substance (including pharmaceutical products).



doco Documentation for this format

Full Structure

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
Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
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).

. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- substanceExposureRisk -->

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

 <extension url="substance"> I 1..1 Extension  <!-- I 1..1 Substance (or pharmaceutical product) -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>

 </extension>
 <
  <</valueCodeableConcept>

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

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.