AU Patient Summary Implementation Guide
0.1.0-preview - Preview
This page is part of the AU Patient Summary (v0.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication | Version: 0.1.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSMedication | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a Medication resource in the context of a patient summary in an Australian context. It is based on the AU Base Medication profile, and applies the constraints of AU Core Medication and Medication (IPS).
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseMedication
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseMedication | A medication in an Australian healthcare context This profile also complies with the profiles Medication (IPS) and AU Core Medication | |
![]() ![]() |
S | 1..1 | CodeableConceptIPS | Coding for the medicine |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required) |
![]() ![]() |
S | 0..1 | CodeableConceptIPS | powder | tablets | capsule + |
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient |
![]() ![]() ![]() |
S | 1..1 | The actual ingredient or content | |
![]() ![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||
![]() ![]() ![]() ![]() |
Reference(Substance | Medication) | |||
![]() ![]() ![]() |
S | 0..1 | Ratio | Quantity/strength of ingredient present |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
| Medication.code.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseMedication | A medication in an Australian healthcare context This profile also complies with the profiles Medication (IPS) and AU Core Medication 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 | |||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() |
?! | 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 | ||||||||||
![]() ![]() |
SΣ | 1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||
![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() |
S | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form (preferred)ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||
![]() ![]() ![]() |
S | 1..1 | The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred) ele-1: All FHIR elements must have a @value or children | |||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||
![]() ![]() ![]() ![]() |
Reference(Substance | Medication) | |||||||||||||
![]() ![]() ![]() |
S | 0..1 | Ratio | Quantity/strength of ingredient present ele-1: All FHIR elements must have a @value or children | ||||||||||
Documentation for this format | ||||||||||||||
| Path | Conformance | ValueSet | URI |
| Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| Medication.code.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
| Medication.code.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | |
| Medication.form | preferred | MedicationForm ![]() https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 | |
| Medication.ingredient.item[x] | preferred | AMTMedicinalProductAndSubstanceshttp://terminology.hl7.org.au/ValueSet/amt-mp-codes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | 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![]() | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseMedication | A medication in an Australian healthcare context This profile also complies with the profiles Medication (IPS) and AU Core Medication | |||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for this medication | ||||||||||
![]() ![]() |
SΣ | 1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required) | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Medication primary text | ||||||||||
![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Physical product manufacturer organisation | ||||||||||
![]() ![]() |
S | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form (preferred) | ||||||||||
![]() ![]() |
Σ | 0..1 | Ratio | Amount of drug in package | ||||||||||
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient | ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() |
S | 1..1 | The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred) | |||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||
![]() ![]() ![]() ![]() |
Reference(Substance | Medication) | |||||||||||||
![]() ![]() ![]() |
0..1 | boolean | Active ingredient indicator | |||||||||||
![]() ![]() ![]() |
S | 0..1 | Ratio | Quantity/strength of ingredient present | ||||||||||
![]() ![]() |
0..1 | BackboneElement | Details about packaged medications | |||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() |
0..1 | string | Identifier assigned to batch | |||||||||||
![]() ![]() ![]() |
0..1 | dateTime | When batch will expire | |||||||||||
Documentation for this format | ||||||||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| Medication.code.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | ||||
| Medication.code.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | ||||
| Medication.form | preferred | MedicationForm ![]() https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 | ||||
| Medication.ingredient.item[x] | preferred | AMTMedicinalProductAndSubstanceshttp://terminology.hl7.org.au/ValueSet/amt-mp-codes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | 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 AUBaseMedication
Differential View
This structure is derived from AUBaseMedication
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseMedication | A medication in an Australian healthcare context This profile also complies with the profiles Medication (IPS) and AU Core Medication | |
![]() ![]() |
S | 1..1 | CodeableConceptIPS | Coding for the medicine |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required) |
![]() ![]() |
S | 0..1 | CodeableConceptIPS | powder | tablets | capsule + |
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient |
![]() ![]() ![]() |
S | 1..1 | The actual ingredient or content | |
![]() ![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||
![]() ![]() ![]() ![]() |
Reference(Substance | Medication) | |||
![]() ![]() ![]() |
S | 0..1 | Ratio | Quantity/strength of ingredient present |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
| Medication.code.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseMedication | A medication in an Australian healthcare context This profile also complies with the profiles Medication (IPS) and AU Core Medication 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 | |||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() |
?! | 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 | ||||||||||
![]() ![]() |
SΣ | 1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||
![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() |
S | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form (preferred)ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||
![]() ![]() ![]() |
S | 1..1 | The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred) ele-1: All FHIR elements must have a @value or children | |||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||
![]() ![]() ![]() ![]() |
Reference(Substance | Medication) | |||||||||||||
![]() ![]() ![]() |
S | 0..1 | Ratio | Quantity/strength of ingredient present ele-1: All FHIR elements must have a @value or children | ||||||||||
Documentation for this format | ||||||||||||||
| Path | Conformance | ValueSet | URI |
| Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| Medication.code.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
| Medication.code.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | |
| Medication.form | preferred | MedicationForm ![]() https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 | |
| Medication.ingredient.item[x] | preferred | AMTMedicinalProductAndSubstanceshttp://terminology.hl7.org.au/ValueSet/amt-mp-codes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | 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![]() | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseMedication | A medication in an Australian healthcare context This profile also complies with the profiles Medication (IPS) and AU Core Medication | |||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for this medication | ||||||||||
![]() ![]() |
SΣ | 1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required) | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Medication primary text | ||||||||||
![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Physical product manufacturer organisation | ||||||||||
![]() ![]() |
S | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form (preferred) | ||||||||||
![]() ![]() |
Σ | 0..1 | Ratio | Amount of drug in package | ||||||||||
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient | ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() |
S | 1..1 | The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred) | |||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||
![]() ![]() ![]() ![]() |
Reference(Substance | Medication) | |||||||||||||
![]() ![]() ![]() |
0..1 | boolean | Active ingredient indicator | |||||||||||
![]() ![]() ![]() |
S | 0..1 | Ratio | Quantity/strength of ingredient present | ||||||||||
![]() ![]() |
0..1 | BackboneElement | Details about packaged medications | |||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() |
0..1 | string | Identifier assigned to batch | |||||||||||
![]() ![]() ![]() |
0..1 | dateTime | When batch will expire | |||||||||||
Documentation for this format | ||||||||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| Medication.code.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | ||||
| Medication.code.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | ||||
| Medication.form | preferred | MedicationForm ![]() https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 | ||||
| Medication.ingredient.item[x] | preferred | AMTMedicinalProductAndSubstanceshttp://terminology.hl7.org.au/ValueSet/amt-mp-codes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | 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 AUBaseMedication
Other representations of profile: CSV, Excel, Schematron