Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

8.17 8.19 Resource Substance - Content

Orders Responsible Owner: Biomedical Research and Observations Regulation icon Work Group Maturity Level : 2   Trial Use Security Category : Business Compartments : Not linked to any No defined compartments

A homogeneous material with a definite composition.

8.17.1 8.19.1 Scope and Usage

This is a base resource allows that represents raw materials used to represent a packaged or measured amount of a known substance (e.g. bottle, jar, packet, drum) that is not in a consumable form nor associated directly with a patient. For example, the materials used for a material to be represented. medication that are not yet in an administrable form.

This resource is used for "instances" of substances. The resource can be is not 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). patients (a "definitional" use). For that use see SubstanceDefinition resource.

The composition of A Substance may be identifiable as precise as the material can specific container it is stored in, while more commonly it would be specified in terms of based on a mix combination of other materials, including with precise amounts if required. lot number, quantity, and package type.

8.17.2 8.19.2 Boundaries and Relationships

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 represents an instance of a substance. For definitions (type, kind) see the SubstanceDefinition resource, which is referenced by purely definitional. A SubstanceDefinition describes the common characteristics of the substance, including those needed for regulatory agencies.

A NutritionProduct distinguishes from a Substance in that a nutrition product is primary consumable purpose is for its nutritional effect.

A BiologicallyDerivedProduct distinguishes from a Substance in that a BiologicallyDerivedProduct has its origins in a biological entity and needs to carry the source’s characteristics to enable matching and compatibility with the biological target to which it will be transfused or implanted, as well as traceability to the source.

8.19.3 References to this Resource

8.17.3 8.19.4 Resource Content

Structure

identifier Σ 0..1 Identifier Identifier of the package/container
Name Flags Card. Type Description & Constraints      Filter: Filters 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
Binding: FHIRSubstanceStatus ( Required )
. . . category Σ 0..* CodeableConcept What class/type of substance this is
Binding: Substance Category Codes ( Extensible )

. . . description Σ 0..1 string markdown Textual description of the substance, comments instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
. . . 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 icon

See the Extensions for this resource

UML Diagram ( Legend )

Substance ( DomainResource ) Unique identifier for the substance, often an identifier associated with the package/container of the substance instance (usually a label affixed directly) 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. null (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. null (Strength=Extensible) SubstanceCategoryCodes + » A code (or set of codes) that identify this substance code : CodeableConcept CodeableReference [1..1] « SubstanceDefinition ; Substance codes. null (Strength=Example) 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 markdown [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. (Strength=Example) 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>

 <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>
 <
 <
  <</identifier>
  <
  <</quantity>
 </instance>
 <
  <</quantity>
  <</substance[x]>
 </ingredient>

 <code><!-- 1..1 CodeableReference(SubstanceDefinition) What substance this is --></code>
 <description value="[markdown]"/><!-- 0..1 Textual description of the substance, comments -->
 <expiry value="[dateTime]"/><!-- 0..1 When no longer valid to use -->
 <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount of substance in the package --></quantity>

</Substance>

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Substance;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
    fhir:
    # . One of these 2
      fhir: ]
      fhir:) ]
  ], ...;

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Unique identifier
  fhir:status [ code ] ; # 0..1 active | inactive | entered-in-error
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* What class/type of substance this is
  fhir:code [ CodeableReference(SubstanceDefinition) ] ; # 1..1 What substance this is
  fhir:description [ markdown ] ; # 0..1 Textual description of the substance, comments
  fhir:expiry [ dateTime ] ; # 0..1 When no longer valid to use
  fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount of substance in the package

]

Changes since R3 from both R4 and R4B

Substance
Substance.status Substance.code
  • Change value set Type changed from http://hl7.org/fhir/ValueSet/substance-status CodeableConcept to http://hl7.org/fhir/ValueSet/substance-status|4.0.1 CodeableReference
Substance.description
  • Now marked as Modifier Type changed from string to markdown
Substance.category Substance.expiry
  • Change code system for extensibly bound codes Moved from "http://hl7.org/fhir/substance-category" Substance.instance to "http://terminology.hl7.org/CodeSystem/substance-category" Substance
Substance.quantity
  • Moved from Substance.instance to Substance
Substance.instance
  • Deleted
Substance.ingredient
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . See R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). ) for R4B as XML or JSON .

Structure

identifier Σ 0..1 Identifier Identifier of the package/container
Name Flags Card. Type Description & Constraints      Filter: Filters 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
Binding: FHIRSubstanceStatus ( Required )
. . . category Σ 0..* CodeableConcept What class/type of substance this is
Binding: Substance Category Codes ( Extensible )

. . . description Σ 0..1 string markdown Textual description of the substance, comments instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
. . . 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 icon

See the Extensions for this resource

UML Diagram ( Legend )

Substance ( DomainResource ) Unique identifier for the substance, often an identifier associated with the package/container of the substance instance (usually a label affixed directly) 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. null (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. null (Strength=Extensible) SubstanceCategoryCodes + » A code (or set of codes) that identify this substance code : CodeableConcept CodeableReference [1..1] « SubstanceDefinition ; Substance codes. null (Strength=Example) 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 markdown [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. (Strength=Example) 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>

 <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>
 <
 <
  <</identifier>
  <
  <</quantity>
 </instance>
 <
  <</quantity>
  <</substance[x]>
 </ingredient>

 <code><!-- 1..1 CodeableReference(SubstanceDefinition) What substance this is --></code>
 <description value="[markdown]"/><!-- 0..1 Textual description of the substance, comments -->
 <expiry value="[dateTime]"/><!-- 0..1 When no longer valid to use -->
 <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount of substance in the package --></quantity>

</Substance>

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Substance;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
    fhir:
    # . One of these 2
      fhir: ]
      fhir:) ]
  ], ...;

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Unique identifier
  fhir:status [ code ] ; # 0..1 active | inactive | entered-in-error
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* What class/type of substance this is
  fhir:code [ CodeableReference(SubstanceDefinition) ] ; # 1..1 What substance this is
  fhir:description [ markdown ] ; # 0..1 Textual description of the substance, comments
  fhir:expiry [ dateTime ] ; # 0..1 When no longer valid to use
  fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount of substance in the package

]

Changes since Release 3 from both R4 and R4B

Substance
Substance.status Substance.code
  • Change value set Type changed from http://hl7.org/fhir/ValueSet/substance-status CodeableConcept to http://hl7.org/fhir/ValueSet/substance-status|4.0.1 CodeableReference
Substance.description
  • Now marked as Modifier Type changed from string to markdown
Substance.category Substance.expiry
  • Change code system for extensibly bound codes Moved from "http://hl7.org/fhir/substance-category" Substance.instance to "http://terminology.hl7.org/CodeSystem/substance-category" Substance
Substance.quantity
  • Moved from Substance.instance to Substance
Substance.instance
  • Deleted
Substance.ingredient
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . See R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). ) for R4B as XML or JSON .

 

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

8.17.3.1 8.19.4.1 Terminology Bindings

Substance codes. Example Substance.ingredient.substance[x] Substance Ingredient codes.
Path Definition ValueSet Type Reference Documentation
Substance.status FHIRSubstanceStatus Required

A code to indicate if the substance is actively used. Required FHIRSubstanceStatus

Substance.category Category or classification of substance. SubstanceCategoryCodes Extensible SubstanceCategoryCodes

Substance category codes

Substance.code SubstanceCode Example SubstanceCode

This value set contains concept codes for specific substances. It includes codes from SNOMED icon where concept is-a 105590001 (Substance (substance))

8.17.4 8.19.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

substance-reference reference A component of the substance (Substance.ingredient.substance as Reference) ( Substance )
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.code.concept
code-reference container-identifier token reference Identifier of A reference to the package/container defining substance Substance.instance.identifier Substance.code.reference
expiry date Expiry date of package or container of substance Substance.instance.expiry Substance.expiry
identifier token Unique identifier for the substance Substance.identifier
quantity quantity Amount of substance in the package Substance.instance.quantity Substance.quantity
status token active | inactive | entered-in-error Substance.status