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

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: Profile_R4_Substance_R4B

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

Usages:

• Refer to this Profile: R4: Information about the use of the medicinal product in relation to other therapies described as part of the indication (new), R4: Information about the use of the medicinal product in relation to other therapies described as part of the indication (new), R4: The specific medication, food or laboratory test that interacts (new) and R4: A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol) (new)

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(4.3.0)	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 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	CodeableConcept	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	📍4.3.0	FHIR Std.
Substance.code	Base	example	Substance Code	📍4.3.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.exists() and ('#'+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(uri) = '#').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.status, Substance.code	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Substance.modifierExtension	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(4.3.0)	A homogeneous material with a definite composition
status
​ Slices for modifierExtension		0..*		Slice: Unordered, Open by value:url
​ modifierExtension:status		0..1	code	R4: 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(4.3.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: CommonLanguages (preferred): IETF language tag 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 Constraints: dom-r4b
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
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	CodeableConcept	What substance this is Binding: SubstanceCode (example): Substance codes.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
identifier	Σ	0..1	Identifier	Identifier of the package/container
expiry	Σ	0..1	dateTime	When no longer valid to use
quantity	Σ	0..1	SimpleQuantity(4.3.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	preferred	Common Languages	📍4.3.0	FHIR Std.
Substance.status	Base	required	FHIRSubstanceStatus	📍4.3.0	FHIR Std.
Substance.category	Base	extensible	Substance Category Codes	📍4.3.0	FHIR Std.
Substance.code	Base	example	Substance Code	📍4.3.0	FHIR Std.
Substance.ingredient.​substance[x]	Base	example	Substance Code	📍4.3.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.exists() and ('#'+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(uri) = '#').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()
dom-r4b	warning	Substance.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems	($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1	error	Substance.meta, Substance.implicitRules, Substance.language, Substance.text, Substance.extension, Substance.modifierExtension, Substance.identifier, Substance.status, Substance.status.extension, Substance.category, Substance.code, Substance.description, Substance.instance, Substance.instance.extension, Substance.instance.modifierExtension, Substance.instance.identifier, Substance.instance.expiry, Substance.instance.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.status.extension, Substance.instance.extension, Substance.instance.modifierExtension, 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/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(4.3.0)	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 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	CodeableConcept	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	📍4.3.0	FHIR Std.
Substance.code	Base	example	Substance Code	📍4.3.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.exists() and ('#'+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(uri) = '#').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.status, Substance.code	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Substance.modifierExtension	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(4.3.0)	A homogeneous material with a definite composition
status
​ Slices for modifierExtension		0..*		Slice: Unordered, Open by value:url
​ modifierExtension:status		0..1	code	R4: 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(4.3.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: CommonLanguages (preferred): IETF language tag 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 Constraints: dom-r4b
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
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	CodeableConcept	What substance this is Binding: SubstanceCode (example): Substance codes.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
identifier	Σ	0..1	Identifier	Identifier of the package/container
expiry	Σ	0..1	dateTime	When no longer valid to use
quantity	Σ	0..1	SimpleQuantity(4.3.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	preferred	Common Languages	📍4.3.0	FHIR Std.
Substance.status	Base	required	FHIRSubstanceStatus	📍4.3.0	FHIR Std.
Substance.category	Base	extensible	Substance Category Codes	📍4.3.0	FHIR Std.
Substance.code	Base	example	Substance Code	📍4.3.0	FHIR Std.
Substance.ingredient.​substance[x]	Base	example	Substance Code	📍4.3.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.exists() and ('#'+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(uri) = '#').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()
dom-r4b	warning	Substance.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems	($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1	error	Substance.meta, Substance.implicitRules, Substance.language, Substance.text, Substance.extension, Substance.modifierExtension, Substance.identifier, Substance.status, Substance.status.extension, Substance.category, Substance.code, Substance.description, Substance.instance, Substance.instance.extension, Substance.instance.modifierExtension, Substance.instance.identifier, Substance.instance.expiry, Substance.instance.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.status.extension, Substance.instance.extension, Substance.instance.modifierExtension, 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/StructureDefinition/artifact-status|5.2.0 (Modifier)

Maturity: 0

Other representations of profile: CSV, Excel, Schematron