AU Core Implementation Guide
0.1.0-draft - Draft
AU Core Implementation Guide
0.1.0-draft - Draft
This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationrequest | Version: 0.1.0-draft | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreMedicationRequest | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a MedicationRequest resource to record, search, and fetch medication orders and requests (i.e. prescriptions) associated with a patient. It is based on the AU Base Medication Request profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the MedicationRequest when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
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 | A request for a medication for a patient in an Australian healthcare context | |
  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 |
| intent | S | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option |
| category | S | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (extensible) |
  Slices for medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this |
   medication[x]:medicationCodeableConcept | 0..1 | CodeableConcept | Coded Prescribed Medication | |
  Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
  coding:pbs | S | 0..* | Coding | PBS Item Code |
 coding:amt | S | 0..* | Coding | AMT Medicines |
| medication[x]:medicationReference | 0..1 | Reference(AU Core Medication) | Prescribed Medication | |
 subject | S | 1..1 | Reference(AU Core Patient) | Who or group medication request is for |
| encounter | S | 0..1 | Reference(AU Core Encounter) | Encounter created as part of encounter/admission/stay |
| authoredOn | SC | 1..1 | dateTime | Created date au-core-medreq-03: Date shall be at least to day |
| requester | S | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who/What requested the Request |
| reasonCode | S | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication |
| note | S | 0..* | Annotation | Information about the prescription |
| dosageInstruction | S | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context |
| dispenseRequest | S | 0..1 | BackboneElement | Requested dispensing |
| validityPeriod | S | 0..1 | Period | Time period supply is authorized for |
| numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised |
 quantity | S | 0..1 | SimpleQuantity | Amount of medication to supply per dispense |
 substitution | S | 0..1 | BackboneElement | Brand substitution details |
| allowed[x] | S | 1..1 | boolean, CodeableConcept | Brand substitution flag |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationRequest.category | extensible | medicationRequest Category Codes |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-medreq-03 | error | MedicationRequest.authoredOn | Date shall be at least to day : toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest | 0..* | AUBaseMedicationRequest | A request for a medication for a patient in an Australian healthcare context | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| subsidisedConcurrentSupply | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (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. |
| 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. |
| category | S | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (extensible) |
| doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action |
| Slices for medication[x] | SΣ | 1..1 | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | |
| medicationCodeableConcept | CodeableConcept | |||
| medicationReference | Reference(Medication) | |||
| medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:pbs | SΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) |
 system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item |
| coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin |
| coding:amt | SΣ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) |
 medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
 coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes |
| medication[x]:medicationReference | Σ | 0..1 | Reference(AU Core Medication) | Prescribed Medication |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who or group medication request is for |
| encounter | S | 0..1 | Reference(AU Core 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ΣC | 1..1 | dateTime | Created date au-core-medreq-03: Date shall be at least to day |
| requester | SΣ | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who/What requested the Request |
| reasonCode | S | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) |
| note | S | 0..* | Annotation | Information about the prescription |
| dosageInstruction | S | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context |
| dispenseRequest | S | 0..1 | BackboneElement | Requested dispensing |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| validityPeriod | S | 0..1 | Period | Time period supply is authorized for |
| numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised |
| quantity | S | 0..1 | SimpleQuantity | Amount of medication to supply per dispense |
| substitution | S | 0..1 | BackboneElement | Brand substitution details |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 allowed[x] | S | 1..1 | Brand substitution flag Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | |
| allowedBoolean | boolean | |||
| allowedCodeableConcept | CodeableConcept | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationRequest.status | required | medicationrequest Status |
| MedicationRequest.intent | required | medicationRequest Intent |
| MedicationRequest.category | extensible | medicationRequest Category Codes |
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodes |
| MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTIN |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS |
| MedicationRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCode |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-medreq-03 | error | MedicationRequest.authoredOn | Date shall be at least to day : toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest | 0..* | AUBaseMedicationRequest | A request 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: 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: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (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. | ||||
| 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. | ||||
| category | S | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (extensible) | ||||
| 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] | SΣ | 1..1 | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | |||||
| medicationCodeableConcept | CodeableConcept | |||||||
| medicationReference | Reference(Medication) | |||||||
| medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
 coding:pbs | SΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 | SΣ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) | ||||
| 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 | Σ | 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 (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 Core Medication) | Prescribed Medication | ||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who or group medication request is for | ||||
| encounter | S | 0..1 | Reference(AU Core 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ΣC | 1..1 | dateTime | Created date au-core-medreq-03: Date shall be at least to day | ||||
| requester | SΣ | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | 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 | S | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (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 | S | 0..* | Annotation | Information about the prescription | ||||
| dosageInstruction | S | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context | ||||
| dispenseRequest | S | 0..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 | S | 0..1 | Period | Time period supply is authorized for | ||||
| numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised | ||||
| quantity | S | 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 | S | 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] | S | 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: 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| MedicationRequest.language | preferred | CommonLanguages
| ||||
| MedicationRequest.status | required | medicationrequest Status | ||||
| MedicationRequest.statusReason | example | medicationRequest Status Reason Codes | ||||
| MedicationRequest.intent | required | medicationRequest Intent | ||||
| MedicationRequest.category | extensible | medicationRequest Category Codes | ||||
| MedicationRequest.priority | required | RequestPriority | ||||
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodes | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTIN | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodes | ||||
| MedicationRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
| MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codes | ||||
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCode | ||||
| MedicationRequest.substitution.reason | preferred | https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-medreq-03 | error | MedicationRequest.authoredOn | Date shall be at least to day : toString().length() >= 10 |
This structure is derived from AUBaseMedicationRequest
Summary
Mandatory: 2 elements
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from AUBaseMedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest | 0..* | AUBaseMedicationRequest | A request for a medication for a patient in an Australian healthcare context | |
| 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 |
| intent | S | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option |
| category | S | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (extensible) |
| Slices for medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this |
| medication[x]:medicationCodeableConcept | 0..1 | CodeableConcept | Coded Prescribed Medication | |
| Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:pbs | S | 0..* | Coding | PBS Item Code |
| coding:amt | S | 0..* | Coding | AMT Medicines |
| medication[x]:medicationReference | 0..1 | Reference(AU Core Medication) | Prescribed Medication | |
| subject | S | 1..1 | Reference(AU Core Patient) | Who or group medication request is for |
| encounter | S | 0..1 | Reference(AU Core Encounter) | Encounter created as part of encounter/admission/stay |
| authoredOn | SC | 1..1 | dateTime | Created date au-core-medreq-03: Date shall be at least to day |
| requester | S | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who/What requested the Request |
| reasonCode | S | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication |
| note | S | 0..* | Annotation | Information about the prescription |
| dosageInstruction | S | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context |
| dispenseRequest | S | 0..1 | BackboneElement | Requested dispensing |
| validityPeriod | S | 0..1 | Period | Time period supply is authorized for |
| numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised |
| quantity | S | 0..1 | SimpleQuantity | Amount of medication to supply per dispense |
| substitution | S | 0..1 | BackboneElement | Brand substitution details |
| allowed[x] | S | 1..1 | boolean, CodeableConcept | Brand substitution flag |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationRequest.category | extensible | medicationRequest Category Codes |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-medreq-03 | error | MedicationRequest.authoredOn | Date shall be at least to day : toString().length() >= 10 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest | 0..* | AUBaseMedicationRequest | A request for a medication for a patient in an Australian healthcare context | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| subsidisedConcurrentSupply | 0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (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. |
| 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. |
| category | S | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (extensible) |
| doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action |
| Slices for medication[x] | SΣ | 1..1 | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | |
| medicationCodeableConcept | CodeableConcept | |||
| medicationReference | Reference(Medication) | |||
| medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:pbs | SΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item |
| coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin |
| coding:amt | SΣ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) |
| medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes |
| medication[x]:medicationReference | Σ | 0..1 | Reference(AU Core Medication) | Prescribed Medication |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who or group medication request is for |
| encounter | S | 0..1 | Reference(AU Core 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ΣC | 1..1 | dateTime | Created date au-core-medreq-03: Date shall be at least to day |
| requester | SΣ | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who/What requested the Request |
| reasonCode | S | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) |
| note | S | 0..* | Annotation | Information about the prescription |
| dosageInstruction | S | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context |
| dispenseRequest | S | 0..1 | BackboneElement | Requested dispensing |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| validityPeriod | S | 0..1 | Period | Time period supply is authorized for |
| numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised |
| quantity | S | 0..1 | SimpleQuantity | Amount of medication to supply per dispense |
| substitution | S | 0..1 | BackboneElement | Brand substitution details |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| allowed[x] | S | 1..1 | Brand substitution flag Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | |
| allowedBoolean | boolean | |||
| allowedCodeableConcept | CodeableConcept | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationRequest.status | required | medicationrequest Status |
| MedicationRequest.intent | required | medicationRequest Intent |
| MedicationRequest.category | extensible | medicationRequest Category Codes |
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodes |
| MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTIN |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS |
| MedicationRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCode |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-medreq-03 | error | MedicationRequest.authoredOn | Date shall be at least to day : toString().length() >= 10 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest | 0..* | AUBaseMedicationRequest | A request 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: 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: https://healthterminologies.gov.au/fhir/ValueSet/concurrent-supply-grounds-1 (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. | ||||
| 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. | ||||
| category | S | 0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (extensible) | ||||
| 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] | SΣ | 1..1 | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | |||||
| medicationCodeableConcept | CodeableConcept | |||||||
| medicationReference | Reference(Medication) | |||||||
| medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:pbs | SΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 | SΣ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) | ||||
| 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 | Σ | 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 (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 Core Medication) | Prescribed Medication | ||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who or group medication request is for | ||||
| encounter | S | 0..1 | Reference(AU Core 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ΣC | 1..1 | dateTime | Created date au-core-medreq-03: Date shall be at least to day | ||||
| requester | SΣ | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | 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 | S | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (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 | S | 0..* | Annotation | Information about the prescription | ||||
| dosageInstruction | S | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context | ||||
| dispenseRequest | S | 0..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 | S | 0..1 | Period | Time period supply is authorized for | ||||
| numberOfRepeatsAllowed | S | 0..1 | unsignedInt | Maximum repeats authorised | ||||
| quantity | S | 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 | S | 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] | S | 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: 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| MedicationRequest.language | preferred | CommonLanguages
| ||||
| MedicationRequest.status | required | medicationrequest Status | ||||
| MedicationRequest.statusReason | example | medicationRequest Status Reason Codes | ||||
| MedicationRequest.intent | required | medicationRequest Intent | ||||
| MedicationRequest.category | extensible | medicationRequest Category Codes | ||||
| MedicationRequest.priority | required | RequestPriority | ||||
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodes | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTIN | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodes | ||||
| MedicationRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
| MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codes | ||||
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCode | ||||
| MedicationRequest.substitution.reason | preferred | https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-medreq-03 | error | MedicationRequest.authoredOn | Date shall be at least to day : toString().length() >= 10 |
This structure is derived from AUBaseMedicationRequest
Summary
Mandatory: 2 elements
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
| Name | Type | Conformance | Description | Path |
|---|---|---|---|---|
| TBD | TBD | TBD | TBD | TBD |
The following search parameters and search parameter combinations SHALL be supported:
The following search parameters and search parameter combinations SHOULD be supported:
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.1.0-draft based on FHIR 4.0.1. Generated 2023-03-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change