AU Patient Summary Implementation Guide
0.6.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.6.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/freshehr/interopen-uk-fhir-ps/ and changes regularly. See the Directory of published versions

## Resource Profile: AU PS MedicationRequest

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medicationrequest | Version: 0.6.0-cibuild
Standards status: Draft | Maturity Level: 1 | Computable Name: AUPSMedicationRequest
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 MedicationRequest resource in the context of a patient summary in an Australian context. It is based on the AU Core MedicationRequest, 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.

### Profile Specific Implementation Guidance

- See the guidance on implementing the MedicationRequest resource in AU Core.
- When populating `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.
  - Producers MAY populate with only text if no coded value is known.
- The MedicationRequest resource can represent the clinical indication as a code with `MedicationRequest.reasonCode`, or a reference with `MedicationRequest.reasonReference` to a Condition or other resource.
  - Although both are marked as Must Support, producers are not required to support both a code and a reference, but they SHALL support at least one of these elements
  - A consumer SHALL support both elements
- The MedicationRequest resource SHALL NOT be used to represent that a patient is not currently taking any medications; systems SHOULD use the MedicationStatement resource following the profile specific implementation guidance in AU PS MedicationStatement.

Examples for this Profile: Bundle/aups-gpvisit-retrieval

Usages:

- Use this Profile: AU PS Bundle
- Refer to this Profile: AU PS Composition

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 | ?!SO Σ | 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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
intent | ?!SO Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action Required Pattern: false
Slices for medication[x] | SO Σ | 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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
medicationCodeableConcept |  |  | CodeableConcept |
medicationReference |  |  | Reference(Medication) |
medication[x]:medicationCodeableConcept | SO Σ | 0..1 | CodeableConceptIPS | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
Australian Medication | Preferred
PBS Item Codes | Preferred
MIMS | Preferred
GTIN | Preferred
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:pbs | SO Σ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
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 | SO Σ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
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 | SO Σ | 0..1 | Reference(AU PS Medication) | Prescribed Medication
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
subject | SO Σ | 1..1 | Reference(AU PS Patient) | Who or group medication request is for
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
encounter | SO | 0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ C | 1..1 | dateTime | Created date Constraints: au-core-medreq-01
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
requester | SO Σ | 1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonCode | SO | 0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonReference | SO | 0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
dosageInstruction | SO | 0..* | AUBaseDosage | How the medication should be taken
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
text | SO Σ | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
timing | SO Σ | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

#### Terminology Bindings

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 | 📦6.0.1-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

#### Constraints

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: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 | O | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
intent | O | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
doNotPerform |  | 0..1 | boolean | True if request is prohibiting action Required Pattern: false
medication[x] | O | 1..1 | CodeableConcept, Reference(Medication) | Medication to be taken
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for medication[x] |  |  |  | Content/Rules for all slices
medication[x]:medicationCodeableConcept | O | 0..1 | CodeableConceptIPS | Coded Prescribed Medication
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for coding |  |  |  | Content/Rules for all slices
coding:pbs | O | 0..* | Coding | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
coding:amt | O | 0..* | Coding | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
medication[x]:medicationReference | O | 0..1 | Reference(AU PS Medication) | Prescribed Medication
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
subject | O | 1..1 | Reference(AU PS Patient) | Who or group medication request is for
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
encounter | O | 0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
authoredOn | O | 1..1 | dateTime | Created date
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
requester | O | 1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonCode | O | 0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonReference | O | 0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
dosageInstruction | O | 0..* | AUBaseDosage | How the medication should be taken
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
text | O | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
timing | SO | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | ?!SO Σ | 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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
intent | ?!SO Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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] | SO Σ | 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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
medicationCodeableConcept |  |  | CodeableConcept |
medicationReference |  |  | Reference(Medication) |
medication[x]:medicationCodeableConcept | SO Σ | 0..1 | CodeableConceptIPS | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
Australian Medication | Preferred
PBS Item Codes | Preferred
MIMS | Preferred
GTIN | Preferred
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
coding:pbs | SO Σ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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 | SO Σ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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 | SO Σ | 0..1 | Reference(AU PS Medication) | Prescribed Medication
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
subject | SO Σ | 1..1 | Reference(AU PS Patient) | Who or group medication request is for
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
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 | SO | 0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ C | 1..1 | dateTime | Created date Constraints: au-core-medreq-01
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
requester | SO Σ | 1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO | 0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonReference | SO | 0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO | 0..* | AUBaseDosage | How the medication should be taken
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient
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(4.0.1) | 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(4.0.1) | 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: 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

#### Terminology Bindings

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 | 📦6.0.1-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.0
MedicationRequest.substitution.​reason | Base | preferred | Medicine Substitution Reason | ⏿1.0.1 | tx.hl7.org.au

#### Constraints

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

Summary

Mandatory: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- AU PS Medication (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)
- AU PS Encounter (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-encounter)
- AU PS Practitioner (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner)
- AU PS PractitionerRole (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole)
- AU PS Organization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization)
- AU PS RelatedPerson (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson)
- AU PS Condition (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-condition)

Maturity: 1

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 | ?!SO Σ | 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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
intent | ?!SO Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action Required Pattern: false
Slices for medication[x] | SO Σ | 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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
medicationCodeableConcept |  |  | CodeableConcept |
medicationReference |  |  | Reference(Medication) |
medication[x]:medicationCodeableConcept | SO Σ | 0..1 | CodeableConceptIPS | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
Australian Medication | Preferred
PBS Item Codes | Preferred
MIMS | Preferred
GTIN | Preferred
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:pbs | SO Σ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
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 | SO Σ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
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 | SO Σ | 0..1 | Reference(AU PS Medication) | Prescribed Medication
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
subject | SO Σ | 1..1 | Reference(AU PS Patient) | Who or group medication request is for
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
encounter | SO | 0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ C | 1..1 | dateTime | Created date Constraints: au-core-medreq-01
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
requester | SO Σ | 1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonCode | SO | 0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonReference | SO | 0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
dosageInstruction | SO | 0..* | AUBaseDosage | How the medication should be taken
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
text | SO Σ | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
timing | SO Σ | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

#### Terminology Bindings

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 | 📦6.0.1-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

#### Constraints

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: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 | O | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
intent | O | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
doNotPerform |  | 0..1 | boolean | True if request is prohibiting action Required Pattern: false
medication[x] | O | 1..1 | CodeableConcept, Reference(Medication) | Medication to be taken
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for medication[x] |  |  |  | Content/Rules for all slices
medication[x]:medicationCodeableConcept | O | 0..1 | CodeableConceptIPS | Coded Prescribed Medication
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Slices for coding |  |  |  | Content/Rules for all slices
coding:pbs | O | 0..* | Coding | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
coding:amt | O | 0..* | Coding | Code defined by a terminology system
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
medication[x]:medicationReference | O | 0..1 | Reference(AU PS Medication) | Prescribed Medication
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
subject | O | 1..1 | Reference(AU PS Patient) | Who or group medication request is for
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
encounter | O | 0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
authoredOn | O | 1..1 | dateTime | Created date
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
requester | O | 1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonCode | O | 0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonReference | O | 0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
dosageInstruction | O | 0..* | AUBaseDosage | How the medication should be taken
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
text | O | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
timing | SO | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | ?!SO Σ | 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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
intent | ?!SO Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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] | SO Σ | 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.
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
medicationCodeableConcept |  |  | CodeableConcept |
medicationReference |  |  | Reference(Medication) |
medication[x]:medicationCodeableConcept | SO Σ | 0..1 | CodeableConceptIPS | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
Australian Medication | Preferred
PBS Item Codes | Preferred
MIMS | Preferred
GTIN | Preferred
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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
coding:pbs | SO Σ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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 | SO Σ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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 | SO Σ | 0..1 | Reference(AU PS Medication) | Prescribed Medication
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
subject | SO Σ | 1..1 | Reference(AU PS Patient) | Who or group medication request is for
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate | AU PS Producer
SHALL:handle | AU PS Consumer
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 | SO | 0..1 | Reference(AU PS Encounter) | Encounter created as part of encounter/admission/stay
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ C | 1..1 | dateTime | Created date Constraints: au-core-medreq-01
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
requester | SO Σ | 1..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who/What requested the Request
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO | 0..* | CodeableConceptIPS | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonReference | SO | 0..* | Reference(AU PS Condition | Observation) | Condition or observation that supports why the prescription is being written
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO | 0..* | AUBaseDosage | How the medication should be taken
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | SO Σ | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
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 | Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient
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(4.0.1) | 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(4.0.1) | 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: 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

#### Terminology Bindings

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 | 📦6.0.1-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.0
MedicationRequest.substitution.​reason | Base | preferred | Medicine Substitution Reason | ⏿1.0.1 | tx.hl7.org.au

#### Constraints

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

Summary

Mandatory: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- AU PS Medication (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)
- AU PS Encounter (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-encounter)
- AU PS Practitioner (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner)
- AU PS PractitionerRole (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole)
- AU PS Organization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization)
- AU PS RelatedPerson (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson)
- AU PS Condition (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-condition)

Maturity: 1

Other representations of profile: CSV, Excel, Schematron