Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, 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:

  • Grounds for 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 Tue Oct 22 00:00:00 AEDT 2019 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
... grounds-for-concurrent-supply 0..1CodingGrounds for Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
... 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
....... 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 I0..*MedicationRequestA prescription for a medication for a patient in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... grounds-for-concurrent-supply I0..1CodingGrounds for Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
... minimum-interval-between-repeats I0..1DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*(Slice Definition)External ids for this request
Slice: Unordered, Open by value:system, value:type
.... identifier:etpVendorIdentifier I0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: ETP
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: ETP Identifier
..... system ΣI1..1uriETP vendor identifier system URL
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringETP vendor identifier
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI1..1Reference(Organization)ETP vendor
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringETP vendor name
.... identifier:localScriptNumber I0..*IdentifierLocal Prescription Number
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptCoded identifier type for local prescription number
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
..... system ΣI1..1uriNamespace for local prescription number
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringPrescription number
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI1..1Reference(Organization)Organization that issued id (may be just text)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringText alternative for the resource
... status ?!ΣI1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required)
... statusReason I0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example)
... intent ?!ΣI1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required)
... category I0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if request is prohibiting action
... reported[x] ΣI0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] ΣI1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept ΣI0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs ΣI0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:gtin ΣI0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:amt ΣI0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type I0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage ΣI0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringMedication primary text
.... medication[x]:medicationReference ΣI0..1Reference(AU Base Medication)Prescribed Medication
... subject ΣI1..1Reference(Patient | Group)Who or group medication request is for
... encounter I0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation I0..*(Slice Definition)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight I0..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight I0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn ΣI0..1dateTimeCreated date
... requester ΣI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/What requested the Request
... performer I0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType ΣI0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example)
... recorder I0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode I0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference I0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical ΣI0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier ΣI0..1IdentifierComposite request this is part of
... courseOfTherapyType I0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example)
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note I0..*AnnotationInformation about the prescription
... dosageInstruction I0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest I0..1BackboneElementRequested dispensing
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill I0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity I0..1SimpleQuantityFirst fill quantity
..... duration I0..1DurationFirst fill duration
.... dispenseInterval I0..1DurationMinimum period of time between dispenses
.... validityPeriod I0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed I0..1unsignedIntMaximum repeats authorised
.... quantity I0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration I0..1DurationNumber of days supply per dispense
.... performer I0..1Reference(Organization)Intended dispenser
... substitution I0..1BackboneElementBrand substitution details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] I1..1Brand substitution flag
Binding: V3 Value SetActSubstanceAdminSubstitutionCode (example)
..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason I0..1CodeableConceptWhy should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
... priorPrescription I0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue I0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory I0..*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
... grounds-for-concurrent-supply 0..1CodingGrounds for Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
... 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
....... 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 I0..*MedicationRequestA prescription for a medication for a patient in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... grounds-for-concurrent-supply I0..1CodingGrounds for Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
... minimum-interval-between-repeats I0..1DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*(Slice Definition)External ids for this request
Slice: Unordered, Open by value:system, value:type
.... identifier:etpVendorIdentifier I0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: ETP
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: ETP Identifier
..... system ΣI1..1uriETP vendor identifier system URL
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringETP vendor identifier
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI1..1Reference(Organization)ETP vendor
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringETP vendor name
.... identifier:localScriptNumber I0..*IdentifierLocal Prescription Number
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptCoded identifier type for local prescription number
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: LPN
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
..... system ΣI1..1uriNamespace for local prescription number
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringPrescription number
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI1..1Reference(Organization)Organization that issued id (may be just text)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringText alternative for the resource
... status ?!ΣI1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required)
... statusReason I0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example)
... intent ?!ΣI1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required)
... category I0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if request is prohibiting action
... reported[x] ΣI0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] ΣI1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept ΣI0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs ΣI0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:gtin ΣI0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:amt ΣI0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type I0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage ΣI0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringMedication primary text
.... medication[x]:medicationReference ΣI0..1Reference(AU Base Medication)Prescribed Medication
... subject ΣI1..1Reference(Patient | Group)Who or group medication request is for
... encounter I0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation I0..*(Slice Definition)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight I0..1Reference(Observation Body Height Profile)Observation of Body Height
.... supportingInformation:bodyWeight I0..1Reference(Observation Body Weight Profile)Observation of Body Weight
... authoredOn ΣI0..1dateTimeCreated date
... requester ΣI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/What requested the Request
... performer I0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType ΣI0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example)
... recorder I0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode I0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference I0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical ΣI0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier ΣI0..1IdentifierComposite request this is part of
... courseOfTherapyType I0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example)
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note I0..*AnnotationInformation about the prescription
... dosageInstruction I0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest I0..1BackboneElementRequested dispensing
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill I0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity I0..1SimpleQuantityFirst fill quantity
..... duration I0..1DurationFirst fill duration
.... dispenseInterval I0..1DurationMinimum period of time between dispenses
.... validityPeriod I0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed I0..1unsignedIntMaximum repeats authorised
.... quantity I0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration I0..1DurationNumber of days supply per dispense
.... performer I0..1Reference(Organization)Intended dispenser
... substitution I0..1BackboneElementBrand substitution details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] I1..1Brand substitution flag
Binding: V3 Value SetActSubstanceAdminSubstitutionCode (example)
..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason I0..1CodeableConceptWhy should (not) substitution be made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
... priorPrescription I0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue I0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory I0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-medicationrequest

none defined