Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

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

Resource Profile: Profile_R5_Substance_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Substance Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_Substance_R4

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

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance(4.0.1) 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.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 Reference(Cross-version Profile for R5.SubstanceDefinition for use in FHIR R4(0.1.0) | SubstanceSpecification) R5: code additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Substance.code
Constraints: ext-1

doco 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 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 Substance.implicitRules, Substance.modifierExtension, Substance.status, Substance.code, Substance.code.extension, Substance.code.extension:code All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Substance.modifierExtension, Substance.code.extension, Substance.code.extension:code Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Substance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance(4.0.1) A homogeneous material with a definite composition
... status
​.... Slices for modifierExtension 0..* Slice: Unordered, Open by value:url
​..... modifierExtension:status 0..1 code R5: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... code
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 0..1 Reference(Cross-version Profile for R5.SubstanceDefinition for use in FHIR R4(0.1.0) | SubstanceSpecification) R5: code additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Substance.code

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance(4.0.1) 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
... 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
... 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 string 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.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 Reference(Cross-version Profile for R5.SubstanceDefinition for use in FHIR R4(0.1.0) | SubstanceSpecification) R5: code additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Substance.code
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... 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.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
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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
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 example Substance Code 📍4.0.1 FHIR Std.
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 Substance.meta, Substance.implicitRules, Substance.language, Substance.text, Substance.extension, Substance.modifierExtension, Substance.identifier, Substance.status, Substance.status.extension, Substance.category, Substance.code, Substance.code.extension, Substance.code.extension:code, Substance.code.coding, Substance.code.text, 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.code.extension, Substance.code.extension:code, 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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance(4.0.1) 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.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 Reference(Cross-version Profile for R5.SubstanceDefinition for use in FHIR R4(0.1.0) | SubstanceSpecification) R5: code additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Substance.code
Constraints: ext-1

doco 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 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 Substance.implicitRules, Substance.modifierExtension, Substance.status, Substance.code, Substance.code.extension, Substance.code.extension:code All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Substance.modifierExtension, Substance.code.extension, Substance.code.extension:code Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Substance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance(4.0.1) A homogeneous material with a definite composition
... status
​.... Slices for modifierExtension 0..* Slice: Unordered, Open by value:url
​..... modifierExtension:status 0..1 code R5: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... code
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 0..1 Reference(Cross-version Profile for R5.SubstanceDefinition for use in FHIR R4(0.1.0) | SubstanceSpecification) R5: code additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Substance.code

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance(4.0.1) 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
... 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
... 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 string 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.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 Reference(Cross-version Profile for R5.SubstanceDefinition for use in FHIR R4(0.1.0) | SubstanceSpecification) R5: code additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Substance.code
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... 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.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
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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
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 example Substance Code 📍4.0.1 FHIR Std.
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 Substance.meta, Substance.implicitRules, Substance.language, Substance.text, Substance.extension, Substance.modifierExtension, Substance.identifier, Substance.status, Substance.status.extension, Substance.category, Substance.code, Substance.code.extension, Substance.code.extension:code, Substance.code.coding, Substance.code.text, 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.code.extension, Substance.code.extension:code, 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

 

Other representations of profile: CSV, Excel, Schematron