DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). 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: R5 R4B R4 R3 R2

5.16 Resource Substance - Content

Orders and Observations Work GroupMaturity Level: 1Compartments: Not linked to any defined compartments

A homogeneous material with a definite composition.

5.16.1 Scope and Usage

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.

5.16.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 is referenced by CarePlan, Contract, Group, Medication, Order, Procedure, Specimen, SupplyDelivery and SupplyRequest

5.16.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance DomainResourceA homogeneous material with a definite composition
... identifier Σ0..*IdentifierUnique identifier
... category Σ0..*CodeableConceptWhat class/type of substance this is
Substance Category Codes (Extensible)
... code Σ1..1CodeableConceptWhat substance this is
Substance Code (Example)
... description Σ0..1stringTextual description of the substance, comments
... instance Σ0..*BackboneElementIf this describes a specific package/container of the substance
.... identifier Σ0..1IdentifierIdentifier of the package/container
.... expiry Σ0..1dateTimeWhen no longer valid to use
.... quantity Σ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... quantity Σ0..1RatioOptional amount (concentration)
.... substance Σ1..1Reference(Substance)A component of the substance

doco Documentation for this format

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>
 <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><!-- 1..1 Reference(Substance) A component of the substance --></substance>
 </ingredient>
</Substance>

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance DomainResourceA homogeneous material with a definite composition
... identifier Σ0..*IdentifierUnique identifier
... category Σ0..*CodeableConceptWhat class/type of substance this is
Substance Category Codes (Extensible)
... code Σ1..1CodeableConceptWhat substance this is
Substance Code (Example)
... description Σ0..1stringTextual description of the substance, comments
... instance Σ0..*BackboneElementIf this describes a specific package/container of the substance
.... identifier Σ0..1IdentifierIdentifier of the package/container
.... expiry Σ0..1dateTimeWhen no longer valid to use
.... quantity Σ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... quantity Σ0..1RatioOptional amount (concentration)
.... substance Σ1..1Reference(Substance)A component of the substance

doco Documentation for this format

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>
 <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><!-- 1..1 Reference(Substance) A component of the substance --></substance>
 </ingredient>
</Substance>

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

5.16.3.1 Terminology Bindings

PathDefinitionTypeReference
Substance.category Category or classification of substanceExtensibleSubstance Category Codes
Substance.code Substance codesExampleSubstance Code

5.16.4 Search Parameters

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

NameTypeDescriptionPaths
categorytokenThe category of the substanceSubstance.category
codetokenThe code of the substanceSubstance.code
container-identifiertokenIdentifier of the package/containerSubstance.instance.identifier
expirydateExpiry date of package or container of substanceSubstance.instance.expiry
identifiertokenUnique identifier for the substanceSubstance.identifier
quantityquantityAmount of substance in the packageSubstance.instance.quantity
substancereferenceA component of the substanceSubstance.ingredient.substance
(Substance)