Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

1.0 StructureDefinition-au-medicationrequest

AU Base Medication Request [FMM Level 2]

This profile defines a medication request structure including core localisation concepts for use as a medication prescription or order in an Australian context.

Medication Reference/Coding

Full medication definitions as a Medication resource can be referenced or codings are use be used to define relevant drug/medication concepts. This includes coding as:

  • PBS Item Code - Pharmaceutical Benefits Scheme coding, claiming context is not relevant as medicine coding.
  • GTIN - Global Trade Item Number, physical product reference.
  • AMT Code - Australian Medicines Terminology, national drug terminology.
  • MIMS Package - commonly used medicine coding.

Identifiers

These definitions represent common data held in the MedicationRequest.identifier element:

  • Electronic Transfer of Prescription Supplier Identifier - ETP vendor system identifier
  • Local Prescription Number - prescription system identifier for this record [1]

Extensions

Extensions used in this profile:

  • Subsidised Concurrent Supply of Medication [1]
  • Minimum Interval Between Repeats [1]
  • MedicationRequest.medication.coding: Medication Type [1] - used to distinguish a level classification when the same coding system is used.
  • Medication Brand Name [1] - Not to be used if medicationReference is used. This text-only extension is supplied to support a brand name where no brand concept coding is available. Use medicationCodeableConcept if a brand concept coding is available.
  • Medication Generic Drug Name [1] - Not to be used if medicationReference is used. This text-only extension is supplied to support a generic name where no generic concept coding is available. Use medicationCodeableConcept if a generic concept coding is available.
  • NOTE: if extensions Medication Brand Name or Medication Generic Drug Name are used then medicationCodeableConcept must also be used.

Examples

Prescription for Stribild with concurrent supply

Prescription for paracetamol + codeine

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-medicationrequest

This profile defines a medication request structure including core localisation concepts for use as a prescription in an Australian context.

This profile builds on MedicationRequest.

This profile was published on Wed Jan 22 00:00:00 UTC 2020 as a draft by Health Level Seven Australia (Medications WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA prescription for a medication for a patient in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidised-concurrent-supply 0..1CodingSubsidised Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Grounds for Concurrent Supply (required)
... minimum-interval-between-repeats 0..1DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name 0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... identifier 0..*(Slice Definition)External ids for this request
Slice: Unordered, Open by value:system, value:type
.... identifier:etpVendorIdentifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
..... type 1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... coding 1..1CodingCode defined by a terminology system
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeSymbol in syntax defined by the system
Fixed Value: ETP
...... text 1..1stringPlain text representation of the concept
Fixed Value: ETP Identifier
..... system 1..1uriETP vendor identifier system URL
..... value 1..1stringETP vendor identifier
..... assigner 1..1Reference(Organization)ETP vendor
...... display 1..1stringETP vendor name
.... identifier:localScriptNumber 0..*IdentifierLocal Prescription Number
..... type 1..1CodeableConceptCoded identifier type for local prescription number
Binding: V2 Identifier Type - AU Extended (required)
...... coding 1..1CodingCode defined by a terminology system
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
...... text 1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
..... system 1..1uriNamespace for local prescription number
..... value 1..1stringPrescription number
..... assigner 1..1Reference(Organization)Organization that issued id (may be just text)
...... display 1..1stringText alternative for the resource
... medication[x] 1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Prescribed Medication
..... coding 0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Medicines 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 for Medicines (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)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type 0..1CodingClass of Medication Coding
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 Terminology (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(AU Base Medication)Prescribed Medication
... supportingInformation 0..*(Slice Definition)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
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA prescription for a medication for a patient in an Australian healthcare context
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidised-concurrent-supply 0..1CodingSubsidised Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Grounds for Concurrent Supply (required)
... minimum-interval-between-repeats 0..1DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name 0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*(Slice Definition)External ids for this request
Slice: Unordered, Open by value:system, value:type
.... identifier:etpVendorIdentifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... 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://hl7.org.au/fhir/v2/0203
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: ETP
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: ETP Identifier
..... system Σ1..1uriETP vendor identifier system URL
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringETP vendor identifier
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)ETP vendor
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringETP vendor name
.... identifier:localScriptNumber 0..*IdentifierLocal Prescription Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for local prescription number
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... 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://hl7.org.au/fhir/v2/0203
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
..... system Σ1..1uriNamespace for local prescription number
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringPrescription number
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringText alternative for the resource
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required)
... statusReason 0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example)
... intent ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required)
... category 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] Σ1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Medicines 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 for Medicines (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
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type 0..1CodingClass of Medication Coding
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 Terminology (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 Base 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
... supportingInformation 0..*(Slice Definition)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)
... 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)
... 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)
..... 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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA prescription for a medication for a patient in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidised-concurrent-supply 0..1CodingSubsidised Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Grounds for Concurrent Supply (required)
... minimum-interval-between-repeats 0..1DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name 0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... identifier 0..*(Slice Definition)External ids for this request
Slice: Unordered, Open by value:system, value:type
.... identifier:etpVendorIdentifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
..... type 1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... coding 1..1CodingCode defined by a terminology system
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeSymbol in syntax defined by the system
Fixed Value: ETP
...... text 1..1stringPlain text representation of the concept
Fixed Value: ETP Identifier
..... system 1..1uriETP vendor identifier system URL
..... value 1..1stringETP vendor identifier
..... assigner 1..1Reference(Organization)ETP vendor
...... display 1..1stringETP vendor name
.... identifier:localScriptNumber 0..*IdentifierLocal Prescription Number
..... type 1..1CodeableConceptCoded identifier type for local prescription number
Binding: V2 Identifier Type - AU Extended (required)
...... coding 1..1CodingCode defined by a terminology system
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
...... text 1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
..... system 1..1uriNamespace for local prescription number
..... value 1..1stringPrescription number
..... assigner 1..1Reference(Organization)Organization that issued id (may be just text)
...... display 1..1stringText alternative for the resource
... medication[x] 1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Prescribed Medication
..... coding 0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Medicines 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 for Medicines (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)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type 0..1CodingClass of Medication Coding
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 Terminology (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(AU Base Medication)Prescribed Medication
... supportingInformation 0..*(Slice Definition)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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestA prescription for a medication for a patient in an Australian healthcare context
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidised-concurrent-supply 0..1CodingSubsidised Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Grounds for Concurrent Supply (required)
... minimum-interval-between-repeats 0..1DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name 0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*(Slice Definition)External ids for this request
Slice: Unordered, Open by value:system, value:type
.... identifier:etpVendorIdentifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... 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://hl7.org.au/fhir/v2/0203
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: ETP
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: ETP Identifier
..... system Σ1..1uriETP vendor identifier system URL
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringETP vendor identifier
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)ETP vendor
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringETP vendor name
.... identifier:localScriptNumber 0..*IdentifierLocal Prescription Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for local prescription number
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... 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://hl7.org.au/fhir/v2/0203
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
..... system Σ1..1uriNamespace for local prescription number
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringPrescription number
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringText alternative for the resource
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required)
... statusReason 0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example)
... intent ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required)
... category 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] Σ1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Medicines 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 for Medicines (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
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type 0..1CodingClass of Medication Coding
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 Terminology (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 Base 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
... supportingInformation 0..*(Slice Definition)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)
... 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)
... 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)
..... 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