AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide
1.0.1-ci-build - 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 1.0.1-ci-build 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-medicationrequest | Version: 1.0.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUPSMedicationRequest | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a MedicationRequest resource in the context of a patient summary in an Australian context. It is based on the AU Core MedicationRequest profile, and applies the additional requirements from MedicationRequest (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.
MedicationRequest.medicationCodeableConcept producers SHALL correctly populate MedicationRequest.medicationCodeableConcept.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.
MedicationRequest.reasonCode, or a reference with MedicationRequest.reasonReference to a Condition or other resource.
Examples for this Profile: Bundle/aups-gpvisit-retrieval
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  MedicationRequest |
0..* | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context This profile also complies with the profile MedicationRequest (IPS) | |||||||||||||||||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
   extension:sexParameterForClinicalUse |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||||||||||||
 extension:subsidisedConcurrentSupply |
0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds  (required) | |||||||||||||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||
| status |
1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
| |||||||||||||||||||
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
| |||||||||||||||||||
| doNotPerform |
0..1 | boolean | True if request is prohibiting action Required Pattern: false | |||||||||||||||||||
| Slices for medication[x] |
1..1 | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||||||||||
 medicationCodeableConcept |
CodeableConcept | |||||||||||||||||||||
 medicationReference |
Reference(Medication) | |||||||||||||||||||||
 medication[x]:medicationCodeableConcept |
0..1 | CodeableConceptIPS | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
| |||||||||||||||||||
  Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
 Slices for coding |
Content/Rules for all slices | |||||||||||||||||||||
 coding:pbs |
0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
 coding:amt |
0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| medication[x]:medicationReference |
0..1 | Reference(AU PS Medication) | Prescribed Medication
| |||||||||||||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who or group medication request is for
| |||||||||||||||||||
 reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
| |||||||||||||||||||
| Slices for supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() | |||||||||||||||||||
| supportingInformation:bodyHeight |
0..1 | Reference(Observation Body Height Profile) | Observation of Body Height | |||||||||||||||||||
| supportingInformation:bodyWeight |
0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight | |||||||||||||||||||
| authoredOn |
C | 1..1 | dateTime | Created date Constraints: au-core-medreq-01
| ||||||||||||||||||
| requester |
1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
| |||||||||||||||||||
| reasonCode |
0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
| |||||||||||||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
| |||||||||||||||||||
 dosageInstruction |
0..* | AUBaseDosage  |
How the medication should be taken
| |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||||||||||||
| timing |
0..1 | Timing | When medication should be administered
| |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.reasonCode | Base | preferred |
Reason for Request
|
⏿1.0.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-medreq-01 | error | MedicationRequest.authoredOn | Date shall be precise to the day or, if not available, the Data Absent Reason extension shall be present |
$this.hasValue() implies (extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not() and $this.toString().length() >= 10)
|
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationRequest | 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 | MedicationRequest | 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 | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationRequest | 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 AUCoreMedicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context This profile also complies with the profile MedicationRequest (IPS) | |||||||||
 status |
1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
| |||||||||
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
| |||||||||
| doNotPerform |
0..1 | boolean | True if request is prohibiting action Required Pattern: false | |||||||||
| medication[x] |
1..1 | CodeableConcept, Reference(Medication) | Medication to be taken
| |||||||||
| Slices for medication[x] |
Content/Rules for all slices | |||||||||||
| medication[x]:medicationCodeableConcept |
0..1 | CodeableConceptIPS | Coded Prescribed Medication
| |||||||||
| Slices for coding |
Content/Rules for all slices | |||||||||||
| coding:pbs |
0..* | Coding | Code defined by a terminology system
| |||||||||
| coding:amt |
0..* | Coding | Code defined by a terminology system
| |||||||||
| medication[x]:medicationReference |
0..1 | Reference(AU PS Medication) | Prescribed Medication
| |||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who or group medication request is for
| |||||||||
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
| |||||||||
| authoredOn |
1..1 | dateTime | Created date
| |||||||||
| requester |
1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
| |||||||||
| reasonCode |
0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication
| |||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
| |||||||||
| dosageInstruction |
0..* | AUBaseDosage | How the medication should be taken
| |||||||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||
| timing |
0..1 | Timing | When medication should be administered
| |||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context This profile also complies with the profile MedicationRequest (IPS) | |||||||||||||||||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
| extension:sexParameterForClinicalUse |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||||||||||||
| extension:subsidisedConcurrentSupply |
0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||
| identifier |
0..* | Identifier , AUETPPrescriptionIdentifier , AULocalPrescriptionIdentifier |
External ids for this request | |||||||||||||||||||
| status |
1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
| |||||||||||||||||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||||||||||||||||
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
| |||||||||||||||||||
| category |
0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. | |||||||||||||||||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||||||||||||||||
| doNotPerform |
0..1 | boolean | True if request is prohibiting action Required Pattern: false | |||||||||||||||||||
 reported[x] |
0..1 | Reported rather than primary record | ||||||||||||||||||||
| reportedBoolean |
boolean | |||||||||||||||||||||
| reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||||||||||||||||
| Slices for medication[x] |
1..1 | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||||||||||
| medicationCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| medicationReference |
Reference(Medication) | |||||||||||||||||||||
| medication[x]:medicationCodeableConcept |
0..1 | CodeableConceptIPS | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
 Slices for coding |
Content/Rules for all slices | |||||||||||||||||||||
 coding:pbs |
0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| system |
0..1 | uri | Identity of the terminology system | |||||||||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||||||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||||||||
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||
| coding:amt |
0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| system |
0..1 | uri | Identity of the terminology system | |||||||||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||||||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||
| text |
0..1 | string | Medication primary text | |||||||||||||||||||
| medication[x]:medicationReference |
0..1 | Reference(AU PS Medication) | Prescribed Medication
| |||||||||||||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who or group medication request is for
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||||||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
| |||||||||||||||||||
| Slices for supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() | |||||||||||||||||||
| supportingInformation:bodyHeight |
0..1 | Reference(Observation Body Height Profile) | Observation of Body Height | |||||||||||||||||||
| supportingInformation:bodyWeight |
0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight | |||||||||||||||||||
| authoredOn |
C | 1..1 | dateTime | Created date Constraints: au-core-medreq-01
| ||||||||||||||||||
| requester |
1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
| |||||||||||||||||||
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||||||||||||||||
| performerType |
0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication. | |||||||||||||||||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||||||||||||||||
| reasonCode |
0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
| |||||||||||||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
| |||||||||||||||||||
| instantiatesCanonical |
0..* | canonical() | Instantiates FHIR protocol or definition | |||||||||||||||||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||||||||||||||||
| basedOn |
0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | |||||||||||||||||||
| groupIdentifier |
0..1 | Identifier | Composite request this is part of | |||||||||||||||||||
| courseOfTherapyType |
0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||||||||||||||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||||||||||||||||
| note |
0..* | Annotation | Information about the prescription | |||||||||||||||||||
| dosageInstruction |
0..* | AUBaseDosage |
How the medication should be taken
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
| sequence |
0..1 | integer | The order of the dosage instructions | |||||||||||||||||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||||||||||||
| additionalInstruction |
0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | |||||||||||||||||||
| patientInstruction |
0..1 | string | Patient or consumer oriented instructions | |||||||||||||||||||
| timing |
0..1 | Timing | When medication should be administered
| |||||||||||||||||||
| asNeeded[x] |
0..1 | Take "as needed" (for x) Binding: Clinical Finding (preferred) | ||||||||||||||||||||
| asNeededBoolean |
boolean | |||||||||||||||||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| site |
0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | |||||||||||||||||||
| route |
0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) | |||||||||||||||||||
| method |
0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | |||||||||||||||||||
| doseAndRate |
0..* | Element | Amount of medication administered | |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| type |
0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | |||||||||||||||||||
| dose[x] |
0..1 | Amount of medication per dose | ||||||||||||||||||||
| doseRange |
Range | |||||||||||||||||||||
| doseQuantity |
Quantity(SimpleQuantity) | |||||||||||||||||||||
| rate[x] |
0..1 | Amount of medication per unit of time | ||||||||||||||||||||
| rateRatio |
Ratio | |||||||||||||||||||||
| rateRange |
Range | |||||||||||||||||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||||||||||||||||
| maxDosePerPeriod |
0..1 | Ratio | Upper limit on medication per unit of time | |||||||||||||||||||
| maxDosePerAdministration |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration Constraints: sqty-1 | ||||||||||||||||||
| maxDosePerLifetime |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient Constraints: sqty-1 | ||||||||||||||||||
| dispenseRequest |
0..1 | BackboneElement | Requested dispensing | |||||||||||||||||||
| 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 | |||||||||||||||||||
| initialFill |
0..1 | BackboneElement | First fill details | |||||||||||||||||||
| 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 |
C | 0..1 | SimpleQuantity(4.0.1) | First fill quantity Constraints: sqty-1 | ||||||||||||||||||
| duration |
0..1 | Duration | First fill duration | |||||||||||||||||||
| dispenseInterval |
0..1 | Duration | Minimum period of time between dispenses | |||||||||||||||||||
| validityPeriod |
0..1 | Period | Time period supply is authorized for | |||||||||||||||||||
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Maximum repeats authorised | |||||||||||||||||||
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of medication to supply per dispense Constraints: sqty-1 | ||||||||||||||||||
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |||||||||||||||||||
| performer |
0..1 | Reference(Organization) | Intended dispenser | |||||||||||||||||||
| substitution |
0..1 | BackboneElement | Brand substitution details | |||||||||||||||||||
| 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 | |||||||||||||||||||
| allowed[x] |
1..1 | Brand substitution flag Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||||||||||||||||
| allowedBoolean |
boolean | |||||||||||||||||||||
| allowedCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: Medicine Substitution Reason (preferred) | |||||||||||||||||||
| priorPrescription |
0..1 | Reference(MedicationRequest) | An order/prescription that is being replaced | |||||||||||||||||||
| detectedIssue |
0..* | Reference(DetectedIssue) | Clinical Issue with action | |||||||||||||||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.statusReason | Base | example | Medication request status reason codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | example | Medication request category codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | preferred |
Reason for Request
|
⏿1.0.1 | tx.hl7.org.au |
| MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.additionalInstruction | Base | preferred | SNOMED CT Additional Dosage Instructions | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.asNeeded[x] | Base | preferred |
Clinical Finding
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.dosageInstruction.site | Base | preferred |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.dosageInstruction.route | Base | preferred |
Route of Administration
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.dosageInstruction.method | Base | preferred | SNOMED CT Administration Method Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationRequest.substitution.reason | Base | preferred |
Medicine Substitution Reason
|
⏿1.0.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-medreq-01 | error | MedicationRequest.authoredOn | Date shall be precise to the day or, if not available, the Data Absent Reason extension shall be present |
$this.hasValue() implies (extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not() and $this.toString().length() >= 10)
|
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationRequest | 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 | MedicationRequest | 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 | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationRequest | 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()
|
| sqty-1 | error | MedicationRequest.dosageInstruction.maxDosePerAdministration, MedicationRequest.dosageInstruction.maxDosePerLifetime, MedicationRequest.dispenseRequest.initialFill.quantity, MedicationRequest.dispenseRequest.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from AUCoreMedicationRequest
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context This profile also complies with the profile MedicationRequest (IPS) | |||||||||||||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:sexParameterForClinicalUse |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||||||||||||
| extension:subsidisedConcurrentSupply |
0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||
| status |
1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
| |||||||||||||||||||
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
| |||||||||||||||||||
| doNotPerform |
0..1 | boolean | True if request is prohibiting action Required Pattern: false | |||||||||||||||||||
| Slices for medication[x] |
1..1 | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||||||||||
| medicationCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| medicationReference |
Reference(Medication) | |||||||||||||||||||||
| medication[x]:medicationCodeableConcept |
0..1 | CodeableConceptIPS | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
| |||||||||||||||||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
| Slices for coding |
Content/Rules for all slices | |||||||||||||||||||||
| coding:pbs |
0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| coding:amt |
0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| medication[x]:medicationReference |
0..1 | Reference(AU PS Medication) | Prescribed Medication
| |||||||||||||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who or group medication request is for
| |||||||||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
| |||||||||||||||||||
| Slices for supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() | |||||||||||||||||||
| supportingInformation:bodyHeight |
0..1 | Reference(Observation Body Height Profile) | Observation of Body Height | |||||||||||||||||||
| supportingInformation:bodyWeight |
0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight | |||||||||||||||||||
| authoredOn |
C | 1..1 | dateTime | Created date Constraints: au-core-medreq-01
| ||||||||||||||||||
| requester |
1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
| |||||||||||||||||||
| reasonCode |
0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
| |||||||||||||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
| |||||||||||||||||||
| dosageInstruction |
0..* | AUBaseDosage |
How the medication should be taken
| |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||||||||||||
| timing |
0..1 | Timing | When medication should be administered
| |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.reasonCode | Base | preferred |
Reason for Request
|
⏿1.0.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-medreq-01 | error | MedicationRequest.authoredOn | Date shall be precise to the day or, if not available, the Data Absent Reason extension shall be present |
$this.hasValue() implies (extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not() and $this.toString().length() >= 10)
|
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationRequest | 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 | MedicationRequest | 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 | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from AUCoreMedicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context This profile also complies with the profile MedicationRequest (IPS) | |||||||||
| status |
1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
| |||||||||
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
| |||||||||
| doNotPerform |
0..1 | boolean | True if request is prohibiting action Required Pattern: false | |||||||||
| medication[x] |
1..1 | CodeableConcept, Reference(Medication) | Medication to be taken
| |||||||||
| Slices for medication[x] |
Content/Rules for all slices | |||||||||||
| medication[x]:medicationCodeableConcept |
0..1 | CodeableConceptIPS | Coded Prescribed Medication
| |||||||||
| Slices for coding |
Content/Rules for all slices | |||||||||||
| coding:pbs |
0..* | Coding | Code defined by a terminology system
| |||||||||
| coding:amt |
0..* | Coding | Code defined by a terminology system
| |||||||||
| medication[x]:medicationReference |
0..1 | Reference(AU PS Medication) | Prescribed Medication
| |||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who or group medication request is for
| |||||||||
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
| |||||||||
| authoredOn |
1..1 | dateTime | Created date
| |||||||||
| requester |
1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
| |||||||||
| reasonCode |
0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication
| |||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
| |||||||||
| dosageInstruction |
0..* | AUBaseDosage | How the medication should be taken
| |||||||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||
| timing |
0..1 | Timing | When medication should be administered
| |||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context This profile also complies with the profile MedicationRequest (IPS) | |||||||||||||||||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
| extension:sexParameterForClinicalUse |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||||||||||||
| extension:subsidisedConcurrentSupply |
0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||
| identifier |
0..* | Identifier , AUETPPrescriptionIdentifier , AULocalPrescriptionIdentifier |
External ids for this request | |||||||||||||||||||
| status |
1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
| |||||||||||||||||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||||||||||||||||
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
| |||||||||||||||||||
| category |
0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. | |||||||||||||||||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||||||||||||||||
| doNotPerform |
0..1 | boolean | True if request is prohibiting action Required Pattern: false | |||||||||||||||||||
| reported[x] |
0..1 | Reported rather than primary record | ||||||||||||||||||||
| reportedBoolean |
boolean | |||||||||||||||||||||
| reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||||||||||||||||
| Slices for medication[x] |
1..1 | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||||||||||
| medicationCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| medicationReference |
Reference(Medication) | |||||||||||||||||||||
| medication[x]:medicationCodeableConcept |
0..1 | CodeableConceptIPS | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
| Slices for coding |
Content/Rules for all slices | |||||||||||||||||||||
| coding:pbs |
0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| system |
0..1 | uri | Identity of the terminology system | |||||||||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||||||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||
| coding:amt |
0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| system |
0..1 | uri | Identity of the terminology system | |||||||||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||||||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||
| text |
0..1 | string | Medication primary text | |||||||||||||||||||
| medication[x]:medicationReference |
0..1 | Reference(AU PS Medication) | Prescribed Medication
| |||||||||||||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who or group medication request is for
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||||||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
| |||||||||||||||||||
| Slices for supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() | |||||||||||||||||||
| supportingInformation:bodyHeight |
0..1 | Reference(Observation Body Height Profile) | Observation of Body Height | |||||||||||||||||||
| supportingInformation:bodyWeight |
0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight | |||||||||||||||||||
| authoredOn |
C | 1..1 | dateTime | Created date Constraints: au-core-medreq-01
| ||||||||||||||||||
| requester |
1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
| |||||||||||||||||||
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||||||||||||||||
| performerType |
0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication. | |||||||||||||||||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||||||||||||||||
| reasonCode |
0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
| |||||||||||||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
| |||||||||||||||||||
| instantiatesCanonical |
0..* | canonical() | Instantiates FHIR protocol or definition | |||||||||||||||||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||||||||||||||||
| basedOn |
0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | |||||||||||||||||||
| groupIdentifier |
0..1 | Identifier | Composite request this is part of | |||||||||||||||||||
| courseOfTherapyType |
0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||||||||||||||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||||||||||||||||
| note |
0..* | Annotation | Information about the prescription | |||||||||||||||||||
| dosageInstruction |
0..* | AUBaseDosage |
How the medication should be taken
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
| sequence |
0..1 | integer | The order of the dosage instructions | |||||||||||||||||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||||||||||||
| additionalInstruction |
0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | |||||||||||||||||||
| patientInstruction |
0..1 | string | Patient or consumer oriented instructions | |||||||||||||||||||
| timing |
0..1 | Timing | When medication should be administered
| |||||||||||||||||||
| asNeeded[x] |
0..1 | Take "as needed" (for x) Binding: Clinical Finding (preferred) | ||||||||||||||||||||
| asNeededBoolean |
boolean | |||||||||||||||||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| site |
0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | |||||||||||||||||||
| route |
0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) | |||||||||||||||||||
| method |
0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | |||||||||||||||||||
| doseAndRate |
0..* | Element | Amount of medication administered | |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| type |
0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | |||||||||||||||||||
| dose[x] |
0..1 | Amount of medication per dose | ||||||||||||||||||||
| doseRange |
Range | |||||||||||||||||||||
| doseQuantity |
Quantity(SimpleQuantity) | |||||||||||||||||||||
| rate[x] |
0..1 | Amount of medication per unit of time | ||||||||||||||||||||
| rateRatio |
Ratio | |||||||||||||||||||||
| rateRange |
Range | |||||||||||||||||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||||||||||||||||
| maxDosePerPeriod |
0..1 | Ratio | Upper limit on medication per unit of time | |||||||||||||||||||
| maxDosePerAdministration |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration Constraints: sqty-1 | ||||||||||||||||||
| maxDosePerLifetime |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient Constraints: sqty-1 | ||||||||||||||||||
| dispenseRequest |
0..1 | BackboneElement | Requested dispensing | |||||||||||||||||||
| 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 | |||||||||||||||||||
| initialFill |
0..1 | BackboneElement | First fill details | |||||||||||||||||||
| 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 |
C | 0..1 | SimpleQuantity(4.0.1) | First fill quantity Constraints: sqty-1 | ||||||||||||||||||
| duration |
0..1 | Duration | First fill duration | |||||||||||||||||||
| dispenseInterval |
0..1 | Duration | Minimum period of time between dispenses | |||||||||||||||||||
| validityPeriod |
0..1 | Period | Time period supply is authorized for | |||||||||||||||||||
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Maximum repeats authorised | |||||||||||||||||||
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of medication to supply per dispense Constraints: sqty-1 | ||||||||||||||||||
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |||||||||||||||||||
| performer |
0..1 | Reference(Organization) | Intended dispenser | |||||||||||||||||||
| substitution |
0..1 | BackboneElement | Brand substitution details | |||||||||||||||||||
| 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 | |||||||||||||||||||
| allowed[x] |
1..1 | Brand substitution flag Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||||||||||||||||
| allowedBoolean |
boolean | |||||||||||||||||||||
| allowedCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: Medicine Substitution Reason (preferred) | |||||||||||||||||||
| priorPrescription |
0..1 | Reference(MedicationRequest) | An order/prescription that is being replaced | |||||||||||||||||||
| detectedIssue |
0..* | Reference(DetectedIssue) | Clinical Issue with action | |||||||||||||||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.statusReason | Base | example | Medication request status reason codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | example | Medication request category codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | preferred |
Reason for Request
|
⏿1.0.1 | tx.hl7.org.au |
| MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.additionalInstruction | Base | preferred | SNOMED CT Additional Dosage Instructions | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.asNeeded[x] | Base | preferred |
Clinical Finding
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.dosageInstruction.site | Base | preferred |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.dosageInstruction.route | Base | preferred |
Route of Administration
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationRequest.dosageInstruction.method | Base | preferred | SNOMED CT Administration Method Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationRequest.substitution.reason | Base | preferred |
Medicine Substitution Reason
|
⏿1.0.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-medreq-01 | error | MedicationRequest.authoredOn | Date shall be precise to the day or, if not available, the Data Absent Reason extension shall be present |
$this.hasValue() implies (extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not() and $this.toString().length() >= 10)
|
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationRequest | 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 | MedicationRequest | 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 | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationRequest | 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()
|
| sqty-1 | error | MedicationRequest.dosageInstruction.maxDosePerAdministration, MedicationRequest.dosageInstruction.maxDosePerLifetime, MedicationRequest.dispenseRequest.initialFill.quantity, MedicationRequest.dispenseRequest.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from AUCoreMedicationRequest
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Australia. Package hl7.fhir.au.ps#1.0.1-ci-build based on FHIR 4.0.1. Generated 2026-10-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change