Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
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
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-substance-core-1 | Version: 1.0.0 | |||
| Active as of 2024-12-19 | 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:
This profile may be referred to by APIs, which will be listed here when available.
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseSubstance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 |
 description |
S | 0..1 | string | Textual description of the substance, comments |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance |
0..* | AUBaseSubstance | A substance in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 identifier |
SΣ | 0..* | Identifier | Unique identifier ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. ele-1: All FHIR elements must have a @value or children |
| category |
SΣ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. ele-1: All FHIR elements must have a @value or children |
| code |
SΣ | 1..1 | CodeableConcept | What substance this is Binding: Substance  (preferred)ele-1: All FHIR elements must have a @value or children |
| description |
SΣ | 0..1 | string | Textual description of the substance, comments ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1from the FHIR Standard | |
| Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-categoryfrom the FHIR Standard | |
| Substance.code | preferred | Substance https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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) | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Substance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1from the FHIR Standard | ||||
| Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-categoryfrom the FHIR Standard | ||||
| Substance.code | preferred | Substance https://healthterminologies.gov.au/fhir/ValueSet/substance-1 | ||||
| Substance.ingredient.substance[x] | preferred | Substance https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
This structure is derived from AUBaseSubstance
Differential View
This structure is derived from AUBaseSubstance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| description |
S | 0..1 | string | Textual description of the substance, comments |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance |
0..* | AUBaseSubstance | A substance in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
SΣ | 0..* | Identifier | Unique identifier ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. ele-1: All FHIR elements must have a @value or children |
| category |
SΣ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. ele-1: All FHIR elements must have a @value or children |
| code |
SΣ | 1..1 | CodeableConcept | What substance this is Binding: Substance (preferred)ele-1: All FHIR elements must have a @value or children |
| description |
SΣ | 0..1 | string | Textual description of the substance, comments ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1from the FHIR Standard | |
| Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-categoryfrom the FHIR Standard | |
| Substance.code | preferred | Substance https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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) | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Substance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1from the FHIR Standard | ||||
| Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-categoryfrom the FHIR Standard | ||||
| Substance.code | preferred | Substance https://healthterminologies.gov.au/fhir/ValueSet/substance-1 | ||||
| Substance.ingredient.substance[x] | preferred | Substance https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
This structure is derived from AUBaseSubstance
Other representations of profile: CSV, Excel, Schematron
No mandatory or optional search parameters for ADHA Core Substance profile.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-12-19
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
