AU Base Implementation Guide
7.0.0-ballot1 - Ballot

AU Base Implementation Guide - Downloaded Version 7.0.0-ballot1 See the Directory of published versions

## Resource Profile: AU Base MedicationRequest

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medicationrequest | Version: 7.0.0-ballot1
Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUBaseMedicationRequest
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a medication request structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

### Usage Notes

Profile specific implementation guidance:

- When identifying a medication, this resource can use either a code or refer to a Medication resource.
- If making use of `MedicationRequest.medicationCodeableConcept`, this profile includes coding as:
  - PBS Item Code - Pharmaceutical Benefits Scheme coding, claiming context is not relevant as medicine coding
  - Medication Package Global Trade Item Number - Global Trade Item Number (GTIN) physical product reference
  - AMT Medicines - Australian Medicines Terminology, national drug terminology
  - MIMS Package - commonly used medicine coding
- If a medication is compounded and is a list of ingredients, `MedicationRequest.medicationCodeableConcept` is still present and may contain only the list of ingredients as text in `MedicationRequest.medicationCodeableConcept.text`.
- Where additional medicinal product information is needed, `MedicationRequest.medicationReference` is preferred to `MedicationRequest.medicationCodeableConcept` and use of extensions, see guidance on AU Base Medication.
- See each Identifier profile page for guidance related to that identifier type.
- This profile supports the sex, gender, and related concept of Sex Parameter for Clinical Use:
  - When exchanging concepts of sex or gender, refer to the guidance in Sex and Gender and the Gender Harmony Implementation Guide.

Potentially useful extensions:

- MedicationRequest: Medication Brand Name
- MedicationRequest: Medication Generic Name

Usages:

- Examples for this Profile: MedicationRequest/example0, MedicationRequest/example1 and MedicationRequest/example2

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

- No changes

### 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..* | MedicationRequest | 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 |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:subsidisedConcurrentSupply |  | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request
status | ?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
Slices for medication[x] | Σ | 1..1 |  | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
medicationCodeableConcept |  |  | CodeableConcept |
medicationReference |  |  | Reference(Medication) |
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
Australian Medication | Preferred
PBS Item Codes | Preferred
MIMS | Preferred
GTIN | Preferred
text | Σ | 0..1 | string | Medication primary text
medication[x]:medicationReference | Σ | 0..1 | Reference(Medication) | Prescribed Medication
subject | Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for
Slices for supportingInformation |  | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve()
supportingInformation:bodyHeight |  | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height
supportingInformation:bodyWeight |  | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight
authoredOn | Σ | 0..1 | dateTime | Created date
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
dosageInstruction |  | 0..* | AUBaseDosage | How the medication should be taken
dispenseRequest |  | 0..1 | BackboneElement | Requested dispensing
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
numberOfRepeatsAllowed |  | 0..1 | unsignedInt | Maximum repeats authorised
substitution |  | 0..1 | BackboneElement | Brand substitution details
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)
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.reasonCode | Base | preferred | Reason for Request | ⏿1.0.1 | tx.hl7.org.au
MedicationRequest.substitution.​allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.3
MedicationRequest.substitution.​reason | Base | preferred | Medicine Substitution Reason | ⏿1.0.1 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 MedicationRequest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | A request for a medication for a patient in an Australian healthcare context
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)
identifier |  | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request
Slices for medication[x] |  | 1..1 | CodeableConcept, Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this
medication[x]:medicationCodeableConcept |  | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
Australian Medication | Preferred
PBS Item Codes | Preferred
MIMS | Preferred
GTIN | Preferred
coding |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
Slices for extension |  |  |  | Content/Rules for all slices
extension:medicationClass |  | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
text |  | 0..1 | string | Medication primary text
medication[x]:medicationReference |  | 0..1 | Reference(Medication) | Prescribed Medication
Slices for supportingInformation |  | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve()
supportingInformation:bodyHeight |  | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height
supportingInformation:bodyWeight |  | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight
authoredOn |  | 0..1 | dateTime | Created date
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
dosageInstruction |  | 0..* | AUBaseDosage | How the medication should be taken
dispenseRequest |  | 0..1 | BackboneElement | Requested dispensing
numberOfRepeatsAllowed |  | 0..1 | unsignedInt | Maximum repeats authorised
substitution |  | 0..1 | BackboneElement | Brand substitution details
allowed[x] |  | 1..1 | boolean, CodeableConcept | Brand substitution flag
reason |  | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: Medicine Substitution Reason (preferred)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
MedicationRequest.medication[x]:medicationCodeableConcept | Base | example |  | Not State | Unknown
MedicationRequest.reasonCode | Base | preferred | Reason for Request | ⏿1.0.1 | tx.hl7.org.au
MedicationRequest.substitution.​reason | Base | preferred | Medicine Substitution Reason | ⏿1.0.1 | tx.hl7.org.au

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | 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 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 | ?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
category |  | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
reported[x] | Σ | 0..1 |  | Reported rather than primary record
reportedBoolean |  |  | boolean |
reportedReference |  |  | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) |
Slices for medication[x] | Σ | 1..1 |  | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
medicationCodeableConcept |  |  | CodeableConcept |
medicationReference |  |  | Reference(Medication) |
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
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
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
Slices for extension |  |  |  | Content/Rules for all slices
extension:medicationClass |  | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
system | Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Medication primary text
medication[x]:medicationReference | Σ | 0..1 | Reference(Medication) | Prescribed Medication
subject | Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for
encounter |  | 0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay
Slices for supportingInformation |  | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve()
supportingInformation:bodyHeight |  | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height
supportingInformation:bodyWeight |  | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight
authoredOn | Σ | 0..1 | dateTime | Created date
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request
performer |  | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
recorder |  | 0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
reasonReference |  | 0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written
instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of
courseOfTherapyType |  | 0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
insurance |  | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage
note |  | 0..* | Annotation | Information about the prescription
dosageInstruction |  | 0..* | AUBaseDosage | How the medication should be taken
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.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.substitution.​allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.3
MedicationRequest.substitution.​reason | Base | preferred | Medicine Substitution Reason | ⏿1.0.1 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 MedicationRequest

Summary

Structures

This structure refers to these other structures:

- Observation Body Height Profile (http://hl7.org/fhir/StructureDefinition/bodyheight)
- Observation Body Weight Profile (http://hl7.org/fhir/StructureDefinition/bodyweight)
- AU Base Dosage (http://hl7.org.au/fhir/StructureDefinition/au-dosage)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse|5.3.0
- http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
- http://hl7.org.au/fhir/StructureDefinition/medication-type

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of MedicationRequest.medication[x] (Closed)
- The element 1 is sliced based on the value of MedicationRequest.supportingInformation

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | 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 |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:sexParameterForClinicalUse |  | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:subsidisedConcurrentSupply |  | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request
status | ?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
Slices for medication[x] | Σ | 1..1 |  | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
medicationCodeableConcept |  |  | CodeableConcept |
medicationReference |  |  | Reference(Medication) |
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
Australian Medication | Preferred
PBS Item Codes | Preferred
MIMS | Preferred
GTIN | Preferred
text | Σ | 0..1 | string | Medication primary text
medication[x]:medicationReference | Σ | 0..1 | Reference(Medication) | Prescribed Medication
subject | Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for
Slices for supportingInformation |  | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve()
supportingInformation:bodyHeight |  | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height
supportingInformation:bodyWeight |  | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight
authoredOn | Σ | 0..1 | dateTime | Created date
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
dosageInstruction |  | 0..* | AUBaseDosage | How the medication should be taken
dispenseRequest |  | 0..1 | BackboneElement | Requested dispensing
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
numberOfRepeatsAllowed |  | 0..1 | unsignedInt | Maximum repeats authorised
substitution |  | 0..1 | BackboneElement | Brand substitution details
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)
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.reasonCode | Base | preferred | Reason for Request | ⏿1.0.1 | tx.hl7.org.au
MedicationRequest.substitution.​allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.3
MedicationRequest.substitution.​reason | Base | preferred | Medicine Substitution Reason | ⏿1.0.1 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 MedicationRequest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | A request for a medication for a patient in an Australian healthcare context
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)
identifier |  | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request
Slices for medication[x] |  | 1..1 | CodeableConcept, Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this
medication[x]:medicationCodeableConcept |  | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
Australian Medication | Preferred
PBS Item Codes | Preferred
MIMS | Preferred
GTIN | Preferred
coding |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
Slices for extension |  |  |  | Content/Rules for all slices
extension:medicationClass |  | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
text |  | 0..1 | string | Medication primary text
medication[x]:medicationReference |  | 0..1 | Reference(Medication) | Prescribed Medication
Slices for supportingInformation |  | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve()
supportingInformation:bodyHeight |  | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height
supportingInformation:bodyWeight |  | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight
authoredOn |  | 0..1 | dateTime | Created date
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
dosageInstruction |  | 0..* | AUBaseDosage | How the medication should be taken
dispenseRequest |  | 0..1 | BackboneElement | Requested dispensing
numberOfRepeatsAllowed |  | 0..1 | unsignedInt | Maximum repeats authorised
substitution |  | 0..1 | BackboneElement | Brand substitution details
allowed[x] |  | 1..1 | boolean, CodeableConcept | Brand substitution flag
reason |  | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: Medicine Substitution Reason (preferred)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
MedicationRequest.medication[x]:medicationCodeableConcept | Base | example |  | Not State | Unknown
MedicationRequest.reasonCode | Base | preferred | Reason for Request | ⏿1.0.1 | tx.hl7.org.au
MedicationRequest.substitution.​reason | Base | preferred | Medicine Substitution Reason | ⏿1.0.1 | tx.hl7.org.au

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | 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 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 | ?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order.
category |  | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
reported[x] | Σ | 0..1 |  | Reported rather than primary record
reportedBoolean |  |  | boolean |
reportedReference |  |  | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) |
Slices for medication[x] | Σ | 1..1 |  | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
medicationCodeableConcept |  |  | CodeableConcept |
medicationReference |  |  | Reference(Medication) |
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
Additional Bindings | Purpose
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
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
Slices for extension |  |  |  | Content/Rules for all slices
extension:medicationClass |  | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
system | Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Medication primary text
medication[x]:medicationReference | Σ | 0..1 | Reference(Medication) | Prescribed Medication
subject | Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for
encounter |  | 0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay
Slices for supportingInformation |  | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve()
supportingInformation:bodyHeight |  | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height
supportingInformation:bodyWeight |  | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight
authoredOn | Σ | 0..1 | dateTime | Created date
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request
performer |  | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
recorder |  | 0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred)
reasonReference |  | 0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written
instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of
courseOfTherapyType |  | 0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
insurance |  | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage
note |  | 0..* | Annotation | Information about the prescription
dosageInstruction |  | 0..* | AUBaseDosage | How the medication should be taken
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.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.substitution.​allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.3
MedicationRequest.substitution.​reason | Base | preferred | Medicine Substitution Reason | ⏿1.0.1 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 MedicationRequest

Summary

Structures

This structure refers to these other structures:

- Observation Body Height Profile (http://hl7.org/fhir/StructureDefinition/bodyheight)
- Observation Body Weight Profile (http://hl7.org/fhir/StructureDefinition/bodyweight)
- AU Base Dosage (http://hl7.org.au/fhir/StructureDefinition/au-dosage)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse|5.3.0
- http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
- http://hl7.org.au/fhir/StructureDefinition/medication-type

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of MedicationRequest.medication[x] (Closed)
- The element 1 is sliced based on the value of MedicationRequest.supportingInformation

Maturity: 2

Other representations of profile: CSV, Excel, Schematron