Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.4.0: R1 Draft) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-prescription

AU Base Prescription

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Description of Australian prescription record

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.

AU Base Prescription profile contains:

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*Australian Prescription
... identifier IdentifierSlice: Unordered, Open by value:system
... identifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"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..1CodeableConceptBinding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"LPN"}
..... text 1..1stringFixed Value: Local Prescription Number
.... system 1..1uri
.... value 1..1stringPrescription Number
.... assigner 1..1Reference(Organization)
..... display 1..1string
... medicationReference 1..1Reference(AU Base Medication)
... subject 1..1Reference(AU Base Patient), Reference(Patient), Reference(Group)
... 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)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest I0..*Australian Prescription
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... grounds-for-concurrent-supply 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
Binding: Grounds for concurrent supply (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier IdentifierExternal ids for this request
Slice: Unordered, Open by value:system
... identifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"ETP"}
..... 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)
..... 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)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"LPN"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
.... system Σ1..1uriThe namespace for the identifier value
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)
..... 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), Reference(PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(CarePlan), Reference(MedicationRequest), Reference(ProcedureRequest), Reference(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)
... medicationReference Σ1..1Reference(AU Base Medication)Medication to be taken
... subject Σ1..1Reference(AU Base Patient), Reference(Patient), Reference(Group)Who or group medication request is for
... context 0..1Reference(Encounter), Reference(EpisodeOfCare)Created during encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn Σ0..1dateTimeWhen request was initially authored
... 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), Reference(Organization), Reference(Patient), Reference(RelatedPerson), Reference(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: Condition/Problem/Diagnosis Codes (example)
... reasonReference 0..*Reference(Condition), Reference(Observation)Condition or Observation that supports why the prescription is being written
... note 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*DosageHow the medication should be taken
... dispenseRequest I0..1BackboneElementMedication supply authorization
.... 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..1positiveIntNumber of refills authorized
.... 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..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... allowed ?!1..1booleanWhether substitution is allowed or not
.... 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

AU Base Prescription profile contains:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*Australian Prescription
... identifier IdentifierSlice: Unordered, Open by value:system
... identifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"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..1CodeableConceptBinding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"LPN"}
..... text 1..1stringFixed Value: Local Prescription Number
.... system 1..1uri
.... value 1..1stringPrescription Number
.... assigner 1..1Reference(Organization)
..... display 1..1string
... medicationReference 1..1Reference(AU Base Medication)
... subject 1..1Reference(AU Base Patient), Reference(Patient), Reference(Group)
... 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)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest I0..*Australian Prescription
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... grounds-for-concurrent-supply 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
Binding: Grounds for concurrent supply (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier IdentifierExternal ids for this request
Slice: Unordered, Open by value:system
... identifier 0..*IdentifierElectronic Transfer of Prescription Supplier Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"ETP"}
..... 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)
..... 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)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"LPN"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
.... system Σ1..1uriThe namespace for the identifier value
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)
..... 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), Reference(PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(CarePlan), Reference(MedicationRequest), Reference(ProcedureRequest), Reference(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)
... medicationReference Σ1..1Reference(AU Base Medication)Medication to be taken
... subject Σ1..1Reference(AU Base Patient), Reference(Patient), Reference(Group)Who or group medication request is for
... context 0..1Reference(Encounter), Reference(EpisodeOfCare)Created during encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn Σ0..1dateTimeWhen request was initially authored
... 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), Reference(Organization), Reference(Patient), Reference(RelatedPerson), Reference(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: Condition/Problem/Diagnosis Codes (example)
... reasonReference 0..*Reference(Condition), Reference(Observation)Condition or Observation that supports why the prescription is being written
... note 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*DosageHow the medication should be taken
... dispenseRequest I0..1BackboneElementMedication supply authorization
.... 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..1positiveIntNumber of refills authorized
.... 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..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... allowed ?!1..1booleanWhether substitution is allowed or not
.... 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-prescription

none defined