Helix AU Core
0.1.0 - ci-build

Helix AU Core - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Helix AU Core MedicationRequest

Official URL: http://medicaldirector.com/fhir/helix-au-core/StructureDefinition/HelixAUCoreMedicationRequest Version: 0.1.0
Draft as of 2025-12-09 Computable Name: HelixAUCoreMedicationRequest

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... extension:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey External ids for this request
.... identifier:etp-prescription S 0..1 HelixAUErxEtpIdentifier External ids for this request
... status ?!SΣ 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 ?!SΣ 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 S 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (extensible)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... Slices for medication[x] SΣ 1..1 Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs SΣ 0..* Coding PBS Item Code
Binding: PBS Item Codes (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt SΣ 0..* Coding AMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... 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 Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ 0..1 Reference(AU Core Medication) Prescribed Medication
... subject SΣ 1..1 Reference(AU Core Patient) Who or group medication request is for
... encounter S 0..1 Reference(AU Core 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 SΣC 1..1 dateTime Created date
Constraints: au-core-medreq-03
... requester SΣ 1..1 Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) Who/What requested the Request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 0..* AUBaseDosage Dosage information in an Australian healthcare context
... dispenseRequest S 0..1 BackboneElement Requested dispensing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... validityPeriod S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Maximum repeats authorised
.... quantity S 0..1 SimpleQuantity Amount of medication to supply per dispense
... substitution S 0..1 BackboneElement Brand substitution details
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] S 1..1 Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept

doco 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.category Base extensible Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x] Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x]:medicationCodeableConcept Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:pbs Base preferred PBS Item Codes 📦4.1.0 AU Base Implementation Guide v4.1
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:gtin Base preferred GTIN 📦3.0.0 THO v7.0
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:amt Base preferred https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 Not State Unknown
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:mimsPackage Base preferred MIMS 📦4.1.0 AU Base Implementation Guide v4.1
MedicationRequest.reasonCode Base preferred https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 Not State Unknown
MedicationRequest.substitution.​allowed[x] Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.0

Constraints

Id Grade Path(s) Description Expression
au-core-medreq-03 error MedicationRequest.authoredOn Date shall be at least to day toString().length() >= 10
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AUCoreMedicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* AUCoreMedicationRequest A request for a medication for a patient in an Australian healthcare context
... Slices for identifier 1..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey External ids for this request
.... identifier:etp-prescription 0..1 HelixAUErxEtpIdentifier External ids for this request

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
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:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey External ids for this request
.... identifier:etp-prescription S 0..1 HelixAUErxEtpIdentifier External ids for this request
... status ?!SΣ 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 ?!SΣ 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 S 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (extensible)
... 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] SΣ 1..1 Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs SΣ 0..* Coding PBS Item Code
Binding: PBS Item Codes (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:amt SΣ 0..* Coding AMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Medication primary text
.... medication[x]:medicationReference Σ 0..1 Reference(AU Core Medication) Prescribed Medication
... subject SΣ 1..1 Reference(AU Core Patient) Who or group medication request is for
... encounter S 0..1 Reference(AU Core 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 SΣC 1..1 dateTime Created date
Constraints: au-core-medreq-03
... requester SΣ 1..1 Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) Who/What requested the Request
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 0..* AUBaseDosage Dosage information in an Australian healthcare context
... dispenseRequest S 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 S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Maximum repeats authorised
.... quantity S 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 S 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] S 1..1 Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco 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 extensible Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
MedicationRequest.medication[x] Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x]:medicationCodeableConcept Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:pbs Base preferred PBS Item Codes 📦4.1.0 AU Base Implementation Guide v4.1
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:gtin Base preferred GTIN 📦3.0.0 THO v7.0
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:amt Base preferred https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 Not State Unknown
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:mimsPackage Base preferred MIMS 📦4.1.0 AU Base Implementation Guide v4.1
MedicationRequest.performerType Base example Procedure Performer Role Codes 📦4.0.1 FHIR Std.
MedicationRequest.reasonCode Base preferred https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 Not State Unknown
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.0
MedicationRequest.substitution.​reason Base preferred https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
au-core-medreq-03 error MedicationRequest.authoredOn Date shall be at least to day toString().length() >= 10
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AUCoreMedicationRequest

Summary

Mandatory: 2 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationRequest.identifier (Open at End)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... extension:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey External ids for this request
.... identifier:etp-prescription S 0..1 HelixAUErxEtpIdentifier External ids for this request
... status ?!SΣ 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 ?!SΣ 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 S 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (extensible)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... Slices for medication[x] SΣ 1..1 Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs SΣ 0..* Coding PBS Item Code
Binding: PBS Item Codes (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt SΣ 0..* Coding AMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... 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 Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ 0..1 Reference(AU Core Medication) Prescribed Medication
... subject SΣ 1..1 Reference(AU Core Patient) Who or group medication request is for
... encounter S 0..1 Reference(AU Core 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 SΣC 1..1 dateTime Created date
Constraints: au-core-medreq-03
... requester SΣ 1..1 Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) Who/What requested the Request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 0..* AUBaseDosage Dosage information in an Australian healthcare context
... dispenseRequest S 0..1 BackboneElement Requested dispensing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... validityPeriod S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Maximum repeats authorised
.... quantity S 0..1 SimpleQuantity Amount of medication to supply per dispense
... substitution S 0..1 BackboneElement Brand substitution details
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] S 1..1 Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept

doco 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.category Base extensible Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x] Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x]:medicationCodeableConcept Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:pbs Base preferred PBS Item Codes 📦4.1.0 AU Base Implementation Guide v4.1
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:gtin Base preferred GTIN 📦3.0.0 THO v7.0
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:amt Base preferred https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 Not State Unknown
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:mimsPackage Base preferred MIMS 📦4.1.0 AU Base Implementation Guide v4.1
MedicationRequest.reasonCode Base preferred https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 Not State Unknown
MedicationRequest.substitution.​allowed[x] Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.0

Constraints

Id Grade Path(s) Description Expression
au-core-medreq-03 error MedicationRequest.authoredOn Date shall be at least to day toString().length() >= 10
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from AUCoreMedicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* AUCoreMedicationRequest A request for a medication for a patient in an Australian healthcare context
... Slices for identifier 1..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey External ids for this request
.... identifier:etp-prescription 0..1 HelixAUErxEtpIdentifier External ids for this request

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
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:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey External ids for this request
.... identifier:etp-prescription S 0..1 HelixAUErxEtpIdentifier External ids for this request
... status ?!SΣ 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 ?!SΣ 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 S 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (extensible)
... 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] SΣ 1..1 Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs SΣ 0..* Coding PBS Item Code
Binding: PBS Item Codes (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:amt SΣ 0..* Coding AMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Medication primary text
.... medication[x]:medicationReference Σ 0..1 Reference(AU Core Medication) Prescribed Medication
... subject SΣ 1..1 Reference(AU Core Patient) Who or group medication request is for
... encounter S 0..1 Reference(AU Core 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 SΣC 1..1 dateTime Created date
Constraints: au-core-medreq-03
... requester SΣ 1..1 Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) Who/What requested the Request
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
... reasonCode S 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note S 0..* Annotation Information about the prescription
... dosageInstruction S 0..* AUBaseDosage Dosage information in an Australian healthcare context
... dispenseRequest S 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 S 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed S 0..1 unsignedInt Maximum repeats authorised
.... quantity S 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 S 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] S 1..1 Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco 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 extensible Medication request category codes 📦4.0.1 FHIR Std.
MedicationRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
MedicationRequest.medication[x] Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x]:medicationCodeableConcept Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:pbs Base preferred PBS Item Codes 📦4.1.0 AU Base Implementation Guide v4.1
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:gtin Base preferred GTIN 📦3.0.0 THO v7.0
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:amt Base preferred https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 Not State Unknown
MedicationRequest.medication[x]:medicationCodeableConcept.​coding:mimsPackage Base preferred MIMS 📦4.1.0 AU Base Implementation Guide v4.1
MedicationRequest.performerType Base example Procedure Performer Role Codes 📦4.0.1 FHIR Std.
MedicationRequest.reasonCode Base preferred https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 Not State Unknown
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.0
MedicationRequest.substitution.​reason Base preferred https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
au-core-medreq-03 error MedicationRequest.authoredOn Date shall be at least to day toString().length() >= 10
dom-2 error MedicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AUCoreMedicationRequest

Summary

Mandatory: 2 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationRequest.identifier (Open at End)

 

Other representations of profile: CSV, Excel, Schematron