AU Base Implementation Guide
4.1.0-ballot - CI Build AU

This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Base Medication Request

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medicationrequest Version: 4.1.0-ballot
Active as of 2022-11-10 Maturity Level: 2 Computable Name: AUBaseMedicationRequest

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a medication request structure that localises core concepts, including identifiers and terminology, for use in an Australian context.

The purpose of this profile is to provide national level agreement on core localised concepts.

This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Potentially useful extensions:

Usage Notes

A full medication definition as medicationReference or medicationCodeableConcept can be included to define the drug/medication concept. Medication definition includes coding as:

Usage:

Formal Views of Profile Content

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

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA request for a medication for a patient in an Australian healthcare context
... 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: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... identifier 0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
.... 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 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 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... 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
...... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
..... text 0..1stringMedication primary text
.... medication[x]:medicationReference 0..1Reference(Medication)Prescribed Medication
... Slices for supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight 0..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn 0..1dateTimeCreated date
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest 0..1BackboneElementRequested dispensing
.... numberOfRepeatsAllowed 0..1unsignedIntMaximum repeats authorised
... substitution 0..1BackboneElementBrand substitution details
.... allowed[x] 1..1boolean, CodeableConceptBrand substitution flag
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.substitution.reasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA request for a medication for a patient in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... identifier 0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
... status ?!Σ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 ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... Slices for medication[x] Σ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 Σ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 Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... 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
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
..... text Σ0..1stringMedication primary text
.... medication[x]:medicationReference Σ0..1Reference(Medication)Prescribed Medication
... subject Σ1..1Reference(Patient | Group)Who or group medication request is for
... Slices for supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight 0..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn Σ0..1dateTimeCreated date
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest 0..1BackboneElementRequested dispensing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... numberOfRepeatsAllowed 0..1unsignedIntMaximum repeats authorised
... substitution 0..1BackboneElementBrand substitution details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA 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: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
... status ?!Σ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 ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... category 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.


... priority Σ0..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] Σ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 Σ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 Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (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(Medication)Prescribed Medication
... subject Σ1..1Reference(Patient | Group)Who or group medication request is for
... encounter 0..1Reference(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 Σ0..1dateTimeCreated date
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)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 0..*CodeableConceptReason 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..*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 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest 0..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 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntMaximum repeats authorised
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution 0..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] 1..1Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (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

PathConformanceValueSet
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

This structure is derived from MedicationRequest

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationRequest.medication[x] is sliced based on the value of type:$this (Closed)
  • The element MedicationRequest.medication[x].coding is sliced based on the value of value:system
  • The element MedicationRequest.supportingInformation is sliced based on the value of profile:resolve()

Maturity: 2

Differential View

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA request for a medication for a patient in an Australian healthcare context
... 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: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... identifier 0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
.... 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 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 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... 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
...... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
..... text 0..1stringMedication primary text
.... medication[x]:medicationReference 0..1Reference(Medication)Prescribed Medication
... Slices for supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight 0..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn 0..1dateTimeCreated date
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest 0..1BackboneElementRequested dispensing
.... numberOfRepeatsAllowed 0..1unsignedIntMaximum repeats authorised
... substitution 0..1BackboneElementBrand substitution details
.... allowed[x] 1..1boolean, CodeableConceptBrand substitution flag
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.substitution.reasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA request for a medication for a patient in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... identifier 0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
... status ?!Σ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 ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... Slices for medication[x] Σ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 Σ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 Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... 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
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
..... text Σ0..1stringMedication primary text
.... medication[x]:medicationReference Σ0..1Reference(Medication)Prescribed Medication
... subject Σ1..1Reference(Patient | Group)Who or group medication request is for
... Slices for supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight 0..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn Σ0..1dateTimeCreated date
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest 0..1BackboneElementRequested dispensing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... numberOfRepeatsAllowed 0..1unsignedIntMaximum repeats authorised
... substitution 0..1BackboneElementBrand substitution details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA 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: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifierExternal ids for this request
... status ?!Σ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 ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... category 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.


... priority Σ0..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] Σ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 Σ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 Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (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(Medication)Prescribed Medication
... subject Σ1..1Reference(Patient | Group)Who or group medication request is for
... encounter 0..1Reference(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 Σ0..1dateTimeCreated date
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)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 0..*CodeableConceptReason 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..*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 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest 0..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 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntMaximum repeats authorised
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution 0..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] 1..1Brand substitution flag
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (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

PathConformanceValueSet
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationRequest.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

This structure is derived from MedicationRequest

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationRequest.medication[x] is sliced based on the value of type:$this (Closed)
  • The element MedicationRequest.medication[x].coding is sliced based on the value of value:system
  • The element MedicationRequest.supportingInformation is sliced based on the value of profile:resolve()

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron

Notes:

none defined