NZ Shared Digital Health Record API
1.1.6 - release
NZ Shared Digital Health Record API
1.1.6 - release
NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRMedicationRequest | Version: 1.1.6 | |||
| Draft as of 2026-10-20 | Computable Name: SDHRMedicationRequest | |||
DRAFT PROFILE: MedicationRequest resource for Shared Digital Health Record. This profile constrains MedicationRequest to the SDHR subset of MDR medication request content.
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:  |
|---|---|---|---|---|
  MedicationRequest |
0..* | MedicationRequest | Ordering of medication for patient or group | |
  id |
0..1 | id | MDR record identifier (SCID + item sequence number) | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:LongTermMedication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |
| extension:InstructionsModified |
0..1 | boolean | NZePS Patient Instructions Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified | |
| extension:MedicationModified |
0..1 | boolean | NZePS Patient Medication Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified | |
 extension:ItemStatus |
0..1 | code | NZePS item status, including sub-status for active prescriptions URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-item-status | |
 identifier |
0..* | Identifier | NZePS prescription item ID (SCID + item sequence number) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
 system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| status |
1..1 | code | Status of the medication request Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | |
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | |
| category |
0..* | CodeableConcept | Medication request usage category 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. | |
| 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. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | |
   extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
 subject |
1..1 | Reference(Patient) | Patient for the medication request | |
| reference |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format |
| type |
1..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). Required Pattern: Patient (extensions allowed) | |
| supportingInformation |
0..* | Reference(Resource) | Location or facility information supporting the request | |
| authoredOn |
0..1 | dateTime | When the request was authored | |
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who requested the medication request | |
| reasonCode |
0..* | CodeableConcept | Reason for the medication request Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |
| reasonReference |
0..* | Reference(Condition | Observation) | Reference supporting the medication request reason | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍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.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| 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()
|
| nhi-url-format | error | MedicationRequest.subject.reference | Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA |
matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
This structure is derived from MedicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | Ordering of medication for patient or group | |
 id |
0..1 | id | MDR record identifier (SCID + item sequence number) | |
| meta |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| source |
0..0 | Identifies where the resource comes from | ||
| profile |
0..0 | Profiles this resource claims to conform to | ||
| security |
0..1 | Coding | Security Labels applied to this resource | |
| tag |
0..0 | Tags applied to this resource | ||
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:LongTermMedication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |
| extension:InstructionsModified |
0..1 | boolean | NZePS Patient Instructions Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified | |
| extension:MedicationModified |
0..1 | boolean | NZePS Patient Medication Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified | |
| extension:ItemStatus |
0..1 | code | NZePS item status, including sub-status for active prescriptions URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-item-status | |
 modifierExtension |
0..0 | Extension | ||
| identifier |
0..* | Identifier | NZePS prescription item ID (SCID + item sequence number) | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| status |
1..1 | code | Status of the medication request | |
| statusReason |
0..0 | Reason for current status | ||
| category |
0..* | CodeableConcept | Medication request usage category | |
| priority |
0..0 | routine | urgent | asap | stat | ||
| doNotPerform |
0..0 | True if request is prohibiting action | ||
| reported[x] |
0..0 | Reported rather than primary record | ||
| Slices for medication[x] |
1..1 | CodeableConcept | Medication to be taken Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Medication to be taken | |
 id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
 coding |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| version |
0..0 | Version of the system - if relevant | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| subject |
1..1 | Reference(Patient) | Patient for the medication request | |
| reference |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient (extensions allowed) | |
| display |
0..0 | Text alternative for the resource | ||
| encounter |
0..0 | Encounter created as part of encounter/admission/stay | ||
| supportingInformation |
0..* | Reference(Resource) | Location or facility information supporting the request | |
| authoredOn |
0..1 | dateTime | When the request was authored | |
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who requested the medication request | |
| performer |
0..0 | Intended performer of administration | ||
| performerType |
0..0 | Desired kind of performer of the medication administration | ||
| recorder |
0..0 | Person who entered the request | ||
| reasonCode |
0..* | CodeableConcept | Reason for the medication request | |
| reasonReference |
0..* | Reference(Condition | Observation) | Reference supporting the medication request reason | |
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..0 | What request fulfills | ||
| groupIdentifier |
0..0 | Composite request this is part of | ||
| courseOfTherapyType |
0..0 | Overall pattern of medication administration | ||
| insurance |
0..0 | Associated insurance coverage | ||
| note |
0..0 | Information about the prescription | ||
| dosageInstruction |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| sequence |
0..0 | The order of the dosage instructions | ||
| text |
0..0 | Free text dosage instructions e.g. SIG | ||
| additionalInstruction |
0..0 | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | ||
| patientInstruction |
0..1 | string | Patient instructions | |
| timing |
0..0 | When medication should be administered | ||
| asNeeded[x] |
0..0 | Take "as needed" (for x) | ||
| site |
0..0 | Body site to administer to | ||
| method |
0..0 | Technique for administering medication | ||
| doseAndRate |
0..0 | Amount of medication administered | ||
| maxDosePerPeriod |
0..0 | Upper limit on medication per unit of time | ||
| maxDosePerAdministration |
0..0 | Upper limit on medication per administration | ||
| maxDosePerLifetime |
0..0 | Upper limit on medication per lifetime of the patient | ||
| dispenseRequest |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| initialFill |
0..0 | First fill details | ||
| dispenseInterval |
0..0 | Minimum period of time between dispenses | ||
| validityPeriod |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| start |
0..0 | Starting time with inclusive boundary | ||
| end |
0..1 | dateTime | Prescription expiry date | |
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Number of repeats allowed | |
| quantity |
0..1 | SimpleQuantity(4.0.1) | Dispense quantity | |
| expectedSupplyDuration |
0..0 | Number of days supply per dispense | ||
| performer |
0..0 | Intended dispenser | ||
| substitution |
0..0 | Any restrictions on medication substitution | ||
| priorPrescription |
0..0 | An order/prescription that is being replaced | ||
| detectedIssue |
0..0 | Clinical Issue with action | ||
| eventHistory |
0..0 | A list of events of interest in the lifecycle | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| nhi-url-format | error | MedicationRequest.subject.reference | Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA |
matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | Ordering of medication for patient or group | |
| id |
0..1 | id | MDR record identifier (SCID + item sequence number) | |
| meta |
0..1 | Meta | Metadata about the resource | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| security |
0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:LongTermMedication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |
| extension:InstructionsModified |
0..1 | boolean | NZePS Patient Instructions Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified | |
| extension:MedicationModified |
0..1 | boolean | NZePS Patient Medication Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified | |
| extension:ItemStatus |
0..1 | code | NZePS item status, including sub-status for active prescriptions URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-item-status | |
| identifier |
0..* | Identifier | NZePS prescription item ID (SCID + item sequence number) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | Status of the medication request Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | |
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | |
| category |
0..* | CodeableConcept | Medication request usage category 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. | |
| 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. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
 coding |
0..* | Coding | Code defined by a terminology system | |
 extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| text |
0..1 | string | Plain text representation of the concept | |
| subject |
1..1 | Reference(Patient) | Patient for the medication request | |
| 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 | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format |
| type |
1..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). Required Pattern: Patient (extensions allowed) | |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| supportingInformation |
0..* | Reference(Resource) | Location or facility information supporting the request | |
| authoredOn |
0..1 | dateTime | When the request was authored | |
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who requested the medication request | |
| reasonCode |
0..* | CodeableConcept | Reason for the medication request Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |
| reasonReference |
0..* | Reference(Condition | Observation) | Reference supporting the medication request reason | |
| dosageInstruction |
0..* | Dosage | How the medication should be taken | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| patientInstruction |
0..1 | string | Patient instructions | |
| route |
0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |
 dispenseRequest |
0..1 | BackboneElement | Medication supply authorization | |
| validityPeriod |
0..1 | Period | Time period supply is authorized for | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| end |
C | 0..1 | dateTime | Prescription expiry date |
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Number of repeats allowed | |
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | Dispense quantity Constraints: sqty-1 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| MedicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍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.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.route | Base | example | SNOMED CT Route 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.4 |
| MedicationRequest.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.4 |
| 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()
|
| nhi-url-format | error | MedicationRequest.subject.reference | Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA |
matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| sqty-1 | error | MedicationRequest.dispenseRequest.initialFill.quantity, MedicationRequest.dispenseRequest.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from MedicationRequest
Summary
Mandatory: 3 elements(1 nested mandatory element)
Prohibited: 60 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | Ordering of medication for patient or group | |
| id |
0..1 | id | MDR record identifier (SCID + item sequence number) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:LongTermMedication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |
| extension:InstructionsModified |
0..1 | boolean | NZePS Patient Instructions Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified | |
| extension:MedicationModified |
0..1 | boolean | NZePS Patient Medication Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified | |
| extension:ItemStatus |
0..1 | code | NZePS item status, including sub-status for active prescriptions URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-item-status | |
| identifier |
0..* | Identifier | NZePS prescription item ID (SCID + item sequence number) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| status |
1..1 | code | Status of the medication request Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | |
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | |
| category |
0..* | CodeableConcept | Medication request usage category 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. | |
| 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. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| subject |
1..1 | Reference(Patient) | Patient for the medication request | |
| reference |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format |
| type |
1..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). Required Pattern: Patient (extensions allowed) | |
| supportingInformation |
0..* | Reference(Resource) | Location or facility information supporting the request | |
| authoredOn |
0..1 | dateTime | When the request was authored | |
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who requested the medication request | |
| reasonCode |
0..* | CodeableConcept | Reason for the medication request Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |
| reasonReference |
0..* | Reference(Condition | Observation) | Reference supporting the medication request reason | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍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.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| 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()
|
| nhi-url-format | error | MedicationRequest.subject.reference | Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA |
matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
Differential View
This structure is derived from MedicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | Ordering of medication for patient or group | |
| id |
0..1 | id | MDR record identifier (SCID + item sequence number) | |
| meta |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| source |
0..0 | Identifies where the resource comes from | ||
| profile |
0..0 | Profiles this resource claims to conform to | ||
| security |
0..1 | Coding | Security Labels applied to this resource | |
| tag |
0..0 | Tags applied to this resource | ||
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:LongTermMedication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |
| extension:InstructionsModified |
0..1 | boolean | NZePS Patient Instructions Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified | |
| extension:MedicationModified |
0..1 | boolean | NZePS Patient Medication Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified | |
| extension:ItemStatus |
0..1 | code | NZePS item status, including sub-status for active prescriptions URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-item-status | |
| modifierExtension |
0..0 | Extension | ||
| identifier |
0..* | Identifier | NZePS prescription item ID (SCID + item sequence number) | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| status |
1..1 | code | Status of the medication request | |
| statusReason |
0..0 | Reason for current status | ||
| category |
0..* | CodeableConcept | Medication request usage category | |
| priority |
0..0 | routine | urgent | asap | stat | ||
| doNotPerform |
0..0 | True if request is prohibiting action | ||
| reported[x] |
0..0 | Reported rather than primary record | ||
| Slices for medication[x] |
1..1 | CodeableConcept | Medication to be taken Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Medication to be taken | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| coding |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| version |
0..0 | Version of the system - if relevant | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| subject |
1..1 | Reference(Patient) | Patient for the medication request | |
| reference |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient (extensions allowed) | |
| display |
0..0 | Text alternative for the resource | ||
| encounter |
0..0 | Encounter created as part of encounter/admission/stay | ||
| supportingInformation |
0..* | Reference(Resource) | Location or facility information supporting the request | |
| authoredOn |
0..1 | dateTime | When the request was authored | |
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who requested the medication request | |
| performer |
0..0 | Intended performer of administration | ||
| performerType |
0..0 | Desired kind of performer of the medication administration | ||
| recorder |
0..0 | Person who entered the request | ||
| reasonCode |
0..* | CodeableConcept | Reason for the medication request | |
| reasonReference |
0..* | Reference(Condition | Observation) | Reference supporting the medication request reason | |
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..0 | What request fulfills | ||
| groupIdentifier |
0..0 | Composite request this is part of | ||
| courseOfTherapyType |
0..0 | Overall pattern of medication administration | ||
| insurance |
0..0 | Associated insurance coverage | ||
| note |
0..0 | Information about the prescription | ||
| dosageInstruction |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| sequence |
0..0 | The order of the dosage instructions | ||
| text |
0..0 | Free text dosage instructions e.g. SIG | ||
| additionalInstruction |
0..0 | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | ||
| patientInstruction |
0..1 | string | Patient instructions | |
| timing |
0..0 | When medication should be administered | ||
| asNeeded[x] |
0..0 | Take "as needed" (for x) | ||
| site |
0..0 | Body site to administer to | ||
| method |
0..0 | Technique for administering medication | ||
| doseAndRate |
0..0 | Amount of medication administered | ||
| maxDosePerPeriod |
0..0 | Upper limit on medication per unit of time | ||
| maxDosePerAdministration |
0..0 | Upper limit on medication per administration | ||
| maxDosePerLifetime |
0..0 | Upper limit on medication per lifetime of the patient | ||
| dispenseRequest |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| initialFill |
0..0 | First fill details | ||
| dispenseInterval |
0..0 | Minimum period of time between dispenses | ||
| validityPeriod |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| start |
0..0 | Starting time with inclusive boundary | ||
| end |
0..1 | dateTime | Prescription expiry date | |
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Number of repeats allowed | |
| quantity |
0..1 | SimpleQuantity(4.0.1) | Dispense quantity | |
| expectedSupplyDuration |
0..0 | Number of days supply per dispense | ||
| performer |
0..0 | Intended dispenser | ||
| substitution |
0..0 | Any restrictions on medication substitution | ||
| priorPrescription |
0..0 | An order/prescription that is being replaced | ||
| detectedIssue |
0..0 | Clinical Issue with action | ||
| eventHistory |
0..0 | A list of events of interest in the lifecycle | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| nhi-url-format | error | MedicationRequest.subject.reference | Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA |
matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | Ordering of medication for patient or group | |
| id |
0..1 | id | MDR record identifier (SCID + item sequence number) | |
| meta |
0..1 | Meta | Metadata about the resource | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| security |
0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:LongTermMedication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |
| extension:InstructionsModified |
0..1 | boolean | NZePS Patient Instructions Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified | |
| extension:MedicationModified |
0..1 | boolean | NZePS Patient Medication Modification Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified | |
| extension:ItemStatus |
0..1 | code | NZePS item status, including sub-status for active prescriptions URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-item-status | |
| identifier |
0..* | Identifier | NZePS prescription item ID (SCID + item sequence number) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | Status of the medication request Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | |
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | |
| category |
0..* | CodeableConcept | Medication request usage category 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. | |
| 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. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| coding |
0..* | Coding | Code defined by a terminology system | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| text |
0..1 | string | Plain text representation of the concept | |
| subject |
1..1 | Reference(Patient) | Patient for the medication request | |
| 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 | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format |
| type |
1..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). Required Pattern: Patient (extensions allowed) | |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| supportingInformation |
0..* | Reference(Resource) | Location or facility information supporting the request | |
| authoredOn |
0..1 | dateTime | When the request was authored | |
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who requested the medication request | |
| reasonCode |
0..* | CodeableConcept | Reason for the medication request Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |
| reasonReference |
0..* | Reference(Condition | Observation) | Reference supporting the medication request reason | |
| dosageInstruction |
0..* | Dosage | How the medication should be taken | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| patientInstruction |
0..1 | string | Patient instructions | |
| route |
0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |
| dispenseRequest |
0..1 | BackboneElement | Medication supply authorization | |
| validityPeriod |
0..1 | Period | Time period supply is authorized for | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| end |
C | 0..1 | dateTime | Prescription expiry date |
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Number of repeats allowed | |
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | Dispense quantity Constraints: sqty-1 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| MedicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍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.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.route | Base | example | SNOMED CT Route 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.4 |
| MedicationRequest.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.4 |
| 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()
|
| nhi-url-format | error | MedicationRequest.subject.reference | Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA |
matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| sqty-1 | error | MedicationRequest.dispenseRequest.initialFill.quantity, MedicationRequest.dispenseRequest.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from MedicationRequest
Summary
Mandatory: 3 elements(1 nested mandatory element)
Prohibited: 60 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron