AU Base Implementation Guide
7.0.0-ballot1 - Ballot

AU Base Implementation Guide - Downloaded Version 7.0.0-ballot1 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-ballot1
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:

- Examples for this Profile: Substance/example0 and Substance/example1

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Substance |  | 0..* | Substance | 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
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
code | Σ | 1..1 | CodeableConcept | What substance this is Binding: Substance (preferred)
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Substance |  | 0..* | Substance | A substance in an Australian healthcare context
code |  | 1..1 | CodeableConcept | What substance this is Binding: Substance (preferred)
ingredient |  |  |  |
substance[x] |  | 1..1 |  | A component of the substance Binding: Substance (preferred)
substanceCodeableConcept |  |  | CodeableConcept |
substanceReference |  |  | Reference(Substance) |
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Substance |  | 0..* | Substance | 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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 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 | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
code | Σ | 1..1 | CodeableConcept | What substance this is Binding: Substance (preferred)
description | Σ | 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(4.0.1) | 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

#### 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()`

This structure is derived from Substance

Summary

Maturity: 1

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Substance |  | 0..* | Substance | 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
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
code | Σ | 1..1 | CodeableConcept | What substance this is Binding: Substance (preferred)
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Substance |  | 0..* | Substance | A substance in an Australian healthcare context
code |  | 1..1 | CodeableConcept | What substance this is Binding: Substance (preferred)
ingredient |  |  |  |
substance[x] |  | 1..1 |  | A component of the substance Binding: Substance (preferred)
substanceCodeableConcept |  |  | CodeableConcept |
substanceReference |  |  | Reference(Substance) |
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Substance |  | 0..* | Substance | 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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 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 | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
code | Σ | 1..1 | CodeableConcept | What substance this is Binding: Substance (preferred)
description | Σ | 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(4.0.1) | 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

#### 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()`

This structure is derived from Substance

Summary

Maturity: 1

Other representations of profile: CSV, Excel, Schematron