Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Core MedicationRequest

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-medicationrequest-core-1 Version: 1.0.0
Active as of 2024-09-12 Computable Name: ADHAMedicationRequestCore

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to provide a core representation of a request for the supply of a medication and the instructions for administration of that medication to a patient for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend MedicationRequest that are supported.

Where a more specific MedicationRequest profile is applicable, e.g. prescription, an implementation SHALL ensure the resource conforms to that specific profile.

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

  • See the Medicine information section for guidance.
  • MedicationRequest resources can represent a medication using either a code, or reference a Medication resource.
    • When referencing a Medication resource, it is preferred the resource is contained but it may be an external resource.

Boundaries and relationships

These profiles build on this profile (ADHA Core MedicationRequest) to define specific roles:

Usage:

Formal Views of Profile Content

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

This structure is derived from AUCoreMedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..* AUCoreMedicationRequest A request for a medication for a patient in an Australian healthcare context
... subject SC 1..1 Reference(AU Core Patient) Who or group medication request is for
inv-dh-medreq-01: At least reference or a valid identifier shall be present
... encounter S 0..1 Reference(AU Core Encounter) Encounter created as part of encounter/admission/stay
... requester SC 1..1 Reference(ADHA Authoring PractitionerRole | AU Core Organization | AU Core Patient | ADHA Authoring RelatedPerson) Who/What requested the Request
inv-dh-medreq-02: At least reference or display or a valid identifier shall be present

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-medreq-01errorMedicationRequest.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-medreq-02errorMedicationRequest.requesterAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..* AUCoreMedicationRequest A request for a medication for a patient in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... 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
... 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:All Slices Content/Rules for all slices
....... Slices for extension Content/Rules for all slices
........ medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... coding:pbs SOΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
....... Slices for extension Content/Rules for all slices
........ 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)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
....... Slices for extension Content/Rules for all slices
........ medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
.... medication[x]:medicationReference OΣ 0..1 Reference(AU Core Medication) Prescribed Medication
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... subject SOΣC 1..1 Reference(AU Core Patient) Who or group medication request is for
inv-dh-medreq-01: At least reference or a valid identifier shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... encounter SO 0..1 Reference(AU Core Encounter) Encounter created as part of encounter/admission/stay
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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
au-core-medreq-03: Date shall be precise to the day or, if not available, the Data Absent Reason extension shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... requester SOΣC 1..1 Reference(ADHA Authoring PractitionerRole | AU Core Organization | AU Core Patient | ADHA Authoring RelatedPerson) Who/What requested the Request
inv-dh-medreq-02: At least reference or display or a valid identifier shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... reasonCode SO 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Reason for Request . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... reasonReference SO 0..* Reference(AU Core Condition | Observation) Condition or observation that supports why the prescription is being written
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... dosageInstruction SO 0..* AUBaseDosage Dosage information in an Australian healthcare context
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-medreq-01errorMedicationRequest.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-medreq-02errorMedicationRequest.requesterAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..* AUCoreMedicationRequest A request for a medication for a patient in an Australian healthcare context
... 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 BindingsPurpose
AllLanguages Max Binding
... 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
.... 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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] 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
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
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ 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:pbs SOΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ 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)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ 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 OΣ 0..1 Reference(AU Core Medication) Prescribed Medication
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... subject SOΣC 1..1 Reference(AU Core Patient) Who or group medication request is for
inv-dh-medreq-01: At least reference or a valid identifier shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... encounter SO 0..1 Reference(AU Core Encounter) Encounter created as part of encounter/admission/stay
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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
au-core-medreq-03: Date shall be precise to the day or, if not available, the Data Absent Reason extension shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... requester SOΣC 1..1 Reference(ADHA Authoring PractitionerRole | AU Core Organization | AU Core Patient | ADHA Authoring RelatedPerson) Who/What requested the Request
inv-dh-medreq-02: At least reference or display or a valid identifier shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Reason for Request . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... reasonReference SO 0..* Reference(AU Core Condition | Observation) Condition or observation that supports why the prescription is being written
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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 Dosage information in an Australian healthcare context
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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: 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
from the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
MedicationRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
from the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-medreq-01errorMedicationRequest.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-medreq-02errorMedicationRequest.requesterAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

Differential View

This structure is derived from AUCoreMedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..* AUCoreMedicationRequest A request for a medication for a patient in an Australian healthcare context
... subject SC 1..1 Reference(AU Core Patient) Who or group medication request is for
inv-dh-medreq-01: At least reference or a valid identifier shall be present
... encounter S 0..1 Reference(AU Core Encounter) Encounter created as part of encounter/admission/stay
... requester SC 1..1 Reference(ADHA Authoring PractitionerRole | AU Core Organization | AU Core Patient | ADHA Authoring RelatedPerson) Who/What requested the Request
inv-dh-medreq-02: At least reference or display or a valid identifier shall be present

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-medreq-01errorMedicationRequest.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-medreq-02errorMedicationRequest.requesterAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..* AUCoreMedicationRequest A request for a medication for a patient in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... 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
... 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:All Slices Content/Rules for all slices
....... Slices for extension Content/Rules for all slices
........ medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... coding:pbs SOΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
....... Slices for extension Content/Rules for all slices
........ 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)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
....... Slices for extension Content/Rules for all slices
........ medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
.... medication[x]:medicationReference OΣ 0..1 Reference(AU Core Medication) Prescribed Medication
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... subject SOΣC 1..1 Reference(AU Core Patient) Who or group medication request is for
inv-dh-medreq-01: At least reference or a valid identifier shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... encounter SO 0..1 Reference(AU Core Encounter) Encounter created as part of encounter/admission/stay
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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
au-core-medreq-03: Date shall be precise to the day or, if not available, the Data Absent Reason extension shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... requester SOΣC 1..1 Reference(ADHA Authoring PractitionerRole | AU Core Organization | AU Core Patient | ADHA Authoring RelatedPerson) Who/What requested the Request
inv-dh-medreq-02: At least reference or display or a valid identifier shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... reasonCode SO 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Reason for Request . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... reasonReference SO 0..* Reference(AU Core Condition | Observation) Condition or observation that supports why the prescription is being written
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... dosageInstruction SO 0..* AUBaseDosage Dosage information in an Australian healthcare context
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-medreq-01errorMedicationRequest.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-medreq-02errorMedicationRequest.requesterAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..* AUCoreMedicationRequest A request for a medication for a patient in an Australian healthcare context
... 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 BindingsPurpose
AllLanguages Max Binding
... 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
.... 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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] 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.

ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
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
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ 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:pbs SOΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ 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)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ 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 OΣ 0..1 Reference(AU Core Medication) Prescribed Medication
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... subject SOΣC 1..1 Reference(AU Core Patient) Who or group medication request is for
inv-dh-medreq-01: At least reference or a valid identifier shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... encounter SO 0..1 Reference(AU Core Encounter) Encounter created as part of encounter/admission/stay
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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
au-core-medreq-03: Date shall be precise to the day or, if not available, the Data Absent Reason extension shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... requester SOΣC 1..1 Reference(ADHA Authoring PractitionerRole | AU Core Organization | AU Core Patient | ADHA Authoring RelatedPerson) Who/What requested the Request
inv-dh-medreq-02: At least reference or display or a valid identifier shall be present
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Reason for Request . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... reasonReference SO 0..* Reference(AU Core Condition | Observation) Condition or observation that supports why the prescription is being written
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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 Dosage information in an Australian healthcare context
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... 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: 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
from the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
MedicationRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
from the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-medreq-01errorMedicationRequest.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-medreq-02errorMedicationRequest.requesterAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Name Type Conformance Description Path
identifier token SHALL Return prescriptions with this external identifier MedicationRequest.identifier
subject:identifier token SHALL The identity of a patient to list orders for MedicationRequest.subject.identifier
authoredon date SHALL Return prescriptions written on this date MedicationRequest.effective
status token SHALL Status of the prescription MedicationRequest.status
intent token SHALL Returns prescriptions with different intents MedicationRequest.intent

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching for all medication requests for a patient using the combination of the subject:identifier and intent search parameters:
    • including support for OR search on intent (e.g.intent={system|}[code],{system|}[code],...)

    GET [base]/MedicationRequest?subject:identifier={system|}[code]&intent=order,plan

    Example:

     GET [base]/MedicationRequest?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437
    

    Implementation Notes: Fetches a bundle of all MedicationRequest resources for the specified patient (how to search by :identifier and how to search by token)

  2. SHALL support searching using the identifier search parameter:

    GET [base]/MedicationRequest?identifier={system|}[code]

    Example:

     GET [base]/MedicationRequest?identifier=http://fhir.erx.com.au/NamingSystem/identifiers#local-script-number|2998
    

    Implementation Notes: Fetches a bundle containing any MedicationRequest resources matching the identifier (how to search by token)

  3. SHALL support searching using the combination of the subject:identifier and intent and status search parameters:
    • including support for OR search on intent (e.g.intent={system|}[code],{system|}[code],...)
    • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/MedicationRequest?subject:identifier={system|}[code]&intent=order,plan&status={system|}[code]{,{system|}[code],...}

    Example:

     GET [base]/MedicationRequest?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&intent=order,plan&status=active
    

    Implementation Notes: Fetches a bundle of all MedicationRequest resources for the specified patient and intent code = order,plan and status (how to search by :identifier and how to search by token)

  4. SHALL support searching using the combination of the subject:identifier and intent and authoredon search parameters:
    • including support for OR search on intent (e.g.intent={system|}[code],{system|}[code],...)

    GET [base]/MedicationRequest?subject:identifier={system|}[code]&intent=order,plan&authoredon=[date]

    Example:

     GET [base]/MedicationRequest?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&intent=order,plan&authoredon=ge2013-03-14
    

    Implementation Notes: Fetches a bundle of all MedicationRequest resources for the specified patient that have a date greater than or equal to 21st Jan 2013. (how to search by :identifier and how to search by date)