AU Base Implementation Guide
4.1.1-preview - Preview
AU Base Implementation Guide
4.1.1-preview - Preview
This page is part of the AU Base Implementation Guide 4.1.1-preview based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-substance | Version: 4.1.1-preview | |||
| Standards status: Trial-use | Maturity Level: 0 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Substance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Substance | 0..* | Substance | A substance in an Australian healthcare context | |
  code | 1..1 | CodeableConcept | What substance this is Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | |
 ingredient | ||||
  substance[x] | 1..1 | A component of the substance Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | ||
 substanceCodeableConcept | CodeableConcept | |||
  substanceReference | Reference(Substance) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
| Substance.ingredient.substance[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | Σ | 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: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (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 | 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: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | |||||
| substanceCodeableConcept | CodeableConcept | |||||||
| substanceReference | Reference(Substance) | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Substance.language | preferred | CommonLanguages
| ||||
| Substance.status | required | FHIRSubstanceStatus | ||||
| Substance.category | extensible | SubstanceCategoryCodes | ||||
| Substance.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 | ||||
| Substance.ingredient.substance[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 |
|---|---|---|---|---|
| Substance | 0..* | Substance | A substance in an Australian healthcare context | |
| code | 1..1 | CodeableConcept | What substance this is Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | |
| ingredient | ||||
| substance[x] | 1..1 | A component of the substance Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | ||
| substanceCodeableConcept | CodeableConcept | |||
| substanceReference | Reference(Substance) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
| Substance.ingredient.substance[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | Σ | 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: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (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 | 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: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | |||||
| substanceCodeableConcept | CodeableConcept | |||||||
| substanceReference | Reference(Substance) | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Substance.language | preferred | CommonLanguages
| ||||
| Substance.status | required | FHIRSubstanceStatus | ||||
| Substance.category | extensible | SubstanceCategoryCodes | ||||
| Substance.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 | ||||
| Substance.ingredient.substance[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/substance-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Other representations of profile: CSV, Excel, Schematron
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.1-preview based on FHIR 4.0.1. Generated 2023-08-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change