This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions
AU Base Medication Request [FMM 2]
This profile defines a medication request structure that localises core concepts, including identifiers and terminology, for use in an Australian context.
The purpose of this profile is to provide national level agreement on core localised concepts.
This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.
These definitions, defined as profiles of Identifier, represent common data held in the MedicationRequest.identifier element:
Extensions used in this profile:
Potentially useful extensions:
A full medication definition as medicationReference or medicationCodeableConcept can be included to define the drug/medication concept. Medication definition includes coding as:
NOTE: AU Base on STU3 included the extension Minimum Interval Between Repeats which is now no longer required as direct R4 support is available.
Prescription for Stribild with concurrent supply
Prescription for paracetamol + codeine
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-medicationrequest
This profile defines a medication request structure that localises core concepts, including identifiers and terminology, for use in an Australian context.
This profile builds on MedicationRequest.
This profile was published on 2022-04-04 as a active by Health Level Seven Australia (Medications WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | MedicationRequest | A request for a medication for a patient in an Australian healthcare context | |||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
subsidised-concurrent-supply | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (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 | ||||
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. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
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 value:system | ||||
coding:pbs | Σ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item | ||||
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:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin | ||||
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 | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
medication-type | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
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:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes | ||||
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(Medication) | Prescribed Medication | ||||
subject | Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for | ||||
encounter | 0..1 | Reference(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 | Σ | 0..1 | dateTime | Created date | ||||
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | 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..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) | |||||
reasonReference | 0..* | Reference(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 | Dosage information in an Australian healthcare context | |||||
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 | 0..1 | SimpleQuantity | First fill quantity | |||||
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 | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
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: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (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 |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | MedicationRequest | A request for a medication for a patient in an Australian healthcare context | |||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
subsidised-concurrent-supply | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (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 | ||||
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. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
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 value:system | ||||
coding:pbs | Σ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item | ||||
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:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin | ||||
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 | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
medication-type | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
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:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes | ||||
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(Medication) | Prescribed Medication | ||||
subject | Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for | ||||
encounter | 0..1 | Reference(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 | Σ | 0..1 | dateTime | Created date | ||||
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | 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..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) | |||||
reasonReference | 0..* | Reference(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 | Dosage information in an Australian healthcare context | |||||
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 | 0..1 | SimpleQuantity | First fill quantity | |||||
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 | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
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: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (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 |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-medicationrequest
none defined