Australian Base Implementation Guide

This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

UNTESTED
DRAFT

1.0 StructureDefinition-au-substance

AU Base Substance [DRAFT 0]

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.

Extensions

No extensions are used in this profile.

Examples

Body substance: epiglottic mucus

Allergen: peanuts

Substance with two active ingredients: Atectura Breezhaler 125/62.5

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-substance

This profile defines a substance structure that localises core concepts, including terminology, for use in an Australian context.

This profile builds on Substance.

This profile was published on 2021-12-02 as a draft by Health Level Seven Australia.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*SubstanceA substance in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... category Σ0..*CodeableConceptWhat class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code Σ1..1CodeableConceptWhat substance this is
Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
... description Σ0..1stringTextual description of the substance, comments
... instance Σ0..*BackboneElementIf this describes a specific package/container of the substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..1IdentifierIdentifier of the package/container
.... expiry Σ0..1dateTimeWhen no longer valid to use
.... quantity Σ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... quantity Σ0..1RatioOptional amount (concentration)
.... substance[x] Σ1..1A component of the substance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
..... substanceCodeableConceptCodeableConcept
..... substanceReferenceReference(Substance)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*SubstanceA substance in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... category Σ0..*CodeableConceptWhat class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code Σ1..1CodeableConceptWhat substance this is
Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
... description Σ0..1stringTextual description of the substance, comments
... instance Σ0..*BackboneElementIf this describes a specific package/container of the substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..1IdentifierIdentifier of the package/container
.... expiry Σ0..1dateTimeWhen no longer valid to use
.... quantity Σ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... quantity Σ0..1RatioOptional amount (concentration)
.... substance[x] Σ1..1A component of the substance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
..... substanceCodeableConceptCodeableConcept
..... substanceReferenceReference(Substance)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-substance

none defined

Issues & Feedback