CH LAB-Report (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-lab-report/ and changes regularly. See the Directory of published versions

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

Resource Profile: CH LAB-Report 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: CH LAB-Report Specimen
• Examples for this Profile: Substance/EDTA

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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
code	Σ	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	📦0.1.1	HL7 Europe Laboratory Report v0.1

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
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	📦0.1.1	HL7 Europe Laboratory Report v0.1

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

This structure is derived from Substance

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance	A homogeneous material with a definite composition
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
code	Σ	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	📦0.1.1	HL7 Europe Laboratory Report v0.1

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
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	📦0.1.1	HL7 Europe Laboratory Report v0.1

Snapshot View

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

This structure is derived from Substance

Summary

Other representations of profile: CSV, Excel, Schematron