NZ Shared Digital Health Record API
1.1.0 - release

NZ Shared Digital Health Record API - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SDHRMedicationRequest

Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRMedicationRequest Version: 1.1.0
Draft as of 2026-07-22 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

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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, Open by value:url
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Item status for the NZePS prescription item
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.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... Slices for medication[x] Σ 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medication[x]:medicationCodeableConcept Σ 1..1 CodeableConcept Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
... 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
... 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

doco Documentation for this format

Terminology Bindings

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.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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id 0..1 id MDR record identifier (SCID + item sequence number)
... meta
.... 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
... 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, Open by value:url
.... 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..0 code Legacy extension no longer supported
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-status-type
Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-status-type (required): Status Type for NZePS Prescriptions
... identifier 0..* Identifier NZePS prescription item ID (SCID + item sequence number)
... status 1..1 code Item status for the NZePS prescription item
... category 0..* CodeableConcept Medication request usage category
... Slices for medication[x] 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 1..1 CodeableConcept Medication to be taken
... 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
.... display 0..0 Text alternative for the resource
... 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
... 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
... note 0..0 Information about the prescription
... dosageInstruction
.... patientInstruction 0..1 string Patient instructions
... dispenseRequest
.... validityPeriod
..... end 0..1 dateTime Prescription expiry date
.... numberOfRepeatsAllowed 0..1 unsignedInt Number of repeats allowed
.... quantity 0..1 SimpleQuantity(4.0.1) Dispense quantity

doco Documentation for this format

Constraints

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})$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... 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, Open by value:url
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier NZePS prescription item ID (SCID + item sequence number)
... status ?!Σ 1..1 code Item status for the NZePS prescription item
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
... statusReason 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!Σ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.
... category 0..* CodeableConcept 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.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] Σ 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medication[x]:medicationCodeableConcept Σ 1..1 CodeableConcept Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
... 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
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... encounter 0..1 Reference(Encounter) 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..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... 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
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... dosageInstruction 0..* Dosage How the medication should be taken
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 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.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 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.
.... 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.
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... dispenseRequest 0..1 BackboneElement Medication supply authorization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill 0..1 BackboneElement First fill details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quantity 0..1 SimpleQuantity(4.0.1) First fill quantity
..... duration 0..1 Duration First fill duration
.... dispenseInterval 0..1 Duration Minimum period of time between dispenses
.... validityPeriod 0..1 Period Time period supply is authorized for
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 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..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1 Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.meta.​security Base extensible SecurityLabels 📍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 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.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 example 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.2
MedicationRequest.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.2

Constraints

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

Summary

Mandatory: 3 elements
Prohibited: 11 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationRequest.medication[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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, Open by value:url
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Item status for the NZePS prescription item
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.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... Slices for medication[x] Σ 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medication[x]:medicationCodeableConcept Σ 1..1 CodeableConcept Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
... 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
... 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

doco Documentation for this format

Terminology Bindings

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.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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id 0..1 id MDR record identifier (SCID + item sequence number)
... meta
.... 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
... 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, Open by value:url
.... 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..0 code Legacy extension no longer supported
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-status-type
Binding: http://hl7.org.nz/fhir/ValueSet/nzeps-status-type (required): Status Type for NZePS Prescriptions
... identifier 0..* Identifier NZePS prescription item ID (SCID + item sequence number)
... status 1..1 code Item status for the NZePS prescription item
... category 0..* CodeableConcept Medication request usage category
... Slices for medication[x] 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 1..1 CodeableConcept Medication to be taken
... 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
.... display 0..0 Text alternative for the resource
... 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
... 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
... note 0..0 Information about the prescription
... dosageInstruction
.... patientInstruction 0..1 string Patient instructions
... dispenseRequest
.... validityPeriod
..... end 0..1 dateTime Prescription expiry date
.... numberOfRepeatsAllowed 0..1 unsignedInt Number of repeats allowed
.... quantity 0..1 SimpleQuantity(4.0.1) Dispense quantity

doco Documentation for this format

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... 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, Open by value:url
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier NZePS prescription item ID (SCID + item sequence number)
... status ?!Σ 1..1 code Item status for the NZePS prescription item
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
... statusReason 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!Σ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.
... category 0..* CodeableConcept 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.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] Σ 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
.... medication[x]:medicationCodeableConcept Σ 1..1 CodeableConcept Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
... 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
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... encounter 0..1 Reference(Encounter) 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..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... 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
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... dosageInstruction 0..* Dosage How the medication should be taken
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 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.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 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.
.... 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.
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... dispenseRequest 0..1 BackboneElement Medication supply authorization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill 0..1 BackboneElement First fill details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quantity 0..1 SimpleQuantity(4.0.1) First fill quantity
..... duration 0..1 Duration First fill duration
.... dispenseInterval 0..1 Duration Minimum period of time between dispenses
.... validityPeriod 0..1 Period Time period supply is authorized for
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 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..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1 Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationRequest.meta.​security Base extensible SecurityLabels 📍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 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.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 example 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.2
MedicationRequest.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.2

Constraints

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

Summary

Mandatory: 3 elements
Prohibited: 11 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationRequest.medication[x]

 

Other representations of profile: CSV, Excel, Schematron