AU Base 1.1.1 on FHIR STU3

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.

Name	Card.	Type	Description & Constraints
MedicationRequest	0..*	MedicationRequest	A prescription for a medication for a patient in an Australian healthcare context
extension	0..*	Extension	Slice: Unordered, Open by value:url
grounds-for-concurrent-supply	0..1	Coding	Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
minimum-interval-between-repeats	0..1	Duration	Minimum Interval Between Repeats URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
medication-brand-name	0..1	string	Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
medication-generic-name	0..1	string	Medication 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..*	Identifier	Electronic Transfer of Prescription Supplier Identifier
type	1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding	1..1	Coding
system	1..1	uri	Fixed Value: http://hl7.org.au/fhir/v2/0203
code	1..1	code	Fixed Value: ETP
text	1..1	string	Fixed Value: ETP Identifier
system	1..1	uri	ETP vendor identifier system URL
value	1..1	string	ETP vendor identifier
assigner	1..1	Reference(Organization)	ETP vendor
display	1..1	string	ETP vendor name
identifier:localScriptNumber	0..*	Identifier	Local Prescription Number
type	1..1	CodeableConcept	Coded identifier type for local prescription number Binding: v2 Identifier Type - AU Extended (required)
coding	1..1	Coding
system	1..1	uri	Fixed Value: http://hl7.org.au/fhir/v2/0203
code	1..1	code	Fixed Value: LPN
text	1..1	string	Fixed Value: Local Prescription Number
system	1..1	uri	Namespace for local prescription number
value	1..1	string	Prescription number
assigner	1..1	Reference(Organization)
display	1..1	string
medication[x]	1..1	(Slice Definition)	Slice: Unordered, Closed by type:$this
medication[x]:medicationCodeableConcept	0..1	CodeableConcept	Coded Prescribed Medication
coding	0..*	(Slice Definition)	Slice: Unordered, Open by value:system
coding:pbs	0..*	Coding	PBS Item Code Binding: PBS Medicines Item Codes (preferred)
system	1..1	uri	Fixed Value: http://pbs.gov.au/code/item
coding:gtin	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred)
system	1..1	uri	Fixed Value: http://www.gs1.org/gtin
coding:amt	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
extension	0..*	Extension	Slice: Unordered, Open by value:url
medication-type	0..1	Coding	Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
system	1..1	uri	Fixed Value: http://snomed.info/sct
coding:mimsPackage	0..1	Coding	MIMS Package Binding: MIMS Terminology (preferred)
system	1..1	uri	Fixed Value: http://www.mims.com.au/codes
text	0..1	string	Medication primary text
medication[x]:medicationReference	0..1	Reference(AU Base Medication)	Prescribed Medication
supportingInformation	0..*	(Slice Definition)	Slice: Unordered, Open by profile:resolve()
supportingInformation:bodyHeight	0..1	Reference(AU Body Height)	Observation of Body Height
supportingInformation:bodyWeight	0..1	Reference(AU Body Weight)	Observation of Body Weight
authoredOn	0..1	dateTime	Created date
reasonCode	0..*	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (preferred)
dosageInstruction	0..*	AUBaseDosage
dispenseRequest	0..1	BackboneElement	Requested dispensing
numberOfRepeatsAllowed	0..1	positiveInt	Maximum repeats authorised
substitution	0..1	BackboneElement	Brand substitution details
allowed	1..1	boolean	Brand substitution flag
reason	0..1	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
MedicationRequest	I	0..*	MedicationRequest	A prescription for a medication for a patient in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
grounds-for-concurrent-supply	I	0..1	Coding	Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
minimum-interval-between-repeats	I	0..1	Duration	Minimum Interval Between Repeats URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
medication-brand-name	I	0..1	string	Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
medication-generic-name	I	0..1	string	Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	(Slice Definition)	External ids for this request Slice: Unordered, Open by value:system, value:type
identifier:etpVendorIdentifier		0..*	Identifier	Electronic Transfer of Prescription Supplier Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: ETP
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: ETP Identifier
system	Σ	1..1	uri	ETP vendor identifier system URL Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	ETP vendor identifier Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	ETP vendor
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	ETP vendor name
identifier:localScriptNumber		0..*	Identifier	Local Prescription Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for local prescription number Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: LPN
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Local Prescription Number
system	Σ	1..1	uri	Namespace for local prescription number Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Prescription number Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Text alternative for the resource
definition	Σ	0..*	Reference(ActivityDefinition \| PlanDefinition)	Protocol or definition
basedOn	Σ	0..*	Reference(CarePlan \| MedicationRequest \| ProcedureRequest \| ReferralRequest)	What request fulfills
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	0..1	code	active \| on-hold \| cancelled \| completed \| entered-in-error \| stopped \| draft \| unknown Binding: MedicationRequestStatus (required)
intent	?!Σ	1..1	code	proposal \| plan \| order \| instance-order Binding: MedicationRequestIntent (required)
category		0..1	CodeableConcept	Type of medication usage Binding: MedicationRequestCategory (preferred)
priority	Σ	0..1	code	routine \| 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)
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationCodeableConcept	Σ	0..1	CodeableConcept	Coded Prescribed Medication Binding: SNOMED CT Medication Codes (example)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional 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..*	Coding	PBS Item Code Binding: PBS Medicines Item Codes (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:gtin	Σ	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:amt	Σ	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
medication-type		0..1	Coding	Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:mimsPackage	Σ	0..1	Coding	MIMS Package Binding: MIMS Terminology (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.mims.com.au/codes
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Medication primary text
medication[x]:medicationReference	Σ	0..1	Reference(AU Base Medication)	Prescribed Medication
subject	Σ	1..1	Reference(Patient \| Group)	Who or group medication request is for
context		0..1	Reference(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..1	Reference(AU Body Height)	Observation of Body Height
supportingInformation:bodyWeight		0..1	Reference(AU Body Weight)	Observation of Body Weight
authoredOn	Σ	0..1	dateTime	Created date
requester	ΣI	0..1	BackboneElement	Who/What requested the Request mps-1: onBehalfOf can only be specified if agent is practitioner or device
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
agent	Σ	1..1	Reference(Practitioner \| Organization \| Patient \| RelatedPerson \| Device)	Who ordered the initial medication(s)
onBehalfOf	ΣI	0..1	Reference(Organization)	Organization agent is acting for
recorder		0..1	Reference(Practitioner)	Person who entered the request
reasonCode		0..*	CodeableConcept	Reason 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..*	Annotation	Information about the prescription
dosageInstruction	I	0..*	AUBaseDosage	Dosage information in an Australian healthcare context
dispenseRequest	I	0..1	BackboneElement	Requested dispensing
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
validityPeriod		0..1	Period	Time period supply is authorized for
numberOfRepeatsAllowed		0..1	positiveInt	Maximum repeats authorised
quantity		0..1	SimpleQuantity	Amount of medication to supply per dispense
expectedSupplyDuration		0..1	Duration	Number of days supply per dispense
performer		0..1	Reference(Organization)	Intended dispenser
substitution	I	0..1	BackboneElement	Brand substitution details
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
allowed	?!	1..1	boolean	Brand substitution flag
reason		0..1	CodeableConcept	Why should (not) substitution be made Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
priorPrescription		0..1	Reference(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
Documentation for this format

Differential View

Name	Card.	Type	Description & Constraints
MedicationRequest	0..*	MedicationRequest	A prescription for a medication for a patient in an Australian healthcare context
extension	0..*	Extension	Slice: Unordered, Open by value:url
grounds-for-concurrent-supply	0..1	Coding	Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
minimum-interval-between-repeats	0..1	Duration	Minimum Interval Between Repeats URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
medication-brand-name	0..1	string	Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
medication-generic-name	0..1	string	Medication 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..*	Identifier	Electronic Transfer of Prescription Supplier Identifier
type	1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding	1..1	Coding
system	1..1	uri	Fixed Value: http://hl7.org.au/fhir/v2/0203
code	1..1	code	Fixed Value: ETP
text	1..1	string	Fixed Value: ETP Identifier
system	1..1	uri	ETP vendor identifier system URL
value	1..1	string	ETP vendor identifier
assigner	1..1	Reference(Organization)	ETP vendor
display	1..1	string	ETP vendor name
identifier:localScriptNumber	0..*	Identifier	Local Prescription Number
type	1..1	CodeableConcept	Coded identifier type for local prescription number Binding: v2 Identifier Type - AU Extended (required)
coding	1..1	Coding
system	1..1	uri	Fixed Value: http://hl7.org.au/fhir/v2/0203
code	1..1	code	Fixed Value: LPN
text	1..1	string	Fixed Value: Local Prescription Number
system	1..1	uri	Namespace for local prescription number
value	1..1	string	Prescription number
assigner	1..1	Reference(Organization)
display	1..1	string
medication[x]	1..1	(Slice Definition)	Slice: Unordered, Closed by type:$this
medication[x]:medicationCodeableConcept	0..1	CodeableConcept	Coded Prescribed Medication
coding	0..*	(Slice Definition)	Slice: Unordered, Open by value:system
coding:pbs	0..*	Coding	PBS Item Code Binding: PBS Medicines Item Codes (preferred)
system	1..1	uri	Fixed Value: http://pbs.gov.au/code/item
coding:gtin	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred)
system	1..1	uri	Fixed Value: http://www.gs1.org/gtin
coding:amt	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
extension	0..*	Extension	Slice: Unordered, Open by value:url
medication-type	0..1	Coding	Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
system	1..1	uri	Fixed Value: http://snomed.info/sct
coding:mimsPackage	0..1	Coding	MIMS Package Binding: MIMS Terminology (preferred)
system	1..1	uri	Fixed Value: http://www.mims.com.au/codes
text	0..1	string	Medication primary text
medication[x]:medicationReference	0..1	Reference(AU Base Medication)	Prescribed Medication
supportingInformation	0..*	(Slice Definition)	Slice: Unordered, Open by profile:resolve()
supportingInformation:bodyHeight	0..1	Reference(AU Body Height)	Observation of Body Height
supportingInformation:bodyWeight	0..1	Reference(AU Body Weight)	Observation of Body Weight
authoredOn	0..1	dateTime	Created date
reasonCode	0..*	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (preferred)
dosageInstruction	0..*	AUBaseDosage
dispenseRequest	0..1	BackboneElement	Requested dispensing
numberOfRepeatsAllowed	0..1	positiveInt	Maximum repeats authorised
substitution	0..1	BackboneElement	Brand substitution details
allowed	1..1	boolean	Brand substitution flag
reason	0..1	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
MedicationRequest	I	0..*	MedicationRequest	A prescription for a medication for a patient in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
grounds-for-concurrent-supply	I	0..1	Coding	Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
minimum-interval-between-repeats	I	0..1	Duration	Minimum Interval Between Repeats URL: http://hl7.org.au/fhir/StructureDefinition/minimum-interval-between-repeats
medication-brand-name	I	0..1	string	Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
medication-generic-name	I	0..1	string	Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	(Slice Definition)	External ids for this request Slice: Unordered, Open by value:system, value:type
identifier:etpVendorIdentifier		0..*	Identifier	Electronic Transfer of Prescription Supplier Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: ETP
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: ETP Identifier
system	Σ	1..1	uri	ETP vendor identifier system URL Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	ETP vendor identifier Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	ETP vendor
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	ETP vendor name
identifier:localScriptNumber		0..*	Identifier	Local Prescription Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for local prescription number Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: LPN
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Local Prescription Number
system	Σ	1..1	uri	Namespace for local prescription number Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Prescription number Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Text alternative for the resource
definition	Σ	0..*	Reference(ActivityDefinition \| PlanDefinition)	Protocol or definition
basedOn	Σ	0..*	Reference(CarePlan \| MedicationRequest \| ProcedureRequest \| ReferralRequest)	What request fulfills
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	0..1	code	active \| on-hold \| cancelled \| completed \| entered-in-error \| stopped \| draft \| unknown Binding: MedicationRequestStatus (required)
intent	?!Σ	1..1	code	proposal \| plan \| order \| instance-order Binding: MedicationRequestIntent (required)
category		0..1	CodeableConcept	Type of medication usage Binding: MedicationRequestCategory (preferred)
priority	Σ	0..1	code	routine \| 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)
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationCodeableConcept	Σ	0..1	CodeableConcept	Coded Prescribed Medication Binding: SNOMED CT Medication Codes (example)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional 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..*	Coding	PBS Item Code Binding: PBS Medicines Item Codes (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:gtin	Σ	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:amt	Σ	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
medication-type		0..1	Coding	Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:mimsPackage	Σ	0..1	Coding	MIMS Package Binding: MIMS Terminology (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.mims.com.au/codes
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Medication primary text
medication[x]:medicationReference	Σ	0..1	Reference(AU Base Medication)	Prescribed Medication
subject	Σ	1..1	Reference(Patient \| Group)	Who or group medication request is for
context		0..1	Reference(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..1	Reference(AU Body Height)	Observation of Body Height
supportingInformation:bodyWeight		0..1	Reference(AU Body Weight)	Observation of Body Weight
authoredOn	Σ	0..1	dateTime	Created date
requester	ΣI	0..1	BackboneElement	Who/What requested the Request mps-1: onBehalfOf can only be specified if agent is practitioner or device
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
agent	Σ	1..1	Reference(Practitioner \| Organization \| Patient \| RelatedPerson \| Device)	Who ordered the initial medication(s)
onBehalfOf	ΣI	0..1	Reference(Organization)	Organization agent is acting for
recorder		0..1	Reference(Practitioner)	Person who entered the request
reasonCode		0..*	CodeableConcept	Reason 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..*	Annotation	Information about the prescription
dosageInstruction	I	0..*	AUBaseDosage	Dosage information in an Australian healthcare context
dispenseRequest	I	0..1	BackboneElement	Requested dispensing
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
validityPeriod		0..1	Period	Time period supply is authorized for
numberOfRepeatsAllowed		0..1	positiveInt	Maximum repeats authorised
quantity		0..1	SimpleQuantity	Amount of medication to supply per dispense
expectedSupplyDuration		0..1	Duration	Number of days supply per dispense
performer		0..1	Reference(Organization)	Intended dispenser
substitution	I	0..1	BackboneElement	Brand substitution details
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
allowed	?!	1..1	boolean	Brand substitution flag
reason		0..1	CodeableConcept	Why should (not) substitution be made Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
priorPrescription		0..1	Reference(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
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