FHIR New Zealand Patient Summary IG
0.7.0 - ci-build
FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.7.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medicationrequest | Version: 0.7.0 | |||
| Active as of 2026-05-04 | Computable Name: NZPSMedicationRequest | |||
MedicationRequest as referenced by the MedicationStatement resource constrained by this profile. Based on the IPS profile.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationRequestIPS | Ordering of medication for patient or group This profile also imposes the profile MedicationRequest resource for use in NZ | |||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
?!Σ | 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. | ||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action Required Pattern: false | ||||||||||||
![]() ![]() |
SOΣ | 1..1 | Medication to be taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
| |||||||||||||
![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||
![]() ![]() ![]() |
Reference(Medication (IPS)) | |||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(Patient (IPS)) | Who or group medication request is for
| ||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
![]() ![]() |
SO | 0..* | Dosage | How the medication should be taken
| ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Timing | When medication should be administered
| ||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| 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 MedicationRequestIPS
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationRequestIPS | Ordering of medication for patient or group This profile also imposes the profile MedicationRequest resource for use in NZ | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationRequestIPS | Ordering of medication for patient or group This profile also imposes the profile MedicationRequest resource for use in NZ | |||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
0..* | Identifier | External ids for this request | |||||||||||||
![]() ![]() |
?!Σ | 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. | ||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | ||||||||||||
![]() ![]() |
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. | |||||||||||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action Required Pattern: false | ||||||||||||
![]() ![]() |
Σ | 0..1 | Reported rather than primary record | |||||||||||||
![]() ![]() ![]() |
boolean | |||||||||||||||
![]() ![]() ![]() |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Medication to be taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
| |||||||||||||
![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||
![]() ![]() ![]() |
Reference(Medication (IPS)) | |||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(Patient (IPS)) | Who or group medication request is for
| ||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
![]() ![]() ![]() |
Σ | 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). | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |||||||||||||
![]() ![]() |
0..* | Reference(Resource) | Information to support ordering of the medication | |||||||||||||
![]() ![]() |
Σ | 0..1 | dateTime | When request was initially authored | ||||||||||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request | ||||||||||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||||||||||
![]() ![]() |
Σ | 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. | ||||||||||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||||||||||
![]() ![]() |
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. | |||||||||||||
![]() ![]() |
0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||||||||||
![]() ![]() |
Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||||||||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||||||||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||||||||||
![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||||||||||
![]() ![]() |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||||||||||
![]() ![]() |
0..* | Annotation | Information about the prescription | |||||||||||||
![]() ![]() |
SO | 0..* | Dosage | How the medication should be taken
| ||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Timing | When medication should be administered
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |||||||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Element | Amount of medication administered | ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per dose | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient | ||||||||||||
![]() ![]() |
0..1 | BackboneElement | Medication supply authorization | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
0..1 | BackboneElement | First fill details | |||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | First fill quantity | |||||||||||||
![]() ![]() ![]() ![]() |
0..1 | Duration | First fill duration | |||||||||||||
![]() ![]() ![]() |
0..1 | Duration | Minimum period of time between dispenses | |||||||||||||
![]() ![]() ![]() |
0..1 | Period | Time period supply is authorized for | |||||||||||||
![]() ![]() ![]() |
0..1 | unsignedInt | Number of refills authorized | |||||||||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Amount of medication to supply per dispense | |||||||||||||
![]() ![]() ![]() |
0..1 | Duration | Number of days supply per dispense | |||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Intended dispenser | |||||||||||||
![]() ![]() |
0..1 | BackboneElement | Any restrictions on medication substitution | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
1..1 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() |
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. | |||||||||||||
![]() ![]() |
0..1 | Reference(MedicationRequest) | An order/prescription that is being replaced | |||||||||||||
![]() ![]() |
0..* | Reference(DetectedIssue) | Clinical Issue with action | |||||||||||||
![]() ![]() |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.statusReason | Base | example | Medication request status reason codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | example | Medication request category codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| MedicationRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.1 |
| MedicationRequest.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.1 |
| Id | Grade | Path(s) | Description | Expression |
| 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 MedicationRequestIPS
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationRequestIPS | Ordering of medication for patient or group This profile also imposes the profile MedicationRequest resource for use in NZ | |||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
?!Σ | 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. | ||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action Required Pattern: false | ||||||||||||
![]() ![]() |
SOΣ | 1..1 | Medication to be taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
| |||||||||||||
![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||
![]() ![]() ![]() |
Reference(Medication (IPS)) | |||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(Patient (IPS)) | Who or group medication request is for
| ||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
![]() ![]() |
SO | 0..* | Dosage | How the medication should be taken
| ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Timing | When medication should be administered
| ||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from MedicationRequestIPS
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationRequestIPS | Ordering of medication for patient or group This profile also imposes the profile MedicationRequest resource for use in NZ | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationRequestIPS | Ordering of medication for patient or group This profile also imposes the profile MedicationRequest resource for use in NZ | |||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
0..* | Identifier | External ids for this request | |||||||||||||
![]() ![]() |
?!Σ | 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. | ||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | ||||||||||||
![]() ![]() |
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. | |||||||||||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action Required Pattern: false | ||||||||||||
![]() ![]() |
Σ | 0..1 | Reported rather than primary record | |||||||||||||
![]() ![]() ![]() |
boolean | |||||||||||||||
![]() ![]() ![]() |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Medication to be taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
| |||||||||||||
![]() ![]() ![]() |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||
![]() ![]() ![]() |
Reference(Medication (IPS)) | |||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(Patient (IPS)) | Who or group medication request is for
| ||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
![]() ![]() ![]() |
Σ | 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). | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |||||||||||||
![]() ![]() |
0..* | Reference(Resource) | Information to support ordering of the medication | |||||||||||||
![]() ![]() |
Σ | 0..1 | dateTime | When request was initially authored | ||||||||||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request | ||||||||||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||||||||||
![]() ![]() |
Σ | 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. | ||||||||||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||||||||||
![]() ![]() |
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. | |||||||||||||
![]() ![]() |
0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||||||||||
![]() ![]() |
Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||||||||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||||||||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||||||||||
![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||||||||||
![]() ![]() |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||||||||||
![]() ![]() |
0..* | Annotation | Information about the prescription | |||||||||||||
![]() ![]() |
SO | 0..* | Dosage | How the medication should be taken
| ||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Timing | When medication should be administered
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |||||||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Element | Amount of medication administered | ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per dose | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient | ||||||||||||
![]() ![]() |
0..1 | BackboneElement | Medication supply authorization | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
0..1 | BackboneElement | First fill details | |||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | First fill quantity | |||||||||||||
![]() ![]() ![]() ![]() |
0..1 | Duration | First fill duration | |||||||||||||
![]() ![]() ![]() |
0..1 | Duration | Minimum period of time between dispenses | |||||||||||||
![]() ![]() ![]() |
0..1 | Period | Time period supply is authorized for | |||||||||||||
![]() ![]() ![]() |
0..1 | unsignedInt | Number of refills authorized | |||||||||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Amount of medication to supply per dispense | |||||||||||||
![]() ![]() ![]() |
0..1 | Duration | Number of days supply per dispense | |||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Intended dispenser | |||||||||||||
![]() ![]() |
0..1 | BackboneElement | Any restrictions on medication substitution | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
1..1 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() |
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. | |||||||||||||
![]() ![]() |
0..1 | Reference(MedicationRequest) | An order/prescription that is being replaced | |||||||||||||
![]() ![]() |
0..* | Reference(DetectedIssue) | Clinical Issue with action | |||||||||||||
![]() ![]() |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.statusReason | Base | example | Medication request status reason codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | example | Medication request category codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| MedicationRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.1 |
| MedicationRequest.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.1 |
| Id | Grade | Path(s) | Description | Expression |
| 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 MedicationRequestIPS
Other representations of profile: CSV, Excel, Schematron