Australian Base Implementation Guide (AU Base 1)

This page is part of the Australian Base IG (v1.0.2: AU Base 1 on STU3) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). 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:

  • MedicationRequest: Grounds for Concurrent Supply of Medication [1]
  • MedicationReqest: Minimum Interval Between Repeats [1]
  • MedicationRequest.medication.coding: Medication Type [1] - used to distinguish a level classification when the same coding system is used.
  • MedicationDispense: Medication Brand Name [1] - this text only extension is supplied to support brand name content where no coding is available, use medicationReference or medicationCodeable concept if code is available.
  • MedicationDispense: Medication Generic Drug Name [1] - this text only extension is supplied to support generic name content where no coding is available, use medicationReference or medicationCodeable concept if code is available.

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.

This profile contains the following variations from MedicationRequest:

  1. extension sliced
    • Grounds for Concurrent Supply of Medication extension
    • Minimum Interval Between Repeats extension
    • Medication Brand Name extension
    • Medication Generic Drug Name extension
  2. identifier sliced
    • identifier Electronic Transfer of Prescription Supplier Identifier
    • identifier Local Prescription Number
  3. medication[x] sliced
    • medication[x] Coded Prescribed Medication
    • coding PBS Item Code
    • coding Medication Package Global Trade Item Number (GTIN)
    • coding AMT Medicines
      • Type of Medication Coding extension
    • coding MIMS Package
    • medication[x] Prescribed Medication (Reference as: au-medication)
  4. supportingInformation sliced
    • supportingInformation Observation of Body Height (Reference as: au-bodyheight)
    • supportingInformation Observation of Body Weight (Reference as: au-bodyweight)
  5. authoredOn Created date
  6. reasonCode
  7. dosageInstruction
  8. dispenseRequest Requested dispensing
  9. substitution Brand substitution details
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*A 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
Binding: Grounds for Concurrent Supply (required)
... minimum-interval-between-repeats 0..*DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name 0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 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 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] CodeableConcept, Reference(AU Base Medication)Slice: Unordered, Open by type:$this
​... medication[x] I1..1CodeableConceptCoded Prescribed Medication
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amp-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
​.... coding CodingSlice: Unordered, Open by value:system, value:code
​.... coding 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
​.... coding 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
​.... coding 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
​..... extension 0..*ExtensionSlice: 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)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
​.... coding 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
​.... text 0..1stringMedication primary text
​... medication[x] 1..1Reference(AU Base Medication)Prescribed Medication
... supportingInformation Reference(Resource)Slice: Unordered, Open by profile:resolve()
... supportingInformation 0..1Reference(AU Body Height)Observation of Body Height
... supportingInformation 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest I0..*A 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
Binding: Grounds for Concurrent Supply (required)
... minimum-interval-between-repeats I0..*DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name I0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier IdentifierExternal ids for this request
Slice: Unordered, Open by value:system, value:type
... identifier 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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... 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 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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... 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..1CodeableConcept, Reference(AU Base Medication)Medication to be taken
Binding: SNOMED CT Medication Codes (example)
... medicationCodeableConcept ΣI1..1CodeableConceptCoded Prescribed Medication
Binding: SNOMED CT Medication Codes (example)
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amp-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
.... coding Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
..... 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
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
..... system Σ0..1uriIdentity of the terminology system
..... 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 Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringMedication primary text
... medicationReference Σ1..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 Reference(Resource)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
... supportingInformation 0..1Reference(AU Body Height)Observation of Body Height
... supportingInformation 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: SubstanceAdminSubstitutionReason (example)
... 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

This profile contains the following variations from MedicationRequest:

  1. extension sliced
    • Grounds for Concurrent Supply of Medication extension
    • Minimum Interval Between Repeats extension
    • Medication Brand Name extension
    • Medication Generic Drug Name extension
  2. identifier sliced
    • identifier Electronic Transfer of Prescription Supplier Identifier
    • identifier Local Prescription Number
  3. medication[x] sliced
    • medication[x] Coded Prescribed Medication
    • coding PBS Item Code
    • coding Medication Package Global Trade Item Number (GTIN)
    • coding AMT Medicines
      • Type of Medication Coding extension
    • coding MIMS Package
    • medication[x] Prescribed Medication (Reference as: au-medication)
  4. supportingInformation sliced
    • supportingInformation Observation of Body Height (Reference as: au-bodyheight)
    • supportingInformation Observation of Body Weight (Reference as: au-bodyweight)
  5. authoredOn Created date
  6. reasonCode
  7. dosageInstruction
  8. dispenseRequest Requested dispensing
  9. substitution Brand substitution details

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*A 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
Binding: Grounds for Concurrent Supply (required)
... minimum-interval-between-repeats 0..*DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name 0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 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 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] CodeableConcept, Reference(AU Base Medication)Slice: Unordered, Open by type:$this
​... medication[x] I1..1CodeableConceptCoded Prescribed Medication
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amp-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
​.... coding CodingSlice: Unordered, Open by value:system, value:code
​.... coding 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
​.... coding 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
​.... coding 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
​..... extension 0..*ExtensionSlice: 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)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
​.... coding 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
​.... text 0..1stringMedication primary text
​... medication[x] 1..1Reference(AU Base Medication)Prescribed Medication
... supportingInformation Reference(Resource)Slice: Unordered, Open by profile:resolve()
... supportingInformation 0..1Reference(AU Body Height)Observation of Body Height
... supportingInformation 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest I0..*A 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
Binding: Grounds for Concurrent Supply (required)
... minimum-interval-between-repeats I0..*DurationMinimum Interval Between Repeats
URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
... medication-brand-name I0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier IdentifierExternal ids for this request
Slice: Unordered, Open by value:system, value:type
... identifier 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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... 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 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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... 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..1CodeableConcept, Reference(AU Base Medication)Medication to be taken
Binding: SNOMED CT Medication Codes (example)
... medicationCodeableConcept ΣI1..1CodeableConceptCoded Prescribed Medication
Binding: SNOMED CT Medication Codes (example)
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amp-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
.... coding Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
..... 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
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
..... system Σ0..1uriIdentity of the terminology system
..... 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 Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringMedication primary text
... medicationReference Σ1..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 Reference(Resource)Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
... supportingInformation 0..1Reference(AU Body Height)Observation of Body Height
... supportingInformation 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: SubstanceAdminSubstitutionReason (example)
... 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