Australian Digital Health Agency Medicare Records FHIR Implementation Guide 2.2.0

Australian Digital Health Agency Medicare Records FHIR Implementation Guide. This is the current published version. It is based on FHIR® version 3.0.2. See the Directory of published versions for a list of available versions.

StructureDefinition: ADHA PBS MedicationRequest [Active]

The purpose of this profile is to define a representation of the prescription item claimed in a claim against the Pharmaceutical Benefits Schedule (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS) for the electronic exchange of health information between Medicare repositories and the My Health Record system infrastructure in Australia.

Usage scenarios

The following are the usage scenarios expected:

  • An individual’s PBS claim item records are uploaded to the My Health Record system from a Medicare repository
Each MedicationRequest SHALL have
  1. a profile assertion to this profile
  2. an intent
  3. a medication
  4. a patient
  5. a date of prescribing
  6. a number of repeats allowed
  7. an amount of medication per dispense
Must Support

In the context of this profile Must Support SHALL be interpreted as follows.

  • The system SHALL be able to store and retrieve the following elements:
    • status
    • intent
    • medication
    • authoredOn
    • dispenseRequest
    • dispenseRequest.numberOfRepeatsAllowed
    • dispenseRequest.quantity
  • The system SHALL be able to take the following elements into account when performing processing:
    • identifier
    • subject
Profile-specific implementation guidance
  • The patient resource should be identified in the subject element with a logical reference, i.e. an Australian IHI
  • The referenced medication resource will include the code for the medication and the manufacturer if known
  • If the number of permitted repeats for a prescription are zero, the numberOfRepeatsAllowed element should not be included - the value of ‘0’ cannot be used

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/medicationrequest-pbs

The purpose of this profile is to define a representation of the prescription item claimed in a claim against the Pharmaceutical Benefits Schedule (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS) for the electronic exchange of health information between Medicare repositories and the My Health Record system infrastructure in Australia.

This profile builds on MedicationRequest.

This profile was published on 2023-04-14 04:08:50+0000 as a active by Australian Digital Health Agency.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest C0..*MedicationRequestOrdering of medication for patient or group
inv-dh-mr-01: One meta.profile SHALL have value 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/medicationrequest-pbs'
... meta 1..1MetaMetadata about the resource
.... profile 1..*uriProfiles this resource claims to conform to
... identifier S0..*IdentifierExternal ids for this request
... status S0..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
... intent S1..1codeproposal | plan | order | instance-order
Fixed Value: order
... medicationReference:medicationReference S1..1Reference(ADHA PBS Medication) {c}Medication to be taken
... subject S1..1Reference(AU Base Patient)Who or group medication request is for
... authoredOn S1..1dateTimeWhen request was initially authored
... requester 0..1BackboneElementWho/What requested the Request
.... agent 1..1Reference(AU Base Practitioner | AU Base Organisation)Who ordered the initial medication(s)
... dispenseRequest S1..1BackboneElementMedication supply authorization
.... numberOfRepeatsAllowed S0..1positiveIntNumber of refills authorized
.... quantity S1..1SimpleQuantityAmount of medication to supply per dispense
.... performer 0..1Reference(AU Base Organisation)Intended dispenser

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest C0..*MedicationRequestOrdering of medication for patient or group
inv-dh-mr-01: One meta.profile SHALL have value 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/medicationrequest-pbs'
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ1..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierExternal ids for this request
... definition Σ0..*Reference(ActivityDefinition | PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ProcedureRequest | ReferralRequest)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ0..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: MedicationRequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription

... intent ?!SΣ1..1codeproposal | plan | order | instance-order
Binding: MedicationRequestIntent (required): The kind of medication order


Fixed Value: order
... category 0..1CodeableConceptType of medication usage
Binding: MedicationRequestCategory (preferred): A coded concept identifying where the medication ordered is expected to be consumed or administered

... priority Σ0..1coderoutine | urgent | stat | asap
Binding: MedicationRequestPriority (required): Identifies the level of importance to be assigned to actioning the request

... Slices for medication[x] Σ1..1Reference()Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference SΣ1..1Reference(ADHA PBS Medication) {c}Medication to be taken
... subject SΣ1..1Reference(AU Base Patient)Who or group medication request is for
... context 0..1Reference(Encounter | EpisodeOfCare)Created during encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn SΣ1..1dateTimeWhen request was initially authored
... requester ΣC0..1BackboneElementWho/What requested the Request
.... 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(AU Base Practitioner | AU Base Organisation)Who ordered the initial medication(s)
.... onBehalfOf ΣC0..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): A coded concept indicating why the medication was ordered.


... reasonReference 0..*Reference(Condition | 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 S1..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 S0..1positiveIntNumber of refills authorized
.... quantity S1..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(AU Base Organisation)Intended dispenser
... substitution 0..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): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.

... priorPrescription 0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest C0..*MedicationRequestOrdering of medication for patient or group
inv-dh-mr-01: One meta.profile SHALL have value 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/medicationrequest-pbs'
... meta 1..1MetaMetadata about the resource
.... profile 1..*uriProfiles this resource claims to conform to
... identifier S0..*IdentifierExternal ids for this request
... status S0..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
... intent S1..1codeproposal | plan | order | instance-order
Fixed Value: order
... medicationReference:medicationReference S1..1Reference(ADHA PBS Medication) {c}Medication to be taken
... subject S1..1Reference(AU Base Patient)Who or group medication request is for
... authoredOn S1..1dateTimeWhen request was initially authored
... requester 0..1BackboneElementWho/What requested the Request
.... agent 1..1Reference(AU Base Practitioner | AU Base Organisation)Who ordered the initial medication(s)
... dispenseRequest S1..1BackboneElementMedication supply authorization
.... numberOfRepeatsAllowed S0..1positiveIntNumber of refills authorized
.... quantity S1..1SimpleQuantityAmount of medication to supply per dispense
.... performer 0..1Reference(AU Base Organisation)Intended dispenser

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest C0..*MedicationRequestOrdering of medication for patient or group
inv-dh-mr-01: One meta.profile SHALL have value 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/medicationrequest-pbs'
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ1..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierExternal ids for this request
... definition Σ0..*Reference(ActivityDefinition | PlanDefinition)Protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ProcedureRequest | ReferralRequest)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ0..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: MedicationRequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription

... intent ?!SΣ1..1codeproposal | plan | order | instance-order
Binding: MedicationRequestIntent (required): The kind of medication order


Fixed Value: order
... category 0..1CodeableConceptType of medication usage
Binding: MedicationRequestCategory (preferred): A coded concept identifying where the medication ordered is expected to be consumed or administered

... priority Σ0..1coderoutine | urgent | stat | asap
Binding: MedicationRequestPriority (required): Identifies the level of importance to be assigned to actioning the request

... Slices for medication[x] Σ1..1Reference()Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference SΣ1..1Reference(ADHA PBS Medication) {c}Medication to be taken
... subject SΣ1..1Reference(AU Base Patient)Who or group medication request is for
... context 0..1Reference(Encounter | EpisodeOfCare)Created during encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn SΣ1..1dateTimeWhen request was initially authored
... requester ΣC0..1BackboneElementWho/What requested the Request
.... 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(AU Base Practitioner | AU Base Organisation)Who ordered the initial medication(s)
.... onBehalfOf ΣC0..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): A coded concept indicating why the medication was ordered.


... reasonReference 0..*Reference(Condition | 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 S1..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 S0..1positiveIntNumber of refills authorized
.... quantity S1..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(AU Base Organisation)Intended dispenser
... substitution 0..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): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.

... 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-medicationrequest-pbs

none defined