Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-medicationrequest-pbs-claim-1 | Version: 1.0.0 | |||
Active as of 2024-12-19 | Computable Name: ADHAMedicationRequestPBSClaim | |||
Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
The purpose of this profile is to define a representation of the prescription item claimed in a claim against the Pharmaceutical Benefits Scheme (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS) for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
This profile identifies the additional constraints, extensions, and value sets that build on and extend MedicationRequest that are supported.
This profile is designed to set a MedicationRequest standard for:
Operations, including querying, on prescription items in PBS claims (MedicationRequest resource) are expected to be within the context of an ExplanationOfBenefit resource query.
This profile may be referred to by APIs, which will be listed here when available.
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseMedicationRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | AUBaseMedicationRequest | PBS or RPBS claim item | |
identifier | S | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request |
status | S | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Fixed Value: unknown |
intent | S | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order |
Slices for medication[x] | Content/Rules for all slices | |||
medication[x]:medicationReference | SC | 1..1 | Reference(ADHA Core Medication) | Prescribed Medication inv-dh-pbs-03: At least reference shall be present |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Who or group medication request is for inv-dh-medreq-01: At least reference or a valid identifier shall be present |
authoredOn | S | 1..1 | dateTime | Created date |
dispenseRequest | S | 1..1 | BackboneElement | Requested dispensing |
numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised |
quantity | S | 1..1 | SimpleQuantity | Amount of medication to supply per dispense |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-medreq-01 | error | MedicationRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-pbs-03 | error | MedicationRequest.medication[x]:medicationReference | At least reference shall be present : reference.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | AUBaseMedicationRequest | PBS or RPBS claim item dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
subsidisedConcurrentSupply | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||
identifier | S | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request ele-1: All FHIR elements must have a @value or children | ||||||||||
status | ?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. ele-1: All FHIR elements must have a @value or children Fixed Value: unknown | ||||||||||
intent | ?!SΣ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. ele-1: All FHIR elements must have a @value or children Fixed Value: order | ||||||||||
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action ele-1: All FHIR elements must have a @value or children | ||||||||||
Slices for medication[x] | Σ | 1..1 | Reference() | Medication to be taken Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | ||||||||||
medication[x]:medicationReference | SΣC | 1..1 | Reference(ADHA Core Medication) | Prescribed Medication ele-1: All FHIR elements must have a @value or children inv-dh-pbs-03: At least reference shall be present | ||||||||||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
ele-1: All FHIR elements must have a @value or children | ||||||||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who or group medication request is for ele-1: All FHIR elements must have a @value or children inv-dh-medreq-01: At least reference or a valid identifier shall be present | ||||||||||
Slices for supportingInformation | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children | |||||||||||
supportingInformation:bodyHeight | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height ele-1: All FHIR elements must have a @value or children | |||||||||||
supportingInformation:bodyWeight | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight ele-1: All FHIR elements must have a @value or children | |||||||||||
authoredOn | SΣ | 1..1 | dateTime | Created date ele-1: All FHIR elements must have a @value or children | ||||||||||
dispenseRequest | S | 1..1 | BackboneElement | Requested dispensing ele-1: All FHIR elements must have a @value or children | ||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||
numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised ele-1: All FHIR elements must have a @value or children | ||||||||||
quantity | S | 1..1 | SimpleQuantity | Amount of medication to supply per dispense ele-1: All FHIR elements must have a @value or children | ||||||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationRequest.status | required | Fixed Value: unknownhttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 from the FHIR Standard | |
MedicationRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 from the FHIR Standard | |
MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-medreq-01 | error | MedicationRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-pbs-03 | error | MedicationRequest.medication[x]:medicationReference | At least reference shall be present : reference.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | AUBaseMedicationRequest | PBS or RPBS claim item | |||||||||||
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: CommonLanguages (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
subsidisedConcurrentSupply | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
identifier | S | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request | ||||||||||
status | ?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Fixed Value: unknown | ||||||||||
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||||||||
intent | ?!SΣ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. Fixed Value: order | ||||||||||
category | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. | |||||||||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||||||||
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||||||||
reported[x] | Σ | 0..1 | Reported rather than primary record | |||||||||||
reportedBoolean | boolean | |||||||||||||
reportedReference | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||||||||
Slices for medication[x] | Σ | 1..1 | Reference() | Medication to be taken Slice: Unordered, Closed by type:$this | ||||||||||
medication[x]:medicationReference | SΣC | 1..1 | Reference(ADHA Core Medication) | Prescribed Medication inv-dh-pbs-03: At least reference shall be present | ||||||||||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
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 | ||||||||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who or group medication request is for inv-dh-medreq-01: At least reference or a valid identifier shall be present | ||||||||||
encounter | 0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |||||||||||
Slices for supportingInformation | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() | |||||||||||
supportingInformation:bodyHeight | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height | |||||||||||
supportingInformation:bodyWeight | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight | |||||||||||
authoredOn | SΣ | 1..1 | dateTime | Created date | ||||||||||
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request | ||||||||||
performer | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||||||||
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication. | ||||||||||
recorder | 0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||||||||
reasonCode | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred) | |||||||||||
reasonReference | 0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||||||||
instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||||||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||||||||
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||||||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||||||||
courseOfTherapyType | 0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||||||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||||||||
note | 0..* | Annotation | Information about the prescription | |||||||||||
dosageInstruction | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |||||||||||
dispenseRequest | S | 1..1 | BackboneElement | Requested dispensing | ||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
initialFill | 0..1 | BackboneElement | First fill details | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
quantity | 0..1 | SimpleQuantity | First fill quantity | |||||||||||
duration | 0..1 | Duration | First fill duration | |||||||||||
dispenseInterval | 0..1 | Duration | Minimum period of time between dispenses | |||||||||||
validityPeriod | 0..1 | Period | Time period supply is authorized for | |||||||||||
numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised | ||||||||||
quantity | S | 1..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 | 0..1 | BackboneElement | Brand substitution details | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
allowed[x] | 1..1 | Brand substitution flag Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||||||||
allowedBoolean | boolean | |||||||||||||
allowedCodeableConcept | CodeableConcept | |||||||||||||
reason | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: Medicine Substitution Reason (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 |
Path | Conformance | ValueSet / Code | URI | |||
MedicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationRequest.status | required | Fixed Value: unknownhttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 from the FHIR Standard | ||||
MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reason from the FHIR Standard | ||||
MedicationRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 from the FHIR Standard | ||||
MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-category from the FHIR Standard | ||||
MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | ||||
MedicationRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy from the FHIR Standard | ||||
MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationRequest.substitution.reason | preferred | MedicineSubstitutionReason https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-medreq-01 | error | MedicationRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-pbs-03 | error | MedicationRequest.medication[x]:medicationReference | At least reference shall be present : reference.exists() |
This structure is derived from AUBaseMedicationRequest
Differential View
This structure is derived from AUBaseMedicationRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | AUBaseMedicationRequest | PBS or RPBS claim item | |
identifier | S | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request |
status | S | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Fixed Value: unknown |
intent | S | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order |
Slices for medication[x] | Content/Rules for all slices | |||
medication[x]:medicationReference | SC | 1..1 | Reference(ADHA Core Medication) | Prescribed Medication inv-dh-pbs-03: At least reference shall be present |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Who or group medication request is for inv-dh-medreq-01: At least reference or a valid identifier shall be present |
authoredOn | S | 1..1 | dateTime | Created date |
dispenseRequest | S | 1..1 | BackboneElement | Requested dispensing |
numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised |
quantity | S | 1..1 | SimpleQuantity | Amount of medication to supply per dispense |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-medreq-01 | error | MedicationRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-pbs-03 | error | MedicationRequest.medication[x]:medicationReference | At least reference shall be present : reference.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | AUBaseMedicationRequest | PBS or RPBS claim item dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
subsidisedConcurrentSupply | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||
identifier | S | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request ele-1: All FHIR elements must have a @value or children | ||||||||||
status | ?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. ele-1: All FHIR elements must have a @value or children Fixed Value: unknown | ||||||||||
intent | ?!SΣ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. ele-1: All FHIR elements must have a @value or children Fixed Value: order | ||||||||||
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action ele-1: All FHIR elements must have a @value or children | ||||||||||
Slices for medication[x] | Σ | 1..1 | Reference() | Medication to be taken Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | ||||||||||
medication[x]:medicationReference | SΣC | 1..1 | Reference(ADHA Core Medication) | Prescribed Medication ele-1: All FHIR elements must have a @value or children inv-dh-pbs-03: At least reference shall be present | ||||||||||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
ele-1: All FHIR elements must have a @value or children | ||||||||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who or group medication request is for ele-1: All FHIR elements must have a @value or children inv-dh-medreq-01: At least reference or a valid identifier shall be present | ||||||||||
Slices for supportingInformation | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children | |||||||||||
supportingInformation:bodyHeight | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height ele-1: All FHIR elements must have a @value or children | |||||||||||
supportingInformation:bodyWeight | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight ele-1: All FHIR elements must have a @value or children | |||||||||||
authoredOn | SΣ | 1..1 | dateTime | Created date ele-1: All FHIR elements must have a @value or children | ||||||||||
dispenseRequest | S | 1..1 | BackboneElement | Requested dispensing ele-1: All FHIR elements must have a @value or children | ||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||
numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised ele-1: All FHIR elements must have a @value or children | ||||||||||
quantity | S | 1..1 | SimpleQuantity | Amount of medication to supply per dispense ele-1: All FHIR elements must have a @value or children | ||||||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationRequest.status | required | Fixed Value: unknownhttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 from the FHIR Standard | |
MedicationRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 from the FHIR Standard | |
MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-medreq-01 | error | MedicationRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-pbs-03 | error | MedicationRequest.medication[x]:medicationReference | At least reference shall be present : reference.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | AUBaseMedicationRequest | PBS or RPBS claim item | |||||||||||
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: CommonLanguages (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
subsidisedConcurrentSupply | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
identifier | S | 0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request | ||||||||||
status | ?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Fixed Value: unknown | ||||||||||
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||||||||
intent | ?!SΣ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. Fixed Value: order | ||||||||||
category | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. | |||||||||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||||||||
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||||||||
reported[x] | Σ | 0..1 | Reported rather than primary record | |||||||||||
reportedBoolean | boolean | |||||||||||||
reportedReference | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||||||||
Slices for medication[x] | Σ | 1..1 | Reference() | Medication to be taken Slice: Unordered, Closed by type:$this | ||||||||||
medication[x]:medicationReference | SΣC | 1..1 | Reference(ADHA Core Medication) | Prescribed Medication inv-dh-pbs-03: At least reference shall be present | ||||||||||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
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 | ||||||||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who or group medication request is for inv-dh-medreq-01: At least reference or a valid identifier shall be present | ||||||||||
encounter | 0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |||||||||||
Slices for supportingInformation | 0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() | |||||||||||
supportingInformation:bodyHeight | 0..1 | Reference(Observation Body Height Profile) | Observation of Body Height | |||||||||||
supportingInformation:bodyWeight | 0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight | |||||||||||
authoredOn | SΣ | 1..1 | dateTime | Created date | ||||||||||
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request | ||||||||||
performer | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||||||||
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication. | ||||||||||
recorder | 0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||||||||
reasonCode | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred) | |||||||||||
reasonReference | 0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||||||||
instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||||||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||||||||
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||||||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||||||||
courseOfTherapyType | 0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||||||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||||||||
note | 0..* | Annotation | Information about the prescription | |||||||||||
dosageInstruction | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |||||||||||
dispenseRequest | S | 1..1 | BackboneElement | Requested dispensing | ||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
initialFill | 0..1 | BackboneElement | First fill details | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
quantity | 0..1 | SimpleQuantity | First fill quantity | |||||||||||
duration | 0..1 | Duration | First fill duration | |||||||||||
dispenseInterval | 0..1 | Duration | Minimum period of time between dispenses | |||||||||||
validityPeriod | 0..1 | Period | Time period supply is authorized for | |||||||||||
numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised | ||||||||||
quantity | S | 1..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 | 0..1 | BackboneElement | Brand substitution details | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
allowed[x] | 1..1 | Brand substitution flag Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||||||||
allowedBoolean | boolean | |||||||||||||
allowedCodeableConcept | CodeableConcept | |||||||||||||
reason | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: Medicine Substitution Reason (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 |
Path | Conformance | ValueSet / Code | URI | |||
MedicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationRequest.status | required | Fixed Value: unknownhttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 from the FHIR Standard | ||||
MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reason from the FHIR Standard | ||||
MedicationRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 from the FHIR Standard | ||||
MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-category from the FHIR Standard | ||||
MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | ||||
MedicationRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy from the FHIR Standard | ||||
MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationRequest.substitution.reason | preferred | MedicineSubstitutionReason https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-medreq-01 | error | MedicationRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-pbs-03 | error | MedicationRequest.medication[x]:medicationReference | At least reference shall be present : reference.exists() |
This structure is derived from AUBaseMedicationRequest
Other representations of profile: CSV, Excel, Schematron
No mandatory or optional search parameters for ADHA PBS Claim Item.