2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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.14 Resource Substance - Content

This resource maintained by the Orders and Observations Work Group

A homogeneous material with a definite composition.

5.14.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.14.2 Boundaries and Relationships

A medication is a substance that is packaged and used for use 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, Group, Medication, Order, Specimen and Supply

5.14.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance DomainResourceA homogeneous material with a definite composition
... type 1..1CodeableConceptWhat kind of substance this is
SubstanceType (Example)
... description 0..1stringTextual description of the substance, comments
... instance 0..1ElementIf 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..1QuantityAmount of substance in the package
... ingredient 0..*ElementComposition information about the substance
.... quantity 0..1RatioOptional amount (concentration)
.... substance 1..1SubstanceA component of the substance

XML Template

<Substance xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <type><!-- 1..1 CodeableConcept What kind of substance this is --></type>
 <description value="[string]"/><!-- 0..1 Textual description of the substance, comments -->
 <instance>  <!-- 0..1 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 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>

JSON Template

{doco
  "resourceType" : "Substance",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "type" : { CodeableConcept }, // R! What kind of substance this is
  "description" : "<string>", // Textual description of the substance, comments
  "instance" : { // If this describes a specific package/container of the substance
    "identifier" : { Identifier }, // Identifier of the package/container
    "expiry" : "<dateTime>", // When no longer valid to use
    "quantity" : { Quantity } // Amount of substance in the package
  },
  "ingredient" : [{ // Composition information about the substance
    "quantity" : { Ratio }, // Optional amount (concentration)
    "substance" : { Reference(Substance) } // R! A component of the substance
  }]
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance DomainResourceA homogeneous material with a definite composition
... type 1..1CodeableConceptWhat kind of substance this is
SubstanceType (Example)
... description 0..1stringTextual description of the substance, comments
... instance 0..1ElementIf 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..1QuantityAmount of substance in the package
... ingredient 0..*ElementComposition information about the substance
.... quantity 0..1RatioOptional amount (concentration)
.... substance 1..1SubstanceA component of the substance

XML Template

<Substance xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <type><!-- 1..1 CodeableConcept What kind of substance this is --></type>
 <description value="[string]"/><!-- 0..1 Textual description of the substance, comments -->
 <instance>  <!-- 0..1 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 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>

JSON Template

{doco
  "resourceType" : "Substance",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "type" : { CodeableConcept }, // R! What kind of substance this is
  "description" : "<string>", // Textual description of the substance, comments
  "instance" : { // If this describes a specific package/container of the substance
    "identifier" : { Identifier }, // Identifier of the package/container
    "expiry" : "<dateTime>", // When no longer valid to use
    "quantity" : { Quantity } // Amount of substance in the package
  },
  "ingredient" : [{ // Composition information about the substance
    "quantity" : { Ratio }, // Optional amount (concentration)
    "substance" : { Reference(Substance) } // R! A component of the substance
  }]
}

 

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

5.14.3.1 Terminology Bindings

PathDefinitionTypeReference
Substance.type Type of the substanceExamplehttp://hl7.org/fhir/vs/substance-type

5.14.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
expirydateWhen no longer valid to useSubstance.instance.expiry
identifiertokenIdentifier of the package/containerSubstance.instance.identifier
quantitynumberAmount of substance in the packageSubstance.instance.quantity
substancereferenceA component of the substanceSubstance.ingredient.substance
(Substance)
typetokenThe type of the substanceSubstance.type