This page is part of the HL7 Europe Laboratory Report (v2.1.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Substance: Specimen Additive Substance

This profile defines how to represent Specimen Additive Substances in HL7 FHIR for the purpose of this guide.

Usages:

• Refer to this Profile: Specimen: Laboratory

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance	A homogeneous material with a definite composition
Substance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Substance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Substance.status	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
Substance.code	Σ This element is included in summaries.	1..1	CodeableConcept	What substance this is Binding: Specimen Additive (preferred)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Substance.status	Base	required	FHIRSubstanceStatus	📍4.0.1	FHIR Std.
Substance.code	Base	preferred	Specimen Additive	📦2.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Substance	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Substance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Substance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Substance	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Substance	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Substance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance	A homogeneous material with a definite composition
Substance.code		1..1	CodeableConcept	What substance this is Binding: Specimen Additive (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Substance.code	Base	preferred	Specimen Additive	📦2.1.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance	A homogeneous material with a definite composition
Substance.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Substance.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Substance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Substance.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Substance.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Substance.contained		0..*	Resource	Contained, inline Resources
Substance.extension		0..*	Extension	Additional content defined by implementations
Substance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Substance.identifier	Σ This element is included in summaries.	0..*	Identifier	Unique identifier
Substance.status	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
Substance.category	Σ This element is included in summaries.	0..*	CodeableConcept	What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
Substance.code	Σ This element is included in summaries.	1..1	CodeableConcept	What substance this is Binding: Specimen Additive (preferred)
Substance.description	Σ This element is included in summaries.	0..1	string	Textual description of the substance, comments
Substance.instance	Σ This element is included in summaries.	0..*	BackboneElement	If this describes a specific package/container of the substance
Substance.instance.id		0..1	string	Unique id for inter-element referencing
Substance.instance.extension		0..*	Extension	Additional content defined by implementations
Substance.instance.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Substance.instance.identifier	Σ This element is included in summaries.	0..1	Identifier	Identifier of the package/container
Substance.instance.expiry	Σ This element is included in summaries.	0..1	dateTime	When no longer valid to use
Substance.instance.quantity	Σ This element is included in summaries. C	0..1	SimpleQuantity(4.0.1)	Amount of substance in the package Constraints: sqty-1
Substance.ingredient	Σ This element is included in summaries.	0..*	BackboneElement	Composition information about the substance
Substance.ingredient.id		0..1	string	Unique id for inter-element referencing
Substance.ingredient.extension		0..*	Extension	Additional content defined by implementations
Substance.ingredient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Substance.ingredient.quantity	Σ This element is included in summaries.	0..1	Ratio	Optional amount (concentration)
Substance.ingredient.substance[x]	Σ This element is included in summaries.	1..1		A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes.
Substance.ingredient.substance[x].substanceCodeableConcept			CodeableConcept
Substance.ingredient.substance[x].substanceReference			Reference(Substance)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Substance.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Substance.status	Base	required	FHIRSubstanceStatus	📍4.0.1	FHIR Std.
Substance.category	Base	extensible	Substance Category Codes	📍4.0.1	FHIR Std.
Substance.code	Base	preferred	Specimen Additive	📦2.1.0	This IG
Substance.ingredient.​substance[x]	Base	example	Substance Code	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Substance	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Substance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Substance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Substance	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Substance	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
sqty-1	error	Substance.instance.quantity	The comparator is not used on a SimpleQuantity	comparator.empty()

This structure is derived from Substance

Summary

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance	A homogeneous material with a definite composition
Substance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Substance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Substance.status	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
Substance.code	Σ This element is included in summaries.	1..1	CodeableConcept	What substance this is Binding: Specimen Additive (preferred)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Substance.status	Base	required	FHIRSubstanceStatus	📍4.0.1	FHIR Std.
Substance.code	Base	preferred	Specimen Additive	📦2.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Substance	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Substance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Substance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Substance	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Substance	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

This structure is derived from Substance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance	A homogeneous material with a definite composition
Substance.code		1..1	CodeableConcept	What substance this is Binding: Specimen Additive (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Substance.code	Base	preferred	Specimen Additive	📦2.1.0	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance	A homogeneous material with a definite composition
Substance.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Substance.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Substance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Substance.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Substance.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Substance.contained		0..*	Resource	Contained, inline Resources
Substance.extension		0..*	Extension	Additional content defined by implementations
Substance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Substance.identifier	Σ This element is included in summaries.	0..*	Identifier	Unique identifier
Substance.status	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
Substance.category	Σ This element is included in summaries.	0..*	CodeableConcept	What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
Substance.code	Σ This element is included in summaries.	1..1	CodeableConcept	What substance this is Binding: Specimen Additive (preferred)
Substance.description	Σ This element is included in summaries.	0..1	string	Textual description of the substance, comments
Substance.instance	Σ This element is included in summaries.	0..*	BackboneElement	If this describes a specific package/container of the substance
Substance.instance.id		0..1	string	Unique id for inter-element referencing
Substance.instance.extension		0..*	Extension	Additional content defined by implementations
Substance.instance.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Substance.instance.identifier	Σ This element is included in summaries.	0..1	Identifier	Identifier of the package/container
Substance.instance.expiry	Σ This element is included in summaries.	0..1	dateTime	When no longer valid to use
Substance.instance.quantity	Σ This element is included in summaries. C	0..1	SimpleQuantity(4.0.1)	Amount of substance in the package Constraints: sqty-1
Substance.ingredient	Σ This element is included in summaries.	0..*	BackboneElement	Composition information about the substance
Substance.ingredient.id		0..1	string	Unique id for inter-element referencing
Substance.ingredient.extension		0..*	Extension	Additional content defined by implementations
Substance.ingredient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Substance.ingredient.quantity	Σ This element is included in summaries.	0..1	Ratio	Optional amount (concentration)
Substance.ingredient.substance[x]	Σ This element is included in summaries.	1..1		A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes.
Substance.ingredient.substance[x].substanceCodeableConcept			CodeableConcept
Substance.ingredient.substance[x].substanceReference			Reference(Substance)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Substance.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Substance.status	Base	required	FHIRSubstanceStatus	📍4.0.1	FHIR Std.
Substance.category	Base	extensible	Substance Category Codes	📍4.0.1	FHIR Std.
Substance.code	Base	preferred	Specimen Additive	📦2.1.0	This IG
Substance.ingredient.​substance[x]	Base	example	Substance Code	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Substance	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Substance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Substance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Substance	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Substance	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
sqty-1	error	Substance.instance.quantity	The comparator is not used on a SimpleQuantity	comparator.empty()

This structure is derived from Substance

Summary

Maturity: 2

Other representations of profile: CSV, Excel, Schematron