Extensions for Using Data Elements from FHIR R4B in FHIR R5 - Downloaded Version null See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: Profile_R4B_Substance_R5

This cross-version profile allows R4B Substance content to be represented via FHIR R5 Substance resources.

Usages:

• Refer to this Profile: R4B: Any processing of the product during collection (new), R4B: In-line definition of activity (new), R4B: product additional types, R4B: Active or inactive ingredient (new)... Show 3 more, R4B: usedReference additional types, R4B: Additive associated with container (new) and R4B: item additional types

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(5.0.0)	A homogeneous material with a definite composition
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
instance	?!Σ	1..1	boolean	Is this an instance of a substance or a kind of one
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:identifier		0..1	Identifier	R4B: Identifier of the package/container (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.identifier Constraints: ext-1
extension:expiry		0..1	dateTime	R4B: When no longer valid to use (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.expiry Constraints: ext-1
extension:quantity		0..1	SimpleQuantity(5.0.0)	R4B: Amount of substance in the package (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.quantity Constraints: ext-1
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	CodeableReference(SubstanceDefinition)	What substance this is Binding: SubstanceCode (example): Substance codes.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Substance.status	Base	required	FHIRSubstanceStatus	📍5.0.0	FHIR Std.
Substance.code	Base	example	Substance Code	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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	Substance.implicitRules, Substance.modifierExtension, Substance.instance, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, Substance.status, Substance.code	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Substance.modifierExtension, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity	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(5.0.0)	A homogeneous material with a definite composition
instance
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier		0..1	Identifier	R4B: Identifier of the package/container (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.identifier
extension:expiry		0..1	dateTime	R4B: When no longer valid to use (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.expiry
extension:quantity		0..1	SimpleQuantity(5.0.0)	R4B: Amount of substance in the package (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.quantity
status
​ Slices for modifierExtension		0..*		Slice: Unordered, Open by value:url
​ modifierExtension:status		0..1	code	R4B: status URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact.
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance(5.0.0)	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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Unique identifier
instance	?!Σ	1..1	boolean	Is this an instance of a substance or a kind of one
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:identifier		0..1	Identifier	R4B: Identifier of the package/container (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.identifier Constraints: ext-1
extension:expiry		0..1	dateTime	R4B: When no longer valid to use (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.expiry Constraints: ext-1
extension:quantity		0..1	SimpleQuantity(5.0.0)	R4B: Amount of substance in the package (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.quantity Constraints: ext-1
value		0..1	boolean	Primitive value for boolean
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
value		0..1	code	Primitive value for code
category	Σ	0..*	CodeableConcept	What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
code	Σ	1..1	CodeableReference(SubstanceDefinition)	What substance this is Binding: SubstanceCode (example): Substance codes.
description	Σ	0..1	markdown	Textual description of the substance, comments
expiry	Σ	0..1	dateTime	When no longer valid to use
quantity	Σ	0..1	SimpleQuantity(5.0.0)	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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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	required	All Languages	📍5.0.0	FHIR Std.
Substance.status	Base	required	FHIRSubstanceStatus	📍5.0.0	FHIR Std.
Substance.category	Base	extensible	Substance Category Codes	📍5.0.0	FHIR Std.
Substance.code	Base	example	Substance Code	📍5.0.0	FHIR Std.
Substance.ingredient.​substance[x]	Base	example	Substance Code	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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	Substance.meta, Substance.implicitRules, Substance.language, Substance.text, Substance.extension, Substance.modifierExtension, Substance.identifier, Substance.instance, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, Substance.status, Substance.status.extension, Substance.category, Substance.code, Substance.description, Substance.expiry, Substance.quantity, Substance.ingredient, Substance.ingredient.extension, Substance.ingredient.modifierExtension, Substance.ingredient.quantity, Substance.ingredient.substance[x]	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Substance.extension, Substance.modifierExtension, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, Substance.status.extension, Substance.ingredient.extension, Substance.ingredient.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Substance

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.identifier|0.1.0
• http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.expiry|0.1.0
• http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.quantity|0.1.0
• http://hl7.org/fhir/StructureDefinition/artifact-status|5.2.0 (Modifier)

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance(5.0.0)	A homogeneous material with a definite composition
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
instance	?!Σ	1..1	boolean	Is this an instance of a substance or a kind of one
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:identifier		0..1	Identifier	R4B: Identifier of the package/container (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.identifier Constraints: ext-1
extension:expiry		0..1	dateTime	R4B: When no longer valid to use (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.expiry Constraints: ext-1
extension:quantity		0..1	SimpleQuantity(5.0.0)	R4B: Amount of substance in the package (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.quantity Constraints: ext-1
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	CodeableReference(SubstanceDefinition)	What substance this is Binding: SubstanceCode (example): Substance codes.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Substance.status	Base	required	FHIRSubstanceStatus	📍5.0.0	FHIR Std.
Substance.code	Base	example	Substance Code	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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	Substance.implicitRules, Substance.modifierExtension, Substance.instance, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, Substance.status, Substance.code	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Substance.modifierExtension, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity	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(5.0.0)	A homogeneous material with a definite composition
instance
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier		0..1	Identifier	R4B: Identifier of the package/container (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.identifier
extension:expiry		0..1	dateTime	R4B: When no longer valid to use (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.expiry
extension:quantity		0..1	SimpleQuantity(5.0.0)	R4B: Amount of substance in the package (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.quantity
status
​ Slices for modifierExtension		0..*		Slice: Unordered, Open by value:url
​ modifierExtension:status		0..1	code	R4B: status URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact.
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Substance		0..*	Substance(5.0.0)	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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Unique identifier
instance	?!Σ	1..1	boolean	Is this an instance of a substance or a kind of one
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:identifier		0..1	Identifier	R4B: Identifier of the package/container (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.identifier Constraints: ext-1
extension:expiry		0..1	dateTime	R4B: When no longer valid to use (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.expiry Constraints: ext-1
extension:quantity		0..1	SimpleQuantity(5.0.0)	R4B: Amount of substance in the package (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.quantity Constraints: ext-1
value		0..1	boolean	Primitive value for boolean
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
value		0..1	code	Primitive value for code
category	Σ	0..*	CodeableConcept	What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
code	Σ	1..1	CodeableReference(SubstanceDefinition)	What substance this is Binding: SubstanceCode (example): Substance codes.
description	Σ	0..1	markdown	Textual description of the substance, comments
expiry	Σ	0..1	dateTime	When no longer valid to use
quantity	Σ	0..1	SimpleQuantity(5.0.0)	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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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	required	All Languages	📍5.0.0	FHIR Std.
Substance.status	Base	required	FHIRSubstanceStatus	📍5.0.0	FHIR Std.
Substance.category	Base	extensible	Substance Category Codes	📍5.0.0	FHIR Std.
Substance.code	Base	example	Substance Code	📍5.0.0	FHIR Std.
Substance.ingredient.​substance[x]	Base	example	Substance Code	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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	Substance.meta, Substance.implicitRules, Substance.language, Substance.text, Substance.extension, Substance.modifierExtension, Substance.identifier, Substance.instance, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, Substance.status, Substance.status.extension, Substance.category, Substance.code, Substance.description, Substance.expiry, Substance.quantity, Substance.ingredient, Substance.ingredient.extension, Substance.ingredient.modifierExtension, Substance.ingredient.quantity, Substance.ingredient.substance[x]	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Substance.extension, Substance.modifierExtension, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, Substance.status.extension, Substance.ingredient.extension, Substance.ingredient.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Substance

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.identifier|0.1.0
• http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.expiry|0.1.0
• http://hl7.org/fhir/4.3/StructureDefinition/extension-Substance.instance.quantity|0.1.0
• http://hl7.org/fhir/StructureDefinition/artifact-status|5.2.0 (Modifier)

Maturity: 0

Other representations of profile: CSV, Excel, Schematron