AU Patient Summary Implementation Guide
0.5.0-cibuild - CI Build
AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.5.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication | Version: 0.5.0-cibuild | |||
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 Core Medication profile, and applies the additional requirements from Medication (IPS).
See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.
Medication.code
producers SHALL correctly populate Medication.code.coding
with either a code from Australian Medication or PBS Item Codes, or both, if a coded value is known and MAY populate with a code from another code system.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCoreMedication
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
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) | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]() | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form ![]()
| ||||||||||||||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | Active or inactive ingredient
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred)
| |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance | Medication) | |||||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Ratio | Quantity/strength of ingredient present
| ||||||||||||||||||
![]() |
Path | Conformance | ValueSet | URI |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes From 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.1 From 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 Filter: ![]() ![]() | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||||||||||||
![]() ![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business identifier for this medication | ||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 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 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 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 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]() | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form ![]()
| ||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | Amount of drug in package | ||||||||||||||||||
![]() ![]() ![]() |
SO | 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 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 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 | |||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 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 | |||||||||||||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes From 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.1 From 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 AUCoreMedication
Summary
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUCoreMedication
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||
![]() ![]() ![]() |
O | 1..1 | CodeableConceptIPS | Coding for the medicine
| ||||||||
![]() ![]() ![]() |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule +
| ||||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | Active or inactive ingredient
| ||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | The actual ingredient or content
| |||||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance | Medication) | |||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Ratio | Quantity/strength of ingredient present
| ||||||||
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
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) | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]() | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form ![]()
| ||||||||||||||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | Active or inactive ingredient
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred)
| |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance | Medication) | |||||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | Ratio | Quantity/strength of ingredient present
| ||||||||||||||||||
![]() |
Path | Conformance | ValueSet | URI |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes From 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.1 From 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 Filter: ![]() ![]() | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||||||||||||
![]() ![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business identifier for this medication | ||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 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 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 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 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]() | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form ![]()
| ||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | Amount of drug in package | ||||||||||||||||||
![]() ![]() ![]() |
SO | 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 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 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 | |||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 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 | |||||||||||||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes From 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.1 From 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 AUCoreMedication
Summary
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron