Medtech ALEX® Implementation Guide
0.0.1 - draft
Medtech ALEX® Implementation Guide
0.0.1 - draft
Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-repeatprescription | Version: 0.0.1 | |||
| Active as of 2025-01-20 | Computable Name: AlexRepeatPrescription | |||
The Repeat Prescription exposed by ALEX.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationRequest |
0..* | AlexMedicationRequest | A request for a medication for a patient in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  id |
SΣ | 1..1 | id | The ID of the existing medication to be repeated. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
Content/Rules for all slices | |||
   longTerm |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-long-term ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| scheme |
0..1 | Coding | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-scheme Binding: Medication Scheme (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| unusualDose |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-unusual-dose ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| regulation24 |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-regulation-24 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| approvedNumber |
0..1 | string | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-approved-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 authorityNumber |
0..1 | string | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-authority-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. ele-1: All FHIR elements must have a @value or children Required Pattern: active |
| intent |
?!SΣ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. ele-1: All FHIR elements must have a @value or children Required Pattern: order |
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action ele-1: All FHIR elements must have a @value or children |
| Slices for medication[x] |
Σ | 1..1 | CodeableConcept | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. ele-1: All FHIR elements must have a @value or children |
| medication[x]:medicationReference |
SΣ | 0..1 | Reference(Medication) | Prescribed Medication ele-1: All FHIR elements must have a @value or children |
 medication[x]:medicationCodeableConcept |
SΣ | 1..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. ele-1: All FHIR elements must have a @value or children |
  Slices for coding |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
 coding:mimsPackage |
Σ | 1..1 | Coding | MIMS Package Binding: MIMS (preferred) ele-1: All FHIR elements must have a @value or children |
 system |
SΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://www.mims.com.au/codes |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
 display |
SΣ | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| text |
SΣ | 0..1 | string | Medication primary text ele-1: All FHIR elements must have a @value or children |
 subject |
SΣ | 1..1 | Reference(Patient | Group) | Who or group medication request is for ele-1: All FHIR elements must have a @value or children |
| Slices for supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children | |
| supportingInformation:bodyHeight |
0..1 | Reference(Observation Body Height Profile) | Observation of Body Height ele-1: All FHIR elements must have a @value or children | |
| supportingInformation:bodyWeight |
0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight ele-1: All FHIR elements must have a @value or children | |
| authoredOn |
SΣ | 1..1 | dateTime | Created date ele-1: All FHIR elements must have a @value or children |
| requester |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request ele-1: All FHIR elements must have a @value or children |
 note |
0..* | Annotation | Information about the prescription ele-1: All FHIR elements must have a @value or children | |
 text |
SΣC | 1..1 | markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children medication-request-note-length: Note - text size validation |
| dosageInstruction |
SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context ele-1: All FHIR elements must have a @value or children dosage-instruction-text-length: Dosage instruction - text size validation |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| text |
SΣ | 0..1 | string | Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children |
| patientInstruction |
SΣC | 0..1 | string | Patient or consumer oriented instructions ele-1: All FHIR elements must have a @value or children patient-instruction-length: Dosage instruction - patient instruction size validation |
| timing |
SΣ | 0..1 | Timing | Since daily frequency is user defineable in PMS, it may contain other code defined with Medtech extension ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
SΣ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: Daily Frequency Value Set for Dosage (extensible) ele-1: All FHIR elements must have a @value or children |
| doseAndRate |
SΣ | 0..* | Element | Amount of medication administered ele-1: All FHIR elements must have a @value or children |
| dispenseRequest |
S | 0..1 | BackboneElement | Requested dispensing ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| numberOfRepeatsAllowed |
S | 0..1 | unsignedInt | Maximum repeats authorised ele-1: All FHIR elements must have a @value or children |
| quantity |
S | 0..1 | SimpleQuantity | Amount of medication to supply per dispense ele-1: All FHIR elements must have a @value or children |
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
| unit |
SΣ | 0..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children |
 expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense ele-1: All FHIR elements must have a @value or children | |
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
| unit |
SΣ | 0..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children |
| system |
SΣC | 0..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Required Pattern: http://unitsofmeasure.org |
| substitution |
0..1 | BackboneElement | Brand substitution details ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for allowed[x] |
1..1 | Brand substitution flag Slice: Unordered, Open by type:$this Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. ele-1: All FHIR elements must have a @value or children | ||
| allowedBoolean |
boolean | |||
| allowedCodeableConcept |
CodeableConcept | |||
| allowed[x]:allowedBoolean |
S | 0..1 | boolean | Brand substitution flag ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MedicationRequest.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | |
| MedicationRequest.intent | required | Pattern: orderhttp://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:mimsPackage | preferred | MIMShttp://terminology.hl7.org.au/ValueSet/mims | |
| MedicationRequest.dosageInstruction.timing.code | extensible | DailyFrequencyhttps://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequencyfrom this IG | |
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode |
| 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() | |
| dosage-instruction-text-length | error | MedicationRequest.dosageInstruction | Dosage instruction - text size validation : text.length() <= 200 | |
| 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() | |
| medication-request-note-length | error | MedicationRequest.note.text | Note - text size validation : value.exists().not() or value.length() <= 256 | |
| patient-instruction-length | error | MedicationRequest.dosageInstruction.patientInstruction | Dosage instruction - patient instruction size validation : value.exists().not() or value.length() <= 32 |
This structure is derived from AlexMedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
0..* | AlexMedicationRequest | A request for a medication for a patient in an Australian healthcare context | |
 id |
S | 1..1 | id | The ID of the existing medication to be repeated. |
| Slices for medication[x] |
Content/Rules for all slices | |||
| medication[x]:medicationReference |
S | 0..1 | Reference(Medication) | Prescribed Medication |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | AlexMedicationRequest | A request for a medication for a patient in an Australian healthcare context | |||||
| id |
SΣ | 1..1 | id | The ID of the existing medication to be repeated. | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: Definition of Confidentiality Value Set (required) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: Writeback Action Type Value Set (required) | ||||
| 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 | |||||
| longTerm |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-long-term | |||||
| scheme |
0..1 | Coding | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-scheme Binding: Medication Scheme (required) | |||||
| unusualDose |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-unusual-dose | |||||
| regulation24 |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-regulation-24 | |||||
| approvedNumber |
0..1 | string | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-approved-number | |||||
| authorityNumber |
0..1 | string | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-authority-number | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
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. Required Pattern: active | ||||
| 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. Required Pattern: 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: Priority for Medication Request (required) | ||||
| 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 | CodeableConcept | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
| medication[x]:medicationReference |
SΣ | 0..1 | Reference(Medication) | Prescribed Medication | ||||
| medication[x]:medicationCodeableConcept |
SΣ | 1..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 |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:mimsPackage |
Σ | 1..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 |
SΣ | 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 |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
SΣ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
SΣ | 0..1 | string | Medication primary text | ||||
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who or group medication request is for | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Reference to Patient resource | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | External Name of Patient | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |||||
| Slices for supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() | |||||
| supportingInformation:bodyHeight |
0..1 | Reference(Observation Body Height Profile) | Observation of Body Height | |||||
| supportingInformation:bodyWeight |
0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight | |||||
| authoredOn |
SΣ | 1..1 | dateTime | Created date | ||||
| requester |
SΣ | 1..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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
SΣC | 1..1 | markdown | The annotation - text content (as markdown) medication-request-note-length: Note - text size validation | ||||
| dosageInstruction |
SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context dosage-instruction-text-length: Dosage instruction - text size validation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| sequence |
Σ | 0..1 | integer | The order of the dosage instructions | ||||
| text |
SΣ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
| additionalInstruction |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | ||||
| patientInstruction |
SΣC | 0..1 | string | Patient or consumer oriented instructions patient-instruction-length: Dosage instruction - patient instruction size validation | ||||
| timing |
SΣ | 0..1 | Timing | Since daily frequency is user defineable in PMS, it may contain other code defined with Medtech extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
SΣ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: Daily Frequency Value Set for Dosage (extensible) | ||||
| asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding  (preferred) | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | ||||
| route |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (required) | ||||
| method |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | ||||
| doseAndRate |
SΣ | 0..* | Element | Amount of medication administered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
| dose[x] |
Σ | 0..1 | Amount of medication per dose | |||||
| doseRange |
Range | |||||||
| doseQuantity |
Quantity(SimpleQuantity) | |||||||
| rate[x] |
Σ | 0..1 | Amount of medication per unit of time | |||||
| rateRatio |
Ratio | |||||||
| rateRange |
Range | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| maxDosePerPeriod |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||
| maxDosePerAdministration |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
| maxDosePerLifetime |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
| 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 | ||||
| numberOfRepeatsAllowed |
S | 0..1 | unsignedInt | Maximum repeats authorised | ||||
| quantity |
S | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| unit |
SΣ | 0..1 | string | Unit representation | ||||
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| unit |
SΣ | 0..1 | string | Unit representation | ||||
| system |
SΣC | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | ||||
| code |
Σ | 0..1 | code | Coded form of the unit Binding: Duration (required) | ||||
| 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 | ||||
| Slices for allowed[x] |
1..1 | Brand substitution flag Slice: Unordered, Open by type:$this Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||
| allowedBoolean |
boolean | |||||||
| allowedCodeableConcept |
CodeableConcept | |||||||
| allowed[x]:allowedBoolean |
S | 0..1 | boolean | Brand substitution flag | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MedicationRequest.meta.security | required | ConfidentialityVShttps://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentialityfrom this IG | ||||
| MedicationRequest.meta.tag | required | WritebackActionType (a valid code from Writeback Action Type CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/writeback-action-typefrom this IG | ||||
| MedicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationRequest.status | required | Pattern: activehttp://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 | Pattern: orderhttp://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 | MedicationRequestPriorityVShttps://alexapi.medtechglobal.com.au/fhir/ValueSet/request-priorityfrom this IG | ||||
| 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:mimsPackage | preferred | MIMShttp://terminology.hl7.org.au/ValueSet/mims | ||||
| MedicationRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| MedicationRequest.reasonCode | preferred | ReasonForRequesthttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1from this IG | ||||
| MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapyfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.code | extensible | DailyFrequencyhttps://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequencyfrom this IG | ||||
| MedicationRequest.dosageInstruction.asNeeded[x] | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | ||||
| MedicationRequest.dosageInstruction.site | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| MedicationRequest.dosageInstruction.route | required | RouteOfAdministrationhttps://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administrationfrom this IG | ||||
| MedicationRequest.dosageInstruction.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom the FHIR Standard | ||||
| MedicationRequest.dispenseRequest.expectedSupplyDuration.code | required | Durationhttps://alexapi.medtechglobal.com.au/fhir/ValueSet/durationfrom this IG | ||||
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| MedicationRequest.substitution.reason | preferred | MedicineSubstitutionReasonhttps://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1from this IG |
| 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() | |
| dosage-instruction-text-length | error | MedicationRequest.dosageInstruction | Dosage instruction - text size validation : text.length() <= 200 | |
| 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() | |
| medication-request-note-length | error | MedicationRequest.note.text | Note - text size validation : value.exists().not() or value.length() <= 256 | |
| patient-instruction-length | error | MedicationRequest.dosageInstruction.patientInstruction | Dosage instruction - patient instruction size validation : value.exists().not() or value.length() <= 32 |
This structure is derived from AlexMedicationRequest
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
0..* | AlexMedicationRequest | A request for a medication for a patient in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| id |
SΣ | 1..1 | id | The ID of the existing medication to be repeated. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| longTerm |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-long-term ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| scheme |
0..1 | Coding | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-scheme Binding: Medication Scheme (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| unusualDose |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-unusual-dose ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| regulation24 |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-regulation-24 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| approvedNumber |
0..1 | string | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-approved-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| authorityNumber |
0..1 | string | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-authority-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. ele-1: All FHIR elements must have a @value or children Required Pattern: active |
| intent |
?!SΣ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. ele-1: All FHIR elements must have a @value or children Required Pattern: order |
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action ele-1: All FHIR elements must have a @value or children |
| Slices for medication[x] |
Σ | 1..1 | CodeableConcept | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. ele-1: All FHIR elements must have a @value or children |
| medication[x]:medicationReference |
SΣ | 0..1 | Reference(Medication) | Prescribed Medication ele-1: All FHIR elements must have a @value or children |
| medication[x]:medicationCodeableConcept |
SΣ | 1..1 | CodeableConcept | Coded Prescribed Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. ele-1: All FHIR elements must have a @value or children |
| Slices for coding |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
| coding:mimsPackage |
Σ | 1..1 | Coding | MIMS Package Binding: MIMS (preferred) ele-1: All FHIR elements must have a @value or children |
| system |
SΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://www.mims.com.au/codes |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display |
SΣ | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| text |
SΣ | 0..1 | string | Medication primary text ele-1: All FHIR elements must have a @value or children |
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who or group medication request is for ele-1: All FHIR elements must have a @value or children |
| Slices for supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children | |
| supportingInformation:bodyHeight |
0..1 | Reference(Observation Body Height Profile) | Observation of Body Height ele-1: All FHIR elements must have a @value or children | |
| supportingInformation:bodyWeight |
0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight ele-1: All FHIR elements must have a @value or children | |
| authoredOn |
SΣ | 1..1 | dateTime | Created date ele-1: All FHIR elements must have a @value or children |
| requester |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request ele-1: All FHIR elements must have a @value or children |
| note |
0..* | Annotation | Information about the prescription ele-1: All FHIR elements must have a @value or children | |
| text |
SΣC | 1..1 | markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children medication-request-note-length: Note - text size validation |
| dosageInstruction |
SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context ele-1: All FHIR elements must have a @value or children dosage-instruction-text-length: Dosage instruction - text size validation |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| text |
SΣ | 0..1 | string | Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children |
| patientInstruction |
SΣC | 0..1 | string | Patient or consumer oriented instructions ele-1: All FHIR elements must have a @value or children patient-instruction-length: Dosage instruction - patient instruction size validation |
| timing |
SΣ | 0..1 | Timing | Since daily frequency is user defineable in PMS, it may contain other code defined with Medtech extension ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
SΣ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: Daily Frequency Value Set for Dosage (extensible) ele-1: All FHIR elements must have a @value or children |
| doseAndRate |
SΣ | 0..* | Element | Amount of medication administered ele-1: All FHIR elements must have a @value or children |
| dispenseRequest |
S | 0..1 | BackboneElement | Requested dispensing ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| numberOfRepeatsAllowed |
S | 0..1 | unsignedInt | Maximum repeats authorised ele-1: All FHIR elements must have a @value or children |
| quantity |
S | 0..1 | SimpleQuantity | Amount of medication to supply per dispense ele-1: All FHIR elements must have a @value or children |
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
| unit |
SΣ | 0..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children |
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense ele-1: All FHIR elements must have a @value or children | |
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
| unit |
SΣ | 0..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children |
| system |
SΣC | 0..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Required Pattern: http://unitsofmeasure.org |
| substitution |
0..1 | BackboneElement | Brand substitution details ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for allowed[x] |
1..1 | Brand substitution flag Slice: Unordered, Open by type:$this Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. ele-1: All FHIR elements must have a @value or children | ||
| allowedBoolean |
boolean | |||
| allowedCodeableConcept |
CodeableConcept | |||
| allowed[x]:allowedBoolean |
S | 0..1 | boolean | Brand substitution flag ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MedicationRequest.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | |
| MedicationRequest.intent | required | Pattern: orderhttp://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:mimsPackage | preferred | MIMShttp://terminology.hl7.org.au/ValueSet/mims | |
| MedicationRequest.dosageInstruction.timing.code | extensible | DailyFrequencyhttps://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequencyfrom this IG | |
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode |
| 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() | |
| dosage-instruction-text-length | error | MedicationRequest.dosageInstruction | Dosage instruction - text size validation : text.length() <= 200 | |
| 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() | |
| medication-request-note-length | error | MedicationRequest.note.text | Note - text size validation : value.exists().not() or value.length() <= 256 | |
| patient-instruction-length | error | MedicationRequest.dosageInstruction.patientInstruction | Dosage instruction - patient instruction size validation : value.exists().not() or value.length() <= 32 |
Differential View
This structure is derived from AlexMedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
0..* | AlexMedicationRequest | A request for a medication for a patient in an Australian healthcare context | |
| id |
S | 1..1 | id | The ID of the existing medication to be repeated. |
| Slices for medication[x] |
Content/Rules for all slices | |||
| medication[x]:medicationReference |
S | 0..1 | Reference(Medication) | Prescribed Medication |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | AlexMedicationRequest | A request for a medication for a patient in an Australian healthcare context | |||||
| id |
SΣ | 1..1 | id | The ID of the existing medication to be repeated. | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: Definition of Confidentiality Value Set (required) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: Writeback Action Type Value Set (required) | ||||
| 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 | |||||
| longTerm |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-long-term | |||||
| scheme |
0..1 | Coding | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-scheme Binding: Medication Scheme (required) | |||||
| unusualDose |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-unusual-dose | |||||
| regulation24 |
0..1 | boolean | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-regulation-24 | |||||
| approvedNumber |
0..1 | string | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-approved-number | |||||
| authorityNumber |
0..1 | string | Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-authority-number | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
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. Required Pattern: active | ||||
| 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. Required Pattern: 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: Priority for Medication Request (required) | ||||
| 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 | CodeableConcept | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
| medication[x]:medicationReference |
SΣ | 0..1 | Reference(Medication) | Prescribed Medication | ||||
| medication[x]:medicationCodeableConcept |
SΣ | 1..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 |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:mimsPackage |
Σ | 1..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 |
SΣ | 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 |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
SΣ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
SΣ | 0..1 | string | Medication primary text | ||||
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who or group medication request is for | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Reference to Patient resource | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | External Name of Patient | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |||||
| Slices for supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication Slice: Unordered, Open by profile:resolve() | |||||
| supportingInformation:bodyHeight |
0..1 | Reference(Observation Body Height Profile) | Observation of Body Height | |||||
| supportingInformation:bodyWeight |
0..1 | Reference(Observation Body Weight Profile) | Observation of Body Weight | |||||
| authoredOn |
SΣ | 1..1 | dateTime | Created date | ||||
| requester |
SΣ | 1..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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
SΣC | 1..1 | markdown | The annotation - text content (as markdown) medication-request-note-length: Note - text size validation | ||||
| dosageInstruction |
SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context dosage-instruction-text-length: Dosage instruction - text size validation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| sequence |
Σ | 0..1 | integer | The order of the dosage instructions | ||||
| text |
SΣ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
| additionalInstruction |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | ||||
| patientInstruction |
SΣC | 0..1 | string | Patient or consumer oriented instructions patient-instruction-length: Dosage instruction - patient instruction size validation | ||||
| timing |
SΣ | 0..1 | Timing | Since daily frequency is user defineable in PMS, it may contain other code defined with Medtech extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
SΣ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: Daily Frequency Value Set for Dosage (extensible) | ||||
| asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding (preferred) | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | ||||
| route |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (required) | ||||
| method |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | ||||
| doseAndRate |
SΣ | 0..* | Element | Amount of medication administered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
| dose[x] |
Σ | 0..1 | Amount of medication per dose | |||||
| doseRange |
Range | |||||||
| doseQuantity |
Quantity(SimpleQuantity) | |||||||
| rate[x] |
Σ | 0..1 | Amount of medication per unit of time | |||||
| rateRatio |
Ratio | |||||||
| rateRange |
Range | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| maxDosePerPeriod |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||
| maxDosePerAdministration |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
| maxDosePerLifetime |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
| 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 | ||||
| numberOfRepeatsAllowed |
S | 0..1 | unsignedInt | Maximum repeats authorised | ||||
| quantity |
S | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| unit |
SΣ | 0..1 | string | Unit representation | ||||
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| unit |
SΣ | 0..1 | string | Unit representation | ||||
| system |
SΣC | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | ||||
| code |
Σ | 0..1 | code | Coded form of the unit Binding: Duration (required) | ||||
| 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 | ||||
| Slices for allowed[x] |
1..1 | Brand substitution flag Slice: Unordered, Open by type:$this Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||
| allowedBoolean |
boolean | |||||||
| allowedCodeableConcept |
CodeableConcept | |||||||
| allowed[x]:allowedBoolean |
S | 0..1 | boolean | Brand substitution flag | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MedicationRequest.meta.security | required | ConfidentialityVShttps://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentialityfrom this IG | ||||
| MedicationRequest.meta.tag | required | WritebackActionType (a valid code from Writeback Action Type CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/writeback-action-typefrom this IG | ||||
| MedicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationRequest.status | required | Pattern: activehttp://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 | Pattern: orderhttp://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 | MedicationRequestPriorityVShttps://alexapi.medtechglobal.com.au/fhir/ValueSet/request-priorityfrom this IG | ||||
| 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:mimsPackage | preferred | MIMShttp://terminology.hl7.org.au/ValueSet/mims | ||||
| MedicationRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| MedicationRequest.reasonCode | preferred | ReasonForRequesthttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1from this IG | ||||
| MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapyfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.code | extensible | DailyFrequencyhttps://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequencyfrom this IG | ||||
| MedicationRequest.dosageInstruction.asNeeded[x] | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | ||||
| MedicationRequest.dosageInstruction.site | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| MedicationRequest.dosageInstruction.route | required | RouteOfAdministrationhttps://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administrationfrom this IG | ||||
| MedicationRequest.dosageInstruction.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom the FHIR Standard | ||||
| MedicationRequest.dispenseRequest.expectedSupplyDuration.code | required | Durationhttps://alexapi.medtechglobal.com.au/fhir/ValueSet/durationfrom this IG | ||||
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| MedicationRequest.substitution.reason | preferred | MedicineSubstitutionReasonhttps://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1from this IG |
| 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() | |
| dosage-instruction-text-length | error | MedicationRequest.dosageInstruction | Dosage instruction - text size validation : text.length() <= 200 | |
| 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() | |
| medication-request-note-length | error | MedicationRequest.note.text | Note - text size validation : value.exists().not() or value.length() <= 256 | |
| patient-instruction-length | error | MedicationRequest.dosageInstruction.patientInstruction | Dosage instruction - patient instruction size validation : value.exists().not() or value.length() <= 32 |
This structure is derived from AlexMedicationRequest
Other representations of profile: CSV, Excel, Schematron