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

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

Resource Profile: Profile_R2_Substance_R5

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

This cross-version profile allows DSTU2 Substance content to be represented via FHIR R5 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(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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..1 Identifier DSTU2: Identifier of the package/container (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.identifier
Constraints: ext-1
..... extension:expiry 0..1 dateTime DSTU2: When no longer valid to use (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.expiry
Constraints: ext-1
..... extension:quantity 0..1 SimpleQuantity(5.0.0) DSTU2: Amount of substance in the package (new)
URL: http://hl7.org/fhir/1.0/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.

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance(5.0.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 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier DSTU2: Identifier of the package/container (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.identifier
..... extension:expiry 0..1 dateTime DSTU2: When no longer valid to use (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.expiry
..... extension:quantity 0..1 SimpleQuantity(5.0.0) DSTU2: Amount of substance in the package (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.quantity
... ingredient
.... quantity
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:quantity 0..1 Ratio DSTU2: quantity additional types
URL: http://hl7.org/fhir/1.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) DSTU2: substance additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... 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 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.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: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... 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
.... 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 DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 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)
... 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 DSTU2: Identifier of the package/container (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.identifier
Constraints: ext-1
..... extension:expiry 0..1 dateTime DSTU2: When no longer valid to use (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.expiry
Constraints: ext-1
..... extension:quantity 0..1 SimpleQuantity(5.0.0) DSTU2: Amount of substance in the package (new)
URL: http://hl7.org/fhir/1.0/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.
... 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)
..... 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 DSTU2: quantity additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.ingredient.quantity
Constraints: ext-1
..... numerator ΣC 0..1 Quantity Numerator value
..... denominator ΣC 0..1 SimpleQuantity(5.0.0) 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 string 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) DSTU2: 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 All Security Labels . 📍5.0.0 tx.fhir.org
Substance.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Substance.language Base required All Languages 📍5.0.0 FHIR Std.
Substance.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Substance.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Substance.identifier.​type Base extensible Identifier Type Codes 📍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.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.instance, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, Substance.status, Substance.category, Substance.code, Substance.description, Substance.expiry, Substance.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.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, 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(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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..1 Identifier DSTU2: Identifier of the package/container (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.identifier
Constraints: ext-1
..... extension:expiry 0..1 dateTime DSTU2: When no longer valid to use (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.expiry
Constraints: ext-1
..... extension:quantity 0..1 SimpleQuantity(5.0.0) DSTU2: Amount of substance in the package (new)
URL: http://hl7.org/fhir/1.0/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.

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance(5.0.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 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier DSTU2: Identifier of the package/container (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.identifier
..... extension:expiry 0..1 dateTime DSTU2: When no longer valid to use (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.expiry
..... extension:quantity 0..1 SimpleQuantity(5.0.0) DSTU2: Amount of substance in the package (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.quantity
... ingredient
.... quantity
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:quantity 0..1 Ratio DSTU2: quantity additional types
URL: http://hl7.org/fhir/1.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) DSTU2: 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(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
.... 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 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.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: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... 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
.... 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 DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 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)
... 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 DSTU2: Identifier of the package/container (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.identifier
Constraints: ext-1
..... extension:expiry 0..1 dateTime DSTU2: When no longer valid to use (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.instance.expiry
Constraints: ext-1
..... extension:quantity 0..1 SimpleQuantity(5.0.0) DSTU2: Amount of substance in the package (new)
URL: http://hl7.org/fhir/1.0/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.
... 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)
..... 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 DSTU2: quantity additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Substance.ingredient.quantity
Constraints: ext-1
..... numerator ΣC 0..1 Quantity Numerator value
..... denominator ΣC 0..1 SimpleQuantity(5.0.0) 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 string 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) DSTU2: 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 All Security Labels . 📍5.0.0 tx.fhir.org
Substance.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Substance.language Base required All Languages 📍5.0.0 FHIR Std.
Substance.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Substance.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Substance.identifier.​type Base extensible Identifier Type Codes 📍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.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.instance, Substance.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, Substance.status, Substance.category, Substance.code, Substance.description, Substance.expiry, Substance.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.instance.extension, Substance.instance.extension:identifier, Substance.instance.extension:expiry, Substance.instance.extension:quantity, 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