Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

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

Resource Profile: Profile_R3_Substance_R4B

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

This cross-version profile allows STU3 Substance content to be represented via FHIR R4B 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.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.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status ?! 0..1 code STU3: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Constraints: ext-1

doco 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.status.extension, Substance.status.extension:status, Substance.code All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Substance.modifierExtension, Substance.status.extension, Substance.status.extension:status 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.3.0) A homogeneous material with a definite composition
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code STU3: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... instance
.... identifier
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.instance.identifier
... ingredient
.... quantity
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:quantity 0..1 Ratio STU3: quantity additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.ingredient.quantity
.... substanceReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..1 Reference(Resource) STU3: substance additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status ?! 0..1 code STU3: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.instance.identifier
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... 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)
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:quantity 0..1 Ratio STU3: quantity additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.ingredient.quantity
Constraints: ext-1
..... numerator Σ 0..1 Quantity Numerator value
..... denominator Σ 0..1 Quantity Denominator value
.... substance[x] Σ 1..1 A component of the substance
Binding: SubstanceCode (example): Substance Ingredient codes.
..... substance[x]All Types Content/Rules for all Types
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:alternateReference 0..1 Reference(Resource) STU3: substance additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Substance.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Substance.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Substance.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Substance.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Substance.identifier.​type Base extensible IdentifierType 📍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.instance.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Substance.instance.identifier.​type Base extensible IdentifierType 📍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.meta.extension, Substance.meta.extension:meta, Substance.meta.versionId, Substance.meta.lastUpdated, Substance.meta.source, Substance.meta.profile, Substance.meta.security, Substance.meta.tag, Substance.implicitRules, Substance.language, Substance.text, Substance.text.extension, Substance.text.extension:text, Substance.text.status, Substance.text.div, Substance.extension, Substance.modifierExtension, Substance.identifier, Substance.identifier.extension, Substance.identifier.extension:identifier, Substance.identifier.use, Substance.identifier.type, Substance.identifier.system, Substance.identifier.value, Substance.identifier.period, Substance.identifier.assigner, Substance.status, Substance.status.extension, Substance.status.extension:status, Substance.category, Substance.code, Substance.description, Substance.instance, Substance.instance.extension, Substance.instance.modifierExtension, Substance.instance.identifier, Substance.instance.identifier.extension, Substance.instance.identifier.extension:identifier, Substance.instance.identifier.use, Substance.instance.identifier.type, Substance.instance.identifier.system, Substance.instance.identifier.value, Substance.instance.identifier.period, Substance.instance.identifier.assigner, Substance.instance.expiry, Substance.instance.quantity, Substance.ingredient, Substance.ingredient.extension, Substance.ingredient.modifierExtension, Substance.ingredient.quantity, Substance.ingredient.quantity.extension, Substance.ingredient.quantity.extension:quantity, Substance.ingredient.quantity.numerator, Substance.ingredient.quantity.denominator, Substance.ingredient.substance[x], Substance.ingredient.substance[x].extension, Substance.ingredient.substance[x].extension:alternateReference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Substance.meta.extension, Substance.meta.extension:meta, Substance.text.extension, Substance.text.extension:text, Substance.extension, Substance.modifierExtension, Substance.identifier.extension, Substance.identifier.extension:identifier, Substance.status.extension, Substance.status.extension:status, Substance.instance.extension, Substance.instance.modifierExtension, Substance.instance.identifier.extension, Substance.instance.identifier.extension:identifier, Substance.ingredient.extension, Substance.ingredient.modifierExtension, Substance.ingredient.quantity.extension, Substance.ingredient.quantity.extension:quantity, Substance.ingredient.substance[x].extension, Substance.ingredient.substance[x].extension:alternateReference Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Substance.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Substance.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status ?! 0..1 code STU3: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Constraints: ext-1

doco 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.status.extension, Substance.status.extension:status, Substance.code All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Substance.modifierExtension, Substance.status.extension, Substance.status.extension:status 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.3.0) A homogeneous material with a definite composition
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code STU3: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... instance
.... identifier
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.instance.identifier
... ingredient
.... quantity
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:quantity 0..1 Ratio STU3: quantity additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.ingredient.quantity
.... substanceReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..1 Reference(Resource) STU3: substance additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status ?! 0..1 code STU3: status
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.instance.identifier
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... 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)
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:quantity 0..1 Ratio STU3: quantity additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Substance.ingredient.quantity
Constraints: ext-1
..... numerator Σ 0..1 Quantity Numerator value
..... denominator Σ 0..1 Quantity Denominator value
.... substance[x] Σ 1..1 A component of the substance
Binding: SubstanceCode (example): Substance Ingredient codes.
..... substance[x]All Types Content/Rules for all Types
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:alternateReference 0..1 Reference(Resource) STU3: substance additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Substance.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Substance.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Substance.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Substance.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Substance.identifier.​type Base extensible IdentifierType 📍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.instance.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Substance.instance.identifier.​type Base extensible IdentifierType 📍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.meta.extension, Substance.meta.extension:meta, Substance.meta.versionId, Substance.meta.lastUpdated, Substance.meta.source, Substance.meta.profile, Substance.meta.security, Substance.meta.tag, Substance.implicitRules, Substance.language, Substance.text, Substance.text.extension, Substance.text.extension:text, Substance.text.status, Substance.text.div, Substance.extension, Substance.modifierExtension, Substance.identifier, Substance.identifier.extension, Substance.identifier.extension:identifier, Substance.identifier.use, Substance.identifier.type, Substance.identifier.system, Substance.identifier.value, Substance.identifier.period, Substance.identifier.assigner, Substance.status, Substance.status.extension, Substance.status.extension:status, Substance.category, Substance.code, Substance.description, Substance.instance, Substance.instance.extension, Substance.instance.modifierExtension, Substance.instance.identifier, Substance.instance.identifier.extension, Substance.instance.identifier.extension:identifier, Substance.instance.identifier.use, Substance.instance.identifier.type, Substance.instance.identifier.system, Substance.instance.identifier.value, Substance.instance.identifier.period, Substance.instance.identifier.assigner, Substance.instance.expiry, Substance.instance.quantity, Substance.ingredient, Substance.ingredient.extension, Substance.ingredient.modifierExtension, Substance.ingredient.quantity, Substance.ingredient.quantity.extension, Substance.ingredient.quantity.extension:quantity, Substance.ingredient.quantity.numerator, Substance.ingredient.quantity.denominator, Substance.ingredient.substance[x], Substance.ingredient.substance[x].extension, Substance.ingredient.substance[x].extension:alternateReference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Substance.meta.extension, Substance.meta.extension:meta, Substance.text.extension, Substance.text.extension:text, Substance.extension, Substance.modifierExtension, Substance.identifier.extension, Substance.identifier.extension:identifier, Substance.status.extension, Substance.status.extension:status, Substance.instance.extension, Substance.instance.modifierExtension, Substance.instance.identifier.extension, Substance.instance.identifier.extension:identifier, Substance.ingredient.extension, Substance.ingredient.modifierExtension, Substance.ingredient.quantity.extension, Substance.ingredient.quantity.extension:quantity, Substance.ingredient.substance[x].extension, Substance.ingredient.substance[x].extension:alternateReference Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Substance.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Substance.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron