AU Core Implementation Guide
0.3.0-ballot - R1 Australia flag

This page is part of the AU Core (v0.3.0-ballot: AU Core R1 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core MedicationRequest

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationrequest Version: 0.3.0-ballot
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreMedicationRequest

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a MedicationRequest resource to record, search, and fetch medication orders and requests (i.e. prescriptions) associated with a patient. It is based on the AU Base Medication Request profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the MedicationRequest when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query medication orders or prescriptions for a patient (current and historical)
  • Record or update medication orders or prescriptions for a patient

Comparison with other national and international specifications

A resource conforming to this profile:

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • See the Medicine information section for guidance
  • When recording “self-prescribed” medication, MedicationRequest.requester references the Patient or RelatedPerson as the prescriber.
  • MedicationRequest resources can represent a medication using either a code with MedicationRequest.medicationCodeableConcept, or reference a Medication resource with MedicationRequest.medicationReference.
    • Although both are marked as must support, servers are not required to support both a code and a reference, but they SHALL support at least one of these elements
    • A client application SHALL support both elements
    • When referencing a Medication resource, it is preferred the resource is contained but it may be an external resource
  • Source system identifiers SHOULD be included as AU Local Prescription Identifier or AU ETP Prescription Identifier to support electronic medication management (EMM) workflow and deduplication across medication resources.
    • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseMedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*AUBaseMedicationRequestA request for a medication for a patient in an Australian healthcare context
... identifier S0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
... status S1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
... intent S1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
... Slices for medication[x] S1..1CodeableConcept, Reference(Medication)Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Prescribed Medication
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs S0..*CodingPBS Item Code
...... coding:amt S0..*CodingAMT Medicines
.... medication[x]:medicationReference 0..1Reference(AU Core Medication)Prescribed Medication
... subject S1..1Reference(AU Core Patient)Who or group medication request is for
... encounter S0..1Reference(AU Core Encounter)Encounter created as part of encounter/admission/stay
... authoredOn SC1..1dateTimeCreated date
au-core-medreq-03: Date shall be at least to day
... requester S1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who/What requested the Request
... reasonCode S0..*CodeableConceptReason or indication for ordering or not ordering the medication
... note S0..*AnnotationInformation about the prescription
... dosageInstruction S0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest S0..1BackboneElementRequested dispensing
.... validityPeriod S0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed S0..1unsignedIntMaximum repeats authorised
.... quantity S0..1SimpleQuantityAmount of medication to supply per dispense
... substitution S0..1BackboneElementBrand substitution details
.... allowed[x] S1..1boolean, CodeableConceptBrand substitution flag

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationRequest.categoryextensiblemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-medreq-03errorMedicationRequest.authoredOnDate shall be at least to day
: toString().length() >= 10
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*AUBaseMedicationRequestA request for a medication for a patient in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeactive | 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..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... category S0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (extensible)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... Slices for medication[x] SΣ1..1Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt SΣ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ0..1Reference(AU Core Medication)Prescribed Medication
... subject SΣ1..1Reference(AU Core Patient)Who or group medication request is for
... encounter S0..1Reference(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..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn SΣC1..1dateTimeCreated date
au-core-medreq-03: Date shall be at least to day
... requester SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who/What requested the Request
... reasonCode S0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Reason for Request . (preferred)
... note S0..*AnnotationInformation about the prescription
... dosageInstruction S0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest S0..1BackboneElementRequested dispensing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... validityPeriod S0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed S0..1unsignedIntMaximum repeats authorised
.... quantity S0..1SimpleQuantityAmount of medication to supply per dispense
... substitution S0..1BackboneElementBrand substitution details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] S1..1Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryextensiblemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
MedicationRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode

Constraints

IdGradePath(s)DetailsRequirements
au-core-medreq-03errorMedicationRequest.authoredOnDate shall be at least to day
: toString().length() >= 10
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*AUBaseMedicationRequestA request for a medication for a patient in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
... status ?!SΣ1..1codeactive | 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..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

... intent ?!SΣ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... category S0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (extensible)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] SΣ1..1Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:amt SΣ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringMedication primary text
.... medication[x]:medicationReference Σ0..1Reference(AU Core Medication)Prescribed Medication
... subject SΣ1..1Reference(AU Core Patient)Who or group medication request is for
... encounter S0..1Reference(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..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn SΣC1..1dateTimeCreated date
au-core-medreq-03: Date shall be at least to day
... requester SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who/What requested the Request
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode S0..*CodeableConceptReason 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..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall 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 S0..*AnnotationInformation about the prescription
... dosageInstruction S0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest S0..1BackboneElementRequested dispensing
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill 0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod S0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed S0..1unsignedIntMaximum repeats authorised
.... quantity S0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution S0..1BackboneElementBrand substitution details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] S1..1Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: Medicine Substitution Reason . (preferred)
... priorPrescription 0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
from the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryextensiblemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
MedicationRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
from the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-medreq-03errorMedicationRequest.authoredOnDate shall be at least to day
: toString().length() >= 10
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseMedicationRequest

Differential View

This structure is derived from AUBaseMedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*AUBaseMedicationRequestA request for a medication for a patient in an Australian healthcare context
... identifier S0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
... status S1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
... intent S1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
... Slices for medication[x] S1..1CodeableConcept, Reference(Medication)Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Prescribed Medication
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs S0..*CodingPBS Item Code
...... coding:amt S0..*CodingAMT Medicines
.... medication[x]:medicationReference 0..1Reference(AU Core Medication)Prescribed Medication
... subject S1..1Reference(AU Core Patient)Who or group medication request is for
... encounter S0..1Reference(AU Core Encounter)Encounter created as part of encounter/admission/stay
... authoredOn SC1..1dateTimeCreated date
au-core-medreq-03: Date shall be at least to day
... requester S1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who/What requested the Request
... reasonCode S0..*CodeableConceptReason or indication for ordering or not ordering the medication
... note S0..*AnnotationInformation about the prescription
... dosageInstruction S0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest S0..1BackboneElementRequested dispensing
.... validityPeriod S0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed S0..1unsignedIntMaximum repeats authorised
.... quantity S0..1SimpleQuantityAmount of medication to supply per dispense
... substitution S0..1BackboneElementBrand substitution details
.... allowed[x] S1..1boolean, CodeableConceptBrand substitution flag

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationRequest.categoryextensiblemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-medreq-03errorMedicationRequest.authoredOnDate shall be at least to day
: toString().length() >= 10

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*AUBaseMedicationRequestA request for a medication for a patient in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeactive | 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..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... category S0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (extensible)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... Slices for medication[x] SΣ1..1Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt SΣ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ0..1Reference(AU Core Medication)Prescribed Medication
... subject SΣ1..1Reference(AU Core Patient)Who or group medication request is for
... encounter S0..1Reference(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..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn SΣC1..1dateTimeCreated date
au-core-medreq-03: Date shall be at least to day
... requester SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who/What requested the Request
... reasonCode S0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Reason for Request . (preferred)
... note S0..*AnnotationInformation about the prescription
... dosageInstruction S0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest S0..1BackboneElementRequested dispensing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... validityPeriod S0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed S0..1unsignedIntMaximum repeats authorised
.... quantity S0..1SimpleQuantityAmount of medication to supply per dispense
... substitution S0..1BackboneElementBrand substitution details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] S1..1Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryextensiblemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
MedicationRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode

Constraints

IdGradePath(s)DetailsRequirements
au-core-medreq-03errorMedicationRequest.authoredOnDate shall be at least to day
: toString().length() >= 10
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*AUBaseMedicationRequestA request for a medication for a patient in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
... status ?!SΣ1..1codeactive | 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..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

... intent ?!SΣ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... category S0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (extensible)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] SΣ1..1Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:amt SΣ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringMedication primary text
.... medication[x]:medicationReference Σ0..1Reference(AU Core Medication)Prescribed Medication
... subject SΣ1..1Reference(AU Core Patient)Who or group medication request is for
... encounter S0..1Reference(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..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn SΣC1..1dateTimeCreated date
au-core-medreq-03: Date shall be at least to day
... requester SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who/What requested the Request
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode S0..*CodeableConceptReason 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..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall 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 S0..*AnnotationInformation about the prescription
... dosageInstruction S0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest S0..1BackboneElementRequested dispensing
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill 0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod S0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed S0..1unsignedIntMaximum repeats authorised
.... quantity S0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution S0..1BackboneElementBrand substitution details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] S1..1Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: Medicine Substitution Reason . (preferred)
... priorPrescription 0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
from the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryextensiblemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
MedicationRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
from the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-medreq-03errorMedicationRequest.authoredOnDate shall be at least to day
: toString().length() >= 10
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseMedicationRequest

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
patient SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
patient+intent SHALL reference+token
patient+intent+status SHALL reference+token+token
_id SHOULD token
identifier SHOULD token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
patient.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both.

The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
patient+intent+authoredon SHOULD reference+token+date
authoredon MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.
category MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
intent MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters

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

  1. SHALL support searching using the patient search parameter:
    • SHOULD support these _include parameters: MedicationRequest:medication
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/MedicationRequest?patient={Type/}[id] or optionally GET [base]/MedicationRequest?patient.identifier=[system|][code]

    Example:

    1. GET [base]/MedicationRequest?patient=5678
    2. GET [base]/MedicationRequest?patient=5678&_revinclude=Provenance:target
    3. GET [base]/MedicationRequest?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    4. GET [base]/MedicationRequest?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952&_include=MedicationRequest:medication
    5. GET [base]/MedicationRequest?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

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

  2. SHALL support searching using the combination of the patient and intent search parameters:
    • SHOULD support these _include parameters: MedicationRequest:medication
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/MedicationRequest?patient={Type/}[id]&intent={system|}[code]

    Example:

    1. GET [base]/MedicationRequest?patient=5678&intent=order

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

  3. SHALL support searching using the combination of the patient and intent and status search parameters:
    • SHOULD support these _include parameters: MedicationRequest:medication
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)
    • SHALL support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/MedicationRequest?patient={Type/}[id]&intent={system|}[code]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/MedicationRequest?patient=5678&intent=order&status=active
    2. GET [base]/MedicationRequest?patient=5678&intent=order&status=active&_include=MedicationRequest:medication

    Implementation Notes: Fetches a bundle of all MedicationRequest resources for the specified patient and authored on date and intent (how to search by reference and how to search by token)

Optional Search Parameters

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

  1. SHOULD support fetching a MedicationRequest using the _id search parameter:
    • SHOULD support these _include parameters: MedicationRequest:medication

    GET [base]/MedicationRequest/[id] or GET [base]/MedicationRequest?_id=[id]

    Example:

    1. GET [base]/MedicationRequest/2169591
    2. GET [base]/MedicationRequest?_id=2169591
    3. GET [base]/MedicationRequest?_id=2169591&_include=MedicationRequest:medication

    Implementation Notes: Fetches a single MedicationRequest (how to search by the logical id of the resource)

  2. SHOULD support searching using the identifier search parameter:

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

    Example:

    1. GET [base]/MedicationRequest?identifier=http://gp.example.org|1032333

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

  3. SHOULD support searching using the combination of the patient and intent and authoredon search parameters:
    • SHOULD support these _include parameters: MedicationRequest:medication
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support these authoredon comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on authoredon (e.g.authoredon=[date]&authoredon=[date]]&...)

    GET [base]/MedicationRequest?patient={Type/}[id]&intent={system|}[code]&authoredon={gt|lt|ge|le}[date]{&authoredon={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/MedicationRequest?patient=5678&intent=order&authoredon=ge2020-01-01T00:00:00Z

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