Australian Base Implementation Guide (AU Base 1.1.1)
This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions 
AU Base Substance [DRAFT 0]
This profile defines a substance structure including core localisation concepts for use in an Australian context.
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-substance
This profile defines a substance structure including core localisation concepts for use in an Australian context.
This profile builds on Substance.
This profile was published on Fri Aug 16 00:00:00 AEST 2019 as a draft by Health Level Seven Australia.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Substance | 0..* | Substance | A substance in an Australian healthcare context | |
  code | 1..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | |
 ingredient | 0..* | BackboneElement | ||
  substance[x] | 1..1 | (Slice Definition) | Slice: Unordered, Closed by type:$this | |
  substance[x]:substanceCodeableConcept | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | |
 substance[x]:substanceReference | 0..1 | Reference(AU Base Substance) | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | I | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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) |
| category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: Substance Category Codes (extensible) |
| 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 | ΣI | 0..* | BackboneElement | If this describes a specific package/container of the substance |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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 | ΣI | 0..* | BackboneElement | Composition information about the substance |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| quantity | Σ | 0..1 | Ratio | Optional amount (concentration) |
| substance[x] | Σ | 1..1 | (Slice Definition) | A component of the substance Slice: Unordered, Closed by type:$this Binding: Substance Code (example) |
| substanceCodeableConcept | CodeableConcept | |||
 substanceReference | Reference(Substance) | |||
| substance[x]:substanceCodeableConcept | Σ | 0..1 | CodeableConcept | A component of the substance Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) |
| substance[x]:substanceReference | Σ | 0..1 | Reference(AU Base Substance) | A component of the substance |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A substance in an Australian healthcare context | |
| code | 1..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | |
| ingredient | 0..* | BackboneElement | ||
| substance[x] | 1..1 | (Slice Definition) | Slice: Unordered, Closed by type:$this | |
| substance[x]:substanceCodeableConcept | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) | |
| substance[x]:substanceReference | 0..1 | Reference(AU Base Substance) | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | I | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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) |
| category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: Substance Category Codes (extensible) |
| 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 | ΣI | 0..* | BackboneElement | If this describes a specific package/container of the substance |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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 | ΣI | 0..* | BackboneElement | Composition information about the substance |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| quantity | Σ | 0..1 | Ratio | Optional amount (concentration) |
| substance[x] | Σ | 1..1 | (Slice Definition) | A component of the substance Slice: Unordered, Closed by type:$this Binding: Substance Code (example) |
| substanceCodeableConcept | CodeableConcept | |||
| substanceReference | Reference(Substance) | |||
| substance[x]:substanceCodeableConcept | Σ | 0..1 | CodeableConcept | A component of the substance Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred) |
| substance[x]:substanceReference | Σ | 0..1 | Reference(AU Base Substance) | A component of the substance |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-substance
none defined
© AU Base 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
