AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base Substance

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-substance Version: 7.0.0-ci-build
Standards status: Trial-use Maturity Level: 1 Computable Name: AUBaseSubstance

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a substance structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • No changes

    • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Substance 0..* Substance A substance in an Australian healthcare context
    Substance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Substance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Substance.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive | entered-in-error
    Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
    Substance.code This element is included in summaries. 1..1 CodeableConcept What substance this is
    Binding: Substance (preferred)

    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 preferred Substance ⏿1.0.1 tx.hl7.org.au

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

    This structure is derived from Substance

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Substance 0..* Substance A substance in an Australian healthcare context
    Substance.code 1..1 CodeableConcept What substance this is
    Binding: Substance (preferred)
    Substance.ingredient
    Substance.ingredient.substance[x] 1..1 A component of the substance
    Binding: Substance (preferred)
    Substance.ingredient.substance[x].substanceCodeableConcept CodeableConcept
    Substance.ingredient.substance[x].substanceReference Reference(Substance)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Substance.code Base preferred Substance ⏿1.0.1 tx.hl7.org.au
    Substance.ingredient.​substance[x] Base preferred Substance ⏿1.0.1 tx.hl7.org.au
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Substance 0..* Substance A substance in an Australian healthcare context
    Substance.id This element is included in summaries. 0..1 id Logical id of this artifact
    Substance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Substance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Substance.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Substance.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
    Substance.contained 0..* Resource Contained, inline Resources
    Substance.extension 0..* Extension Additional content defined by implementations
    Substance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Substance.identifier This element is included in summaries. 0..* Identifier Unique identifier
    Substance.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive | entered-in-error
    Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
    Substance.category This element is included in summaries. 0..* CodeableConcept What class/type of substance this is
    Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
    Substance.code This element is included in summaries. 1..1 CodeableConcept What substance this is
    Binding: Substance (preferred)
    Substance.description This element is included in summaries. 0..1 string Textual description of the substance, comments
    Substance.instance This element is included in summaries. 0..* BackboneElement If this describes a specific package/container of the substance
    Substance.instance.id 0..1 string Unique id for inter-element referencing
    Substance.instance.extension 0..* Extension Additional content defined by implementations
    Substance.instance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Substance.instance.identifier This element is included in summaries. 0..1 Identifier Identifier of the package/container
    Substance.instance.expiry This element is included in summaries. 0..1 dateTime When no longer valid to use
    Substance.instance.quantity This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Amount of substance in the package
    Constraints: sqty-1
    Substance.ingredient This element is included in summaries. 0..* BackboneElement Composition information about the substance
    Substance.ingredient.id 0..1 string Unique id for inter-element referencing
    Substance.ingredient.extension 0..* Extension Additional content defined by implementations
    Substance.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Substance.ingredient.quantity This element is included in summaries. 0..1 Ratio Optional amount (concentration)
    Substance.ingredient.substance[x] This element is included in summaries. 1..1 A component of the substance
    Binding: Substance (preferred)
    Substance.ingredient.substance[x].substanceCodeableConcept CodeableConcept
    Substance.ingredient.substance[x].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 FHIR Std.
    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 preferred Substance ⏿1.0.1 tx.hl7.org.au
    Substance.ingredient.​substance[x] Base preferred Substance ⏿1.0.1 tx.hl7.org.au

    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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    sqty-1 error Substance.instance.quantity The comparator is not used on a SimpleQuantity comparator.empty()

    This structure is derived from Substance

    Summary

    Maturity: 1

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Substance 0..* Substance A substance in an Australian healthcare context
    Substance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Substance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Substance.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive | entered-in-error
    Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
    Substance.code This element is included in summaries. 1..1 CodeableConcept What substance this is
    Binding: Substance (preferred)

    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 preferred Substance ⏿1.0.1 tx.hl7.org.au

    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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions 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: doco
    Substance 0..* Substance A substance in an Australian healthcare context
    Substance.code 1..1 CodeableConcept What substance this is
    Binding: Substance (preferred)
    Substance.ingredient
    Substance.ingredient.substance[x] 1..1 A component of the substance
    Binding: Substance (preferred)
    Substance.ingredient.substance[x].substanceCodeableConcept CodeableConcept
    Substance.ingredient.substance[x].substanceReference Reference(Substance)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Substance.code Base preferred Substance ⏿1.0.1 tx.hl7.org.au
    Substance.ingredient.​substance[x] Base preferred Substance ⏿1.0.1 tx.hl7.org.au

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Substance 0..* Substance A substance in an Australian healthcare context
    Substance.id This element is included in summaries. 0..1 id Logical id of this artifact
    Substance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Substance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Substance.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Substance.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
    Substance.contained 0..* Resource Contained, inline Resources
    Substance.extension 0..* Extension Additional content defined by implementations
    Substance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Substance.identifier This element is included in summaries. 0..* Identifier Unique identifier
    Substance.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive | entered-in-error
    Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
    Substance.category This element is included in summaries. 0..* CodeableConcept What class/type of substance this is
    Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
    Substance.code This element is included in summaries. 1..1 CodeableConcept What substance this is
    Binding: Substance (preferred)
    Substance.description This element is included in summaries. 0..1 string Textual description of the substance, comments
    Substance.instance This element is included in summaries. 0..* BackboneElement If this describes a specific package/container of the substance
    Substance.instance.id 0..1 string Unique id for inter-element referencing
    Substance.instance.extension 0..* Extension Additional content defined by implementations
    Substance.instance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Substance.instance.identifier This element is included in summaries. 0..1 Identifier Identifier of the package/container
    Substance.instance.expiry This element is included in summaries. 0..1 dateTime When no longer valid to use
    Substance.instance.quantity This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Amount of substance in the package
    Constraints: sqty-1
    Substance.ingredient This element is included in summaries. 0..* BackboneElement Composition information about the substance
    Substance.ingredient.id 0..1 string Unique id for inter-element referencing
    Substance.ingredient.extension 0..* Extension Additional content defined by implementations
    Substance.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Substance.ingredient.quantity This element is included in summaries. 0..1 Ratio Optional amount (concentration)
    Substance.ingredient.substance[x] This element is included in summaries. 1..1 A component of the substance
    Binding: Substance (preferred)
    Substance.ingredient.substance[x].substanceCodeableConcept CodeableConcept
    Substance.ingredient.substance[x].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 FHIR Std.
    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 preferred Substance ⏿1.0.1 tx.hl7.org.au
    Substance.ingredient.​substance[x] Base preferred Substance ⏿1.0.1 tx.hl7.org.au

    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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    sqty-1 error Substance.instance.quantity The comparator is not used on a SimpleQuantity comparator.empty()

    This structure is derived from Substance

    Summary

    Maturity: 1

     

    Other representations of profile: CSV, Excel, Schematron