Australian Base Implementation Guide (AU Base 1.1.1)

This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. 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 Thu May 11 09:51:36 AEST 2017 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..*ExtensionSlice: 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)Slice: Unordered, Open by value:system, value:type
.... identifier:etpVendorIdentifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
..... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
...... coding 1..1Coding
....... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeFixed Value: ETP
...... text 1..1stringFixed 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..1Coding
....... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeFixed Value: LPN
...... text 1..1stringFixed Value: Local Prescription Number
..... system 1..1uriNamespace for local prescription number
..... value 1..1stringPrescription number
..... assigner 1..1Reference(Organization)
...... display 1..1string
... medication[x] 1..1(Slice Definition)Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Prescribed Medication
..... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
...... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
....... system 1..1uriFixed Value: http://pbs.gov.au/code/item
...... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
....... system 1..1uriFixed Value: http://www.gs1.org/gtin
...... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... extension 0..*ExtensionSlice: Unordered, Open by value:url
....... medication-type 0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system 1..1uriFixed Value: http://snomed.info/sct
...... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
....... system 1..1uriFixed 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)Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight 0..1Reference(AU Body Height)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(AU Body Weight)Observation of Body Weight
... authoredOn 0..1dateTimeCreated date
... reasonCode 0..*CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (preferred)
... dosageInstruction 0..*AUBaseDosage
... dispenseRequest 0..1BackboneElementRequested dispensing
.... numberOfRepeatsAllowed 0..1positiveIntMaximum repeats authorised
... substitution 0..1BackboneElementBrand substitution details
.... allowed 1..1booleanBrand substitution flag
.... reason 0..1CodeableConceptBinding: 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..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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*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 ?!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..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... 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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringETP vendor name
.... identifier:localScriptNumber 0..*IdentifierLocal Prescription Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for local prescription number
Binding: v2 Identifier Type - AU Extended (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... 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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringText alternative for the resource
... definition Σ0..*Reference(ActivityDefinition | PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ProcedureRequest | ReferralRequest)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ0..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: MedicationRequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order | instance-order
Binding: MedicationRequestIntent (required)
... category 0..1CodeableConceptType of medication usage
Binding: MedicationRequestCategory (preferred)
... priority Σ0..1coderoutine | urgent | stat | asap
Binding: MedicationRequestPriority (required)
... medication[x] Σ1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMED CT Medication Codes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMED CT Medication Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... 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..1stringxml:id (or equivalent in JSON)
....... 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..1stringxml:id (or equivalent in JSON)
....... 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..1stringxml:id (or equivalent in JSON)
....... 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
....... 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..1stringxml:id (or equivalent in JSON)
....... 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
... context 0..1Reference(Encounter | EpisodeOfCare)Created during encounter/admission/stay
... supportingInformation 0..*(Slice Definition)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight 0..1Reference(AU Body Height)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(AU Body Weight)Observation of Body Weight
... authoredOn Σ0..1dateTimeCreated date
... requester ΣI0..1BackboneElementWho/What requested the Request
mps-1: onBehalfOf can only be specified if agent is practitioner or device
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent Σ1..1Reference(Practitioner | Organization | Patient | RelatedPerson | Device)Who ordered the initial medication(s)
.... onBehalfOf ΣI0..1Reference(Organization)Organization agent is acting for
... recorder 0..1Reference(Practitioner)Person who entered the request
... reasonCode 0..*CodeableConceptReason or indication for writing the prescription
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (preferred)
... reasonReference 0..*Reference(Condition | Observation)Condition or Observation that supports why the prescription is being written
... note 0..*AnnotationInformation about the prescription
... dosageInstruction I0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest I0..1BackboneElementRequested dispensing
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1positiveIntMaximum 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 I0..1BackboneElementBrand substitution details
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... allowed ?!1..1booleanBrand substitution flag
.... 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..*ExtensionSlice: 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)Slice: Unordered, Open by value:system, value:type
.... identifier:etpVendorIdentifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
..... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
...... coding 1..1Coding
....... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeFixed Value: ETP
...... text 1..1stringFixed 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..1Coding
....... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeFixed Value: LPN
...... text 1..1stringFixed Value: Local Prescription Number
..... system 1..1uriNamespace for local prescription number
..... value 1..1stringPrescription number
..... assigner 1..1Reference(Organization)
...... display 1..1string
... medication[x] 1..1(Slice Definition)Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Prescribed Medication
..... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
...... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
....... system 1..1uriFixed Value: http://pbs.gov.au/code/item
...... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
....... system 1..1uriFixed Value: http://www.gs1.org/gtin
...... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... extension 0..*ExtensionSlice: Unordered, Open by value:url
....... medication-type 0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system 1..1uriFixed Value: http://snomed.info/sct
...... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
....... system 1..1uriFixed 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)Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight 0..1Reference(AU Body Height)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(AU Body Weight)Observation of Body Weight
... authoredOn 0..1dateTimeCreated date
... reasonCode 0..*CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (preferred)
... dosageInstruction 0..*AUBaseDosage
... dispenseRequest 0..1BackboneElementRequested dispensing
.... numberOfRepeatsAllowed 0..1positiveIntMaximum repeats authorised
... substitution 0..1BackboneElementBrand substitution details
.... allowed 1..1booleanBrand substitution flag
.... reason 0..1CodeableConceptBinding: 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..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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*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 ?!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..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... 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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringETP vendor name
.... identifier:localScriptNumber 0..*IdentifierLocal Prescription Number
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for local prescription number
Binding: v2 Identifier Type - AU Extended (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... 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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringText alternative for the resource
... definition Σ0..*Reference(ActivityDefinition | PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ProcedureRequest | ReferralRequest)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ0..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: MedicationRequestStatus (required)
... intent ?!Σ1..1codeproposal | plan | order | instance-order
Binding: MedicationRequestIntent (required)
... category 0..1CodeableConceptType of medication usage
Binding: MedicationRequestCategory (preferred)
... priority Σ0..1coderoutine | urgent | stat | asap
Binding: MedicationRequestPriority (required)
... medication[x] Σ1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMED CT Medication Codes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Prescribed Medication
Binding: SNOMED CT Medication Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... 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..1stringxml:id (or equivalent in JSON)
....... 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..1stringxml:id (or equivalent in JSON)
....... 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..1stringxml:id (or equivalent in JSON)
....... 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
....... 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..1stringxml:id (or equivalent in JSON)
....... 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
... context 0..1Reference(Encounter | EpisodeOfCare)Created during encounter/admission/stay
... supportingInformation 0..*(Slice Definition)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
.... supportingInformation:bodyHeight 0..1Reference(AU Body Height)Observation of Body Height
.... supportingInformation:bodyWeight 0..1Reference(AU Body Weight)Observation of Body Weight
... authoredOn Σ0..1dateTimeCreated date
... requester ΣI0..1BackboneElementWho/What requested the Request
mps-1: onBehalfOf can only be specified if agent is practitioner or device
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent Σ1..1Reference(Practitioner | Organization | Patient | RelatedPerson | Device)Who ordered the initial medication(s)
.... onBehalfOf ΣI0..1Reference(Organization)Organization agent is acting for
... recorder 0..1Reference(Practitioner)Person who entered the request
... reasonCode 0..*CodeableConceptReason or indication for writing the prescription
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (preferred)
... reasonReference 0..*Reference(Condition | Observation)Condition or Observation that supports why the prescription is being written
... note 0..*AnnotationInformation about the prescription
... dosageInstruction I0..*AUBaseDosageDosage information in an Australian healthcare context
... dispenseRequest I0..1BackboneElementRequested dispensing
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1positiveIntMaximum 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 I0..1BackboneElementBrand substitution details
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... allowed ?!1..1booleanBrand substitution flag
.... 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

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