AU Base Implementation Guide
4.2.1-ci-build - CI Build
AU Base Implementation Guide
4.2.1-ci-build - CI Build
AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 4.2.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medicationrequest | Version: 4.2.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUBaseMedicationRequest | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile defines a medication request structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.
Profile specific implementation guidance:
MedicationRequest.code, this profile includes coding as:
MedicationRequest.code is still present and may contain only the list of ingredients as text in MedicationRequest.code.text.MedicationRequest.medicationReference is preferred to MedicationRequest.code and use of extensions, see guidance on AU Base Medication.Potentially useful extensions:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationRequest |
0..* | MedicationRequest | A request for a medication for a patient in an Australian healthcare context | |
  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) | |
 identifier |
0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request | |
  Slices for medication[x] |
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 |
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 |
0..* | Coding | AMT Medicines Binding: Australian Medication (preferred) | |
 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 | |
 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 | |
| text |
0..1 | string | Medication primary text | |
 medication[x]:medicationReference |
0..1 | Reference(Medication) | Prescribed Medication | |
| 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 |
0..1 | dateTime | Created date | |
| reasonCode |
0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred) | |
| dosageInstruction |
0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |
| dispenseRequest |
0..1 | BackboneElement | Requested dispensing | |
 numberOfRepeatsAllowed |
0..1 | unsignedInt | Maximum repeats authorised | |
 substitution |
0..1 | BackboneElement | Brand substitution details | |
| allowed[x] |
1..1 | boolean, CodeableConcept | Brand substitution flag | |
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: Medicine Substitution Reason (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes (a valid code from PBS Item Codes)http://terminology.hl7.org.au/ValueSet/pbs-itemfrom this IG | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))http://terminology.hl7.org.au/ValueSet/mimsfrom this IG | |
| MedicationRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| MedicationRequest.substitution.reason | preferred | MedicineSubstitutionReason https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | 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 |
| 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 |
0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request | |
| status |
?!Σ | 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 |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
| Slices for medication[x] |
Σ | 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 |
Σ | 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 |
Σ | 0..* | Coding | AMT Medicines Binding: Australian Medication (preferred) |
| 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 |
| 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 |
| text |
Σ | 0..1 | string | Medication primary text |
| medication[x]:medicationReference |
Σ | 0..1 | Reference(Medication) | Prescribed Medication |
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for |
| 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 |
Σ | 0..1 | dateTime | Created date |
| reasonCode |
0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred) | |
| dosageInstruction |
0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |
| dispenseRequest |
0..1 | BackboneElement | Requested dispensing | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Maximum repeats authorised | |
| substitution |
0..1 | BackboneElement | Brand substitution details | |
| 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) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | |
| MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | |
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes (a valid code from PBS Item Codes)http://terminology.hl7.org.au/ValueSet/pbs-itemfrom this IG | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))http://terminology.hl7.org.au/ValueSet/mimsfrom this IG | |
| MedicationRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| 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 |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | 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: Concurrent Supply Grounds (required) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request | |||||
| status |
?!Σ | 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 |
?!Σ | 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 |
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 | 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 |
Σ | 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 |
Σ | 0..* | Coding | AMT Medicines Binding: Australian Medication (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(Medication) | Prescribed Medication | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for | ||||
| 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 |
Σ | 0..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 |
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 |
0..1 | Period | Time period supply is authorized for | |||||
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Maximum repeats authorised | |||||
| quantity |
0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |||||
| performer |
0..1 | Reference(Organization) | Intended dispenser | |||||
| substitution |
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 | URI | |||
| MedicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | ||||
| MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reasonfrom the FHIR Standard | ||||
| MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | ||||
| MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-categoryfrom the FHIR Standard | ||||
| MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes (a valid code from PBS Item Codes)http://terminology.hl7.org.au/ValueSet/pbs-itemfrom this IG | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))http://terminology.hl7.org.au/ValueSet/mimsfrom this IG | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom 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-therapyfrom 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 |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MedicationRequest
Summary
Mandatory: 0 element(4 nested mandatory elements)
Fixed: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Differential View
This structure is derived from MedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | A request for a medication for a patient in an Australian healthcare context | |
| 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) | |
| identifier |
0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request | |
| Slices for medication[x] |
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 |
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 |
0..* | Coding | AMT Medicines Binding: Australian Medication (preferred) | |
| 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 | |
| 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 | |
| text |
0..1 | string | Medication primary text | |
| medication[x]:medicationReference |
0..1 | Reference(Medication) | Prescribed Medication | |
| 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 |
0..1 | dateTime | Created date | |
| reasonCode |
0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred) | |
| dosageInstruction |
0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |
| dispenseRequest |
0..1 | BackboneElement | Requested dispensing | |
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Maximum repeats authorised | |
| substitution |
0..1 | BackboneElement | Brand substitution details | |
| allowed[x] |
1..1 | boolean, CodeableConcept | Brand substitution flag | |
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: Medicine Substitution Reason (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes (a valid code from PBS Item Codes)http://terminology.hl7.org.au/ValueSet/pbs-itemfrom this IG | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))http://terminology.hl7.org.au/ValueSet/mimsfrom this IG | |
| MedicationRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| MedicationRequest.substitution.reason | preferred | MedicineSubstitutionReason https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | 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 |
| 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 |
0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request | |
| status |
?!Σ | 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 |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
| Slices for medication[x] |
Σ | 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 |
Σ | 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 |
Σ | 0..* | Coding | AMT Medicines Binding: Australian Medication (preferred) |
| 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 |
| 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 |
| text |
Σ | 0..1 | string | Medication primary text |
| medication[x]:medicationReference |
Σ | 0..1 | Reference(Medication) | Prescribed Medication |
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for |
| 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 |
Σ | 0..1 | dateTime | Created date |
| reasonCode |
0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Reason for Request (preferred) | |
| dosageInstruction |
0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |
| dispenseRequest |
0..1 | BackboneElement | Requested dispensing | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Maximum repeats authorised | |
| substitution |
0..1 | BackboneElement | Brand substitution details | |
| 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) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | |
| MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | |
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes (a valid code from PBS Item Codes)http://terminology.hl7.org.au/ValueSet/pbs-itemfrom this IG | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))http://terminology.hl7.org.au/ValueSet/mimsfrom this IG | |
| MedicationRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| 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 |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | 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: Concurrent Supply Grounds (required) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier | External ids for this request | |||||
| status |
?!Σ | 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 |
?!Σ | 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 |
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 | 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 |
Σ | 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 |
Σ | 0..* | Coding | AMT Medicines Binding: Australian Medication (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(Medication) | Prescribed Medication | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who or group medication request is for | ||||
| 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 |
Σ | 0..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 |
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 |
0..1 | Period | Time period supply is authorized for | |||||
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Maximum repeats authorised | |||||
| quantity |
0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |||||
| performer |
0..1 | Reference(Organization) | Intended dispenser | |||||
| substitution |
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 | URI | |||
| MedicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | ||||
| MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reasonfrom the FHIR Standard | ||||
| MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | ||||
| MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-categoryfrom the FHIR Standard | ||||
| MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes (a valid code from PBS Item Codes)http://terminology.hl7.org.au/ValueSet/pbs-itemfrom this IG | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
| MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))http://terminology.hl7.org.au/ValueSet/mimsfrom this IG | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom 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-therapyfrom 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 |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MedicationRequest
Summary
Mandatory: 0 element(4 nested mandatory elements)
Fixed: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.2.1-ci-build based on FHIR 4.0.1. Generated 2024-05-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change