FHIR Release 3 (STU) Current Build
This page is part of FHIR STU 3 (v3.0.1) in it's permanent home (it will always be available at this URL). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .

8.17 Resource Substance - Content

Orders and Observations Work Group Maturity Level : 2   Trial Use Security Category : Business Compartments : Not linked to any defined compartments

A homogeneous material with a definite composition.

This resource allows for a material to be represented. The resource can be used to represent either a kind of a substance - e.g. a formulation commonly used for treating patients, or it can be used to describe a particular package of a known substance (e.g. bottle, jar, packet).

The composition of the material can be specified in terms of a mix of other materials, including with precise amounts if required.

A medication is a substance that is packaged and used as an administered medication. The medication resource uses the substance resource to represent the actual ingredients of a medication.

This resource is referenced by ActivityDefinition , AdverseEvent , BiologicallyDerivedProduct , CarePlan , CatalogEntry , ChargeItem , ChargeItemDefinition , ClinicalUseIssue , Contract , Group , Medication , Procedure , Specimen , SpecimenDefinition , itself, SubstanceDefinition , SupplyDelivery and SupplyRequest .

This resource does not implement any patterns.

Structure

Name Flags Card. Type Description & Constraints doco
. . Substance TU DomainResource A homogeneous material with a definite composition
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Unique identifier
. . . status ?! Σ 0..1 code active | inactive | entered-in-error
FHIRSubstanceStatus ( Required )
. . . category Σ 0..* CodeableConcept What class/type of substance this is
Substance Category Codes ( Extensible )
. . . code Σ 1..1 CodeableConcept What substance this is
Substance Code ( Example )
. . . description Σ 0..1 string Textual description of the substance, comments
. . . instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
. . . . identifier Σ 0..1 Identifier Identifier of the package/container
. . . . expiry Σ 0..1 dateTime When no longer valid to use
. . . . quantity Σ 0..1 SimpleQuantity Amount of substance in the package
. . . ingredient Σ 0..* BackboneElement Composition information about the substance
. . . . quantity Σ 0..1 Ratio Optional amount (concentration)
. . . . substance[x] Σ 1..1 A component of the substance
Substance Code ( Example )
. . . . . substanceCodeableConcept CodeableConcept
. . . . . substanceReference Reference ( Substance )

doco Documentation for this format

UML Diagram ( Legend )

Substance ( DomainResource ) Unique identifier for the substance identifier : Identifier [0..*] A code to indicate if the substance is actively used (this element modifies the meaning of other elements) status : code [0..1] « A code to indicate if the substance is actively used used. (Strength=Required) FHIRSubstanceStatus ! » A code that classifies the general type of substance. This is used for searching, sorting and display purposes category : CodeableConcept [0..*] « Category or classification of substance substance. (Strength=Extensible) Substance Category SubstanceCategoryCodes + » A code (or set of codes) that identify this substance code : CodeableConcept [1..1] « Substance codes codes. (Strength=Example) Substance Code SubstanceCode ?? » A description of the substance - its appearance, handling requirements, and other usage notes description : string [0..1] Instance Identifier associated with the package/container (usually a label affixed directly) identifier : Identifier [0..1] When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry expiry : dateTime [0..1] The amount of the substance quantity : Quantity ( SimpleQuantity ) [0..1] Ingredient The amount of the ingredient in the substance - a concentration ratio quantity : Ratio [0..1] Another substance that is a component of this substance substance[x] : Type [1..1] « CodeableConcept | Reference ( Substance ); Substance Ingredient codes codes. (Strength=Example) Substance Code SubstanceCode ?? » Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance instance [0..*] A substance can be composed of other substances ingredient [0..*]

XML Template

<Substance xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <

 <status value="[code]"/><!-- 0..1 active | inactive | entered-in-error -->

 <category><!-- 0..* CodeableConcept What class/type of substance this is --></category>
 <code><!-- 1..1 CodeableConcept What substance this is --></code>
 <description value="[string]"/><!-- 0..1 Textual description of the substance, comments -->
 <instance>  <!-- 0..* If this describes a specific package/container of the substance -->
  <identifier><!-- 0..1 Identifier Identifier of the package/container --></identifier>
  <expiry value="[dateTime]"/><!-- 0..1 When no longer valid to use -->
  <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount of substance in the package --></quantity>
 </instance>
 <ingredient>  <!-- 0..* Composition information about the substance -->
  <quantity><!-- 0..1 Ratio Optional amount (concentration) --></quantity>
  <substance[x]><!-- 1..1 CodeableConcept|Reference(Substance) A component of the substance --></substance[x]>
 </ingredient>
</Substance>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:Substance;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Substance.identifier [ Identifier ], ... ; # 0..* Unique identifier
  fhir:

  fhir:Substance.status [ code ]; # 0..1 active | inactive | entered-in-error

  fhir:Substance.category [ CodeableConcept ], ... ; # 0..* What class/type of substance this is
  fhir:Substance.code [ CodeableConcept ]; # 1..1 What substance this is
  fhir:Substance.description [ string ]; # 0..1 Textual description of the substance, comments
  fhir:Substance.instance [ # 0..* If this describes a specific package/container of the substance
    fhir:Substance.instance.identifier [ Identifier ]; # 0..1 Identifier of the package/container
    fhir:Substance.instance.expiry [ dateTime ]; # 0..1 When no longer valid to use
    fhir:Substance.instance.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount of substance in the package
  ], ...;
  fhir:Substance.ingredient [ # 0..* Composition information about the substance
    fhir:Substance.ingredient.quantity [ Ratio ]; # 0..1 Optional amount (concentration)
    # Substance.ingredient.substance[x] : 1..1 A component of the substance. One of these 2
      fhir:Substance.ingredient.substanceCodeableConcept [ CodeableConcept ]
      fhir:Substance.ingredient.substanceReference [ Reference(Substance) ]
  ], ...;
]

Changes since DSTU2 R3

Substance Substance.status Added Element
Substance.ingredient.substance[x] Substance.status
  • Renamed Change value set from substance http://hl7.org/fhir/ValueSet/substance-status|4.0.0 to substance[x] Add CodeableConcept http://hl7.org/fhir/ValueSet/substance-status|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and all 1 r3 resources are valid.). invalid (0 errors). )

Structure

Name Flags Card. Type Description & Constraints doco
. . Substance TU DomainResource A homogeneous material with a definite composition
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Unique identifier
. . . status ?! Σ 0..1 code active | inactive | entered-in-error
FHIRSubstanceStatus ( Required )
. . . category Σ 0..* CodeableConcept What class/type of substance this is
Substance Category Codes ( Extensible )
. . . code Σ 1..1 CodeableConcept What substance this is
Substance Code ( Example )
. . . description Σ 0..1 string Textual description of the substance, comments
. . . instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
. . . . identifier Σ 0..1 Identifier Identifier of the package/container
. . . . expiry Σ 0..1 dateTime When no longer valid to use
. . . . quantity Σ 0..1 SimpleQuantity Amount of substance in the package
. . . ingredient Σ 0..* BackboneElement Composition information about the substance
. . . . quantity Σ 0..1 Ratio Optional amount (concentration)
. . . . substance[x] Σ 1..1 A component of the substance
Substance Code ( Example )
. . . . . substanceCodeableConcept CodeableConcept
. . . . . substanceReference Reference ( Substance )

doco Documentation for this format

UML Diagram ( Legend )

Substance ( DomainResource ) Unique identifier for the substance identifier : Identifier [0..*] A code to indicate if the substance is actively used (this element modifies the meaning of other elements) status : code [0..1] « A code to indicate if the substance is actively used used. (Strength=Required) FHIRSubstanceStatus ! » A code that classifies the general type of substance. This is used for searching, sorting and display purposes category : CodeableConcept [0..*] « Category or classification of substance substance. (Strength=Extensible) Substance Category SubstanceCategoryCodes + » A code (or set of codes) that identify this substance code : CodeableConcept [1..1] « Substance codes codes. (Strength=Example) Substance Code SubstanceCode ?? » A description of the substance - its appearance, handling requirements, and other usage notes description : string [0..1] Instance Identifier associated with the package/container (usually a label affixed directly) identifier : Identifier [0..1] When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry expiry : dateTime [0..1] The amount of the substance quantity : Quantity ( SimpleQuantity ) [0..1] Ingredient The amount of the ingredient in the substance - a concentration ratio quantity : Ratio [0..1] Another substance that is a component of this substance substance[x] : Type [1..1] « CodeableConcept | Reference ( Substance ); Substance Ingredient codes codes. (Strength=Example) Substance Code SubstanceCode ?? » Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance instance [0..*] A substance can be composed of other substances ingredient [0..*]

XML Template

<Substance xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <

 <status value="[code]"/><!-- 0..1 active | inactive | entered-in-error -->

 <category><!-- 0..* CodeableConcept What class/type of substance this is --></category>
 <code><!-- 1..1 CodeableConcept What substance this is --></code>
 <description value="[string]"/><!-- 0..1 Textual description of the substance, comments -->
 <instance>  <!-- 0..* If this describes a specific package/container of the substance -->
  <identifier><!-- 0..1 Identifier Identifier of the package/container --></identifier>
  <expiry value="[dateTime]"/><!-- 0..1 When no longer valid to use -->
  <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount of substance in the package --></quantity>
 </instance>
 <ingredient>  <!-- 0..* Composition information about the substance -->
  <quantity><!-- 0..1 Ratio Optional amount (concentration) --></quantity>
  <substance[x]><!-- 1..1 CodeableConcept|Reference(Substance) A component of the substance --></substance[x]>
 </ingredient>
</Substance>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:Substance;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Substance.identifier [ Identifier ], ... ; # 0..* Unique identifier
  fhir:

  fhir:Substance.status [ code ]; # 0..1 active | inactive | entered-in-error

  fhir:Substance.category [ CodeableConcept ], ... ; # 0..* What class/type of substance this is
  fhir:Substance.code [ CodeableConcept ]; # 1..1 What substance this is
  fhir:Substance.description [ string ]; # 0..1 Textual description of the substance, comments
  fhir:Substance.instance [ # 0..* If this describes a specific package/container of the substance
    fhir:Substance.instance.identifier [ Identifier ]; # 0..1 Identifier of the package/container
    fhir:Substance.instance.expiry [ dateTime ]; # 0..1 When no longer valid to use
    fhir:Substance.instance.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount of substance in the package
  ], ...;
  fhir:Substance.ingredient [ # 0..* Composition information about the substance
    fhir:Substance.ingredient.quantity [ Ratio ]; # 0..1 Optional amount (concentration)
    # Substance.ingredient.substance[x] : 1..1 A component of the substance. One of these 2
      fhir:Substance.ingredient.substanceCodeableConcept [ CodeableConcept ]
      fhir:Substance.ingredient.substanceReference [ Reference(Substance) ]
  ], ...;
]

Changes since DSTU2 Release 3

Substance Substance.status Added Element
Substance.ingredient.substance[x] Substance.status
  • Renamed Change value set from substance http://hl7.org/fhir/ValueSet/substance-status|4.0.0 to substance[x] Add CodeableConcept http://hl7.org/fhir/ValueSet/substance-status|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and all 1 r3 resources are valid.). invalid (0 errors). )

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis a

Path Definition Type Reference
Substance.status A code to indicate if the substance is actively used used. Required FHIRSubstanceStatus
Substance.category Category or classification of substance substance. Extensible Substance Category Codes SubstanceCategoryCodes
Substance.code Substance codes codes. Example Substance Code SubstanceCode
Substance.ingredient.substance[x] Substance Ingredient codes codes. Example Substance Code SubstanceCode

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
category token The category of the substance Substance.category
code token The code of the substance or ingredient Substance.code | Substance.ingredient.substance.as(CodeableConcept) (Substance.ingredient.substance as CodeableConcept)
container-identifier token Identifier of the package/container Substance.instance.identifier
expiry date Expiry date of package or container of substance Substance.instance.expiry
identifier token Unique identifier for the substance Substance.identifier
quantity quantity Amount of substance in the package Substance.instance.quantity
status token active | inactive | entered-in-error Substance.status
substance-reference reference A component of the substance Substance.ingredient.substance.as(Reference) (Substance.ingredient.substance as Reference)
( Substance )