Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

StructureDefinition: ADHA Core Substance [Active]

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

Profile specific guidance

None.

Boundaries and relationships

This profile is referenced by ADHA Core Medication.

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-substance-core-1

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 builds on AUBaseSubstance.

This profile was published on 2023-08-07 09:41:43+1000 as a active by Australian Digital Health Agency.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*AUBaseSubstanceA substance in an Australian healthcare context
... identifier S0..*IdentifierUnique identifier
... category S0..*CodeableConceptWhat class/type of substance this is
... code S1..1CodeableConceptWhat substance this is
... description S0..1stringTextual description of the substance, comments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*AUBaseSubstanceA substance in an Australian healthcare context
... id Σ0..1idLogical 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 SΣ0..*IdentifierUnique identifier
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

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


... code SΣ1..1CodeableConceptWhat substance this is
Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
... description SΣ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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*AUBaseSubstanceA substance in an Australian healthcare context
... identifier S0..*IdentifierUnique identifier
... category S0..*CodeableConceptWhat class/type of substance this is
... code S1..1CodeableConceptWhat substance this is
... description S0..1stringTextual description of the substance, comments

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*AUBaseSubstanceA substance in an Australian healthcare context
... id Σ0..1idLogical 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 SΣ0..*IdentifierUnique identifier
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

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


... code SΣ1..1CodeableConceptWhat substance this is
Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
... description SΣ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

 

Terminology Bindings

PathConformanceValueSet
Substance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Substance.statusrequiredFHIRSubstanceStatus
Substance.categoryextensibleSubstanceCategoryCodes
Substance.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/substance-1
Substance.ingredient.substance[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/substance-1

Search Parameters

None defined.