Medicines Data Repository Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/mdr/ and changes regularly. See the Directory of published versions
Resource Profile: Medication Request resource for use in the NZ e-Prescription Service MDR
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzepsMedicationRequest | Version: 0.1.0 | |||
| Draft as of 2024-09-30 | Computable Name: NzepsMedicationRequest | |||
Medication Request resource for use in NZ e-Prescription Service Medications Data Repository
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationRequest
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| MedicationRequest.medication[x] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
Terminology Bindings
| 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] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
Constraints
| 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 | Ordering of medication for patient or group | |||||
  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 |
10..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   nzeps-long-term-medication |
1..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |||||
| nzeps-supply-period-reason |
0..1 | string | NZePS Supply Period Reason URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason | |||||
| nzeps-unusual-dose-quantity |
1..1 | boolean | NZePS Unusual Dose Quantity Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity | |||||
| nzeps-endorsement |
0..* | (Complex) | NZePS Endorsement URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |||||
| nzeps-status-type |
1..1 | code | NZePS Status Type URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-status-type Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-status-type (required): Status Type for NZePS Prescriptions | |||||
| nzeps-medication-action |
1..1 | code | NZePS Medication Action Type URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-action Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-medication-action (required): Medication Action Type for NZePS Prescriptions | |||||
| nzeps-instructions-modified |
1..1 | boolean | NZePS Patient Instructions Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified | |||||
| nzeps-medication-modified |
1..1 | boolean | NZePS Patient Medication Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified | |||||
| nzeps-unsigned-rejection-reason |
0..1 | string | NZePS Unsigned Rejection Reason URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-unsigned-rejection-reason | |||||
| nzeps-trial-period-reason |
0..1 | string | NZePS Trial Period Reason URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-trial-period-reason | |||||
| nzeps-funding-category |
0..1 | string | NZePS Funding Category URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |||||
| nzeps-medication-claimable |
1..1 | boolean | NZePS Medication Claimable Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-claimable | |||||
| nzeps-private-item |
1..1 | boolean | NZePS Private Item Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-private-item | |||||
| nzeps-force-notification |
1..1 | boolean | NZePS Force Notification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-force-notification | |||||
 nzeps-notify |
1..1 | boolean | NZePS Active Notification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-notify | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | 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) | |||||||
| medication[x] |
Σ | 1..1 | CodeableConcept | Medication to be taken Binding: http://nzmt.org.nz/vs (preferred) | ||||
| 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 | |||||
| supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication | |||||
| authoredOn |
Σ | 0..1 | dateTime | When request was initially authored | ||||
| 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: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||
| 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..* | Dosage | How the medication should be taken | |||||
| dispenseRequest |
0..1 | BackboneElement | Medication supply authorization | |||||
| 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 | Number of refills authorized | |||||
| 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 | Any restrictions on medication substitution | |||||
| 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 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||
| allowedBoolean |
boolean | |||||||
| allowedCodeableConcept |
CodeableConcept | |||||||
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
| priorPrescription |
0..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 | ||||||||
Terminology Bindings
| 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] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| 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 | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Constraints
| 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: 10 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-status-type
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-action
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-unsigned-rejection-reason
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-trial-period-reason
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-claimable
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-private-item
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-force-notification
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-notify
Differential View
This structure is derived from MedicationRequest
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| MedicationRequest.medication[x] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
Key Elements View
Terminology Bindings
| 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] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
Constraints
| 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 | Ordering of medication for patient or group | |||||
| 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 |
10..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| nzeps-long-term-medication |
1..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |||||
| nzeps-supply-period-reason |
0..1 | string | NZePS Supply Period Reason URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason | |||||
| nzeps-unusual-dose-quantity |
1..1 | boolean | NZePS Unusual Dose Quantity Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity | |||||
| nzeps-endorsement |
0..* | (Complex) | NZePS Endorsement URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |||||
| nzeps-status-type |
1..1 | code | NZePS Status Type URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-status-type Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-status-type (required): Status Type for NZePS Prescriptions | |||||
| nzeps-medication-action |
1..1 | code | NZePS Medication Action Type URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-action Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-medication-action (required): Medication Action Type for NZePS Prescriptions | |||||
| nzeps-instructions-modified |
1..1 | boolean | NZePS Patient Instructions Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified | |||||
| nzeps-medication-modified |
1..1 | boolean | NZePS Patient Medication Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified | |||||
| nzeps-unsigned-rejection-reason |
0..1 | string | NZePS Unsigned Rejection Reason URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-unsigned-rejection-reason | |||||
| nzeps-trial-period-reason |
0..1 | string | NZePS Trial Period Reason URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-trial-period-reason | |||||
| nzeps-funding-category |
0..1 | string | NZePS Funding Category URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |||||
| nzeps-medication-claimable |
1..1 | boolean | NZePS Medication Claimable Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-claimable | |||||
| nzeps-private-item |
1..1 | boolean | NZePS Private Item Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-private-item | |||||
| nzeps-force-notification |
1..1 | boolean | NZePS Force Notification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-force-notification | |||||
| nzeps-notify |
1..1 | boolean | NZePS Active Notification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-notify | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | 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) | |||||||
| medication[x] |
Σ | 1..1 | CodeableConcept | Medication to be taken Binding: http://nzmt.org.nz/vs (preferred) | ||||
| 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 | |||||
| supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication | |||||
| authoredOn |
Σ | 0..1 | dateTime | When request was initially authored | ||||
| 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: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||
| 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..* | Dosage | How the medication should be taken | |||||
| dispenseRequest |
0..1 | BackboneElement | Medication supply authorization | |||||
| 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 | Number of refills authorized | |||||
| 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 | Any restrictions on medication substitution | |||||
| 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 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||
| allowedBoolean |
boolean | |||||||
| allowedCodeableConcept |
CodeableConcept | |||||||
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
| priorPrescription |
0..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 | ||||||||
Terminology Bindings
| 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] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| 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 | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Constraints
| 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: 10 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-status-type
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-action
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-unsigned-rejection-reason
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-trial-period-reason
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-claimable
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-private-item
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-force-notification
- http://hl7.org.nz/fhir/StructureDefinition/nzeps-notify
Other representations of profile: CSV, Excel, Schematron