DSTU2

This page is part of the FHIR Specification (v0.0.82: (v1.0.2: DSTU 1). 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.7 5.16 Resource Substance - Content

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

A homogeneous material with a definite composition.

5.7.1 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.7.2 5.16.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 , Contract , Group , Medication , Order , Procedure , Specimen , SupplyDelivery and SupplyRequest

5.7.3 5.16.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
.. Substance DomainResource A homogeneous material with a definite composition
... identifier Σ 0..* Identifier Unique identifier
... 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 Σ 1..1 Reference ( 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

Name Flags Card. Type Description & Constraints doco
.. Substance DomainResource A homogeneous material with a definite composition
... identifier Σ 0..* Identifier Unique identifier
... 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 Σ 1..1 Reference ( Substance ) A component of the substance

doco Documentation for this format

UML Diagram

Substance ( DomainResource ) Unique identifier for the substance identifier : Identifier [0..*] A code that classifies the general type of substance. This resource is referenced by AdverseReaction , AllergyIntolerance , CarePlan , Group , Medication , Specimen used for searching, sorting and display purposes category : CodeableConcept [0..*] « Category or classification of substance (Strength=Extensible) Substance Category + » A code (or set of codes) that identify this substance code : CodeableConcept [1..1] « Substance codes (Strength=Example) Substance Code ?? » A description of the substance - its appearance, handling requirements, and Supply 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 < <!-- from --> <</type> < < <</identifier> < <</quantity> : 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 : Reference [1..1] « Substance » 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>
 <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>
  <</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.7.3.1 5.16.3.1 Terminology Bindings

Substance.type
Path Definition Type Reference
Substance.category Type Category or classification of the substance Extensible Substance Category Codes
Substance.code Substance codes Example http://hl7.org/fhir/vs/substance-type Substance Code

5.7.4 5.16.4 Search Parameters

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

type token The type of the substance Substance.type
Name Type Description Paths
_id category token The logical resource id associated with category of the resource (must be supported by all servers) substance Substance.category
_language code token The language code of the resource substance Substance.code
container-identifier token Identifier of the package/container Substance.instance.identifier
expiry date When no longer valid to use Expiry date of package or container of substance Substance.instance.expiry
identifier token Identifier of Unique identifier for the package/container substance Substance.instance.identifier Substance.identifier
quantity number quantity Amount of substance in the package Substance.instance.quantity
substance reference A component of the substance Substance.ingredient.substance
( Substance )
var disqus_shortname = 'fhirdstu';(function() {var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); Please enable JavaScript to view the comments powered by Disqus. comments powered by Disqus var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-676355-1']); _gaq.push(['_setDomainName', '.hl7.org']); _gaq.push(['_trackPageview']); (function()