Administration
This page is part of the FHIR Specification (v1.6.0:
STU
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions 
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
|
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
,
CarePlan
,
,
Contract
,
,
Group
,
,
Medication
,
Order
,
,
Procedure
,
,
Specimen
,
,
SupplyDelivery
and
and
SupplyRequest
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
Substance
|
DomainResource |
|
||
identifier
|
Σ | 0..* | Identifier |
|
|
category
|
Σ | 0..* | CodeableConcept |
|
|
code
|
Σ | 1..1 | CodeableConcept |
|
description
|
Σ | 0..1 | string |
|
instance
|
Σ | 0..* | BackboneElement |
|
identifier
|
Σ | 0..1 | Identifier |
|
|
expiry
|
Σ | 0..1 | dateTime |
|
quantity
|
Σ | 0..1 | SimpleQuantity |
|
|
ingredient
|
Σ | 0..* | BackboneElement |
|
quantity
|
Σ | 0..1 | Ratio |
|
substance[x]
|
Σ | 1..1 |
A component of the substance
Substance Code ( Example ) | |
|
substanceCodeableConcept
| CodeableConcept | |||
 substanceReference | Reference ( Substance ) | |||
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
(
Legend
)
XML
Template
XML Template
<
<Substance xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> <</category> <</code> < < <</identifier> < <</quantity><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>< <</quantity> <</substance><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>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "Substance",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Unique identifier
"category" : [{ CodeableConcept }], // What class/type of substance this is
"code" : { CodeableConcept }, // R! What 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(SimpleQuantity) } // Amount of substance in the package
}],
"
"
"
"ingredient" : [{ // Composition information about the substance
"quantity" : { Ratio }, // Optional amount (concentration)
// substance[x]: A component of the substance. One of these 2:
"substanceCodeableConcept" : { CodeableConcept }
"substanceReference" : { Reference(Substance) }
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| Substance | |
| Substance.ingredient.substance[x] | Renamed from substance to substance[x] Add CodeableConcept |
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Substance
|
DomainResource |
|
||
|
identifier
|
Σ | 0..* | Identifier |
|
|
category
|
Σ | 0..* | CodeableConcept |
|
|
code
|
Σ | 1..1 | CodeableConcept |
|
|
description
|
Σ | 0..1 | string |
|
|
instance
|
Σ | 0..* | BackboneElement |
|
|
identifier
|
Σ | 0..1 | Identifier |
|
|
expiry
|
Σ | 0..1 | dateTime |
|
|
quantity
|
Σ | 0..1 | SimpleQuantity |
|
|
ingredient
|
Σ | 0..* | BackboneElement |
|
|
quantity
|
Σ | 0..1 | Ratio |
|
|
substance[x]
|
Σ | 1..1 |
A component of the substance
Substance Code ( Example ) | |
|
substanceCodeableConcept
| CodeableConcept | |||
| substanceReference | Reference ( Substance ) | |||
|
Documentation for this format
|
||||
XML
Template
XML Template
<
<Substance xmlns="http://hl7.org/fhir"><</identifier> <</category> <</code> < < <</identifier> < <</quantity><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>< <</quantity> <</substance><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>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "Substance",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Unique identifier
"category" : [{ CodeableConcept }], // What class/type of substance this is
"code" : { CodeableConcept }, // R! What 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(SimpleQuantity) } // Amount of substance in the package
}],
"
"
"
"ingredient" : [{ // Composition information about the substance
"quantity" : { Ratio }, // Optional amount (concentration)
// substance[x]: A component of the substance. One of these 2:
"substanceCodeableConcept" : { CodeableConcept }
"substanceReference" : { Reference(Substance) }
}]
}
Alternate
definitions:
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| Substance | |
| Substance.ingredient.substance[x] | Renamed from substance to substance[x] Add CodeableConcept |
See the Full Difference for further information
Alternate definitions: Master Definition (
XML
,
JSON
),
XML
Schema
/
Schematron
,
Resource
Profile
(
XML
,
(for ) +
JSON
Schema
,
ShEx
(for
Turtle
),
Questionnaire
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| Substance.category |
|
Extensible |
|
| Substance.code |
|
Example |
|
| Substance.ingredient.substance[x] | Substance Ingredient codes | Example | Substance Code |
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| category | token |
|
Substance.category |
| code | token |
|
|
| container-identifier | token |
|
Substance.instance.identifier |
| expiry | date |
|
Substance.instance.expiry |
| identifier | token |
|
Substance.identifier |
| quantity | quantity |
|
Substance.instance.quantity |
|
|
reference |
|
( Substance ) |
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:07+1000.
QA Page
Links:
Search
|
|
Version History
|
Table of Contents
|
Compare to DSTU2
|
|
Propose
a
change
try
{
var
currentTabIndex
=
sessionStorage.getItem('fhir-resource-tab-index');
}
catch(exception){
}
if
(!currentTabIndex)
currentTabIndex
=
'0';
$(
'#tabs'
).tabs({
active:
currentTabIndex,
activate:
function(
event,
ui
)
{
var
active
=
$('.selector').tabs('option',
'active');
currentTabIndex
=
ui.newTab.index();
document.activeElement.blur();
try
{
sessionStorage.setItem('fhir-resource-tab-index',
currentTabIndex);
}
catch(exception){
}
}
});
|
Propose a change