Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Core Substance

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-substance-core-1 Version: 1.0.0
Active as of 2024-09-12 Computable Name: ADHASubstanceCore

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to provide a core representation of a substance for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend Substance that are supported.

A Substance resource is used within the context of a referencing resource: Medication or Substance resource.

This profile is designed to set a core Substance standard in the context of:

  • Querying substances referenced in Medication resources
  • Recording or updating a substance referenced by a Medication resource

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

None.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseSubstance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* AUBaseSubstance A substance in an Australian healthcare context
... identifier S 0..* Identifier Unique identifier
... category S 0..* CodeableConcept What class/type of substance this is
... code S 1..1 CodeableConcept What substance this is

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* AUBaseSubstance A substance in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier
... category SΣ 0..* CodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code SΣ 1..1 CodeableConcept What substance this is
Binding: Substance . (preferred)
... description SΣ 0..1 string Textual description of the substance, comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|4.0.1
from the FHIR Standard
Substance.categoryextensibleSubstanceCategoryCodes
http://hl7.org/fhir/ValueSet/substance-category
from the FHIR Standard
Substance.codepreferredSubstance .
https://healthterminologies.gov.au/fhir/ValueSet/substance-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* AUBaseSubstance A substance in an Australian healthcare context
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

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


... code SΣ 1..1 CodeableConcept What substance this is
Binding: Substance . (preferred)
... description SΣ 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..1 Identifier Identifier of the package/container
.... expiry Σ 0..1 dateTime When no longer valid to use
.... quantity Σ 0..1 SimpleQuantity 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity Σ 0..1 Ratio Optional amount (concentration)
.... substance[x] Σ 1..1 A component of the substance
Binding: Substance . (preferred)
..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|4.0.1
from the FHIR Standard
Substance.categoryextensibleSubstanceCategoryCodes
http://hl7.org/fhir/ValueSet/substance-category
from the FHIR Standard
Substance.codepreferredSubstance .
https://healthterminologies.gov.au/fhir/ValueSet/substance-1
Substance.ingredient.substance[x]preferredSubstance .
https://healthterminologies.gov.au/fhir/ValueSet/substance-1

This structure is derived from AUBaseSubstance

Summary

Must-Support: 4 elements

Differential View

This structure is derived from AUBaseSubstance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* AUBaseSubstance A substance in an Australian healthcare context
... identifier S 0..* Identifier Unique identifier
... category S 0..* CodeableConcept What class/type of substance this is
... code S 1..1 CodeableConcept What substance this is

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* AUBaseSubstance A substance in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier
... category SΣ 0..* CodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code SΣ 1..1 CodeableConcept What substance this is
Binding: Substance . (preferred)
... description SΣ 0..1 string Textual description of the substance, comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|4.0.1
from the FHIR Standard
Substance.categoryextensibleSubstanceCategoryCodes
http://hl7.org/fhir/ValueSet/substance-category
from the FHIR Standard
Substance.codepreferredSubstance .
https://healthterminologies.gov.au/fhir/ValueSet/substance-1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* AUBaseSubstance A substance in an Australian healthcare context
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

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


... code SΣ 1..1 CodeableConcept What substance this is
Binding: Substance . (preferred)
... description SΣ 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..1 Identifier Identifier of the package/container
.... expiry Σ 0..1 dateTime When no longer valid to use
.... quantity Σ 0..1 SimpleQuantity 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity Σ 0..1 Ratio Optional amount (concentration)
.... substance[x] Σ 1..1 A component of the substance
Binding: Substance . (preferred)
..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|4.0.1
from the FHIR Standard
Substance.categoryextensibleSubstanceCategoryCodes
http://hl7.org/fhir/ValueSet/substance-category
from the FHIR Standard
Substance.codepreferredSubstance .
https://healthterminologies.gov.au/fhir/ValueSet/substance-1
Substance.ingredient.substance[x]preferredSubstance .
https://healthterminologies.gov.au/fhir/ValueSet/substance-1

This structure is derived from AUBaseSubstance

Summary

Must-Support: 4 elements

 

Other representations of profile: CSV, Excel, Schematron

Notes:

No mandatory or optional search parameters for ADHA Core Substance profile.