HL7® FHIR® New Zealand Base Implementation Guide
3.0.0 - Release

HL7® FHIR® New Zealand Base Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

Resource Profile: MedicationRequest resource for use in NZ

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzMedicationRequest Version: 1.0.0
Draft as of 2023-12-04 Realm: New Zealand flag Computable Name: NzMedicationRequest

MedicationRequest resource for use in NZ

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzeps-long-term-medication 0..1booleanNZePS Long Term Medication Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
... nzeps-supply-period-reason 0..1stringNZePS Supply Period Reason
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason
... Slices for medication[x] 1..1CodeableConcept, Reference(Medication)Medication to be taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptMedication to be taken
Binding: http://nzmt.org.nz/vs (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationRequest.medication[x]:medicationCodeableConceptpreferredhttp://nzmt.org.nz/vs
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzeps-long-term-medication 0..1booleanNZePS Long Term Medication Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
... nzeps-unusual-dose-quantity 0..1booleanNZePS Unusual Dose Quantity Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.

... intent ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... Slices for medication[x] Σ1..1Medication to be taken
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptMedication to be taken
Binding: http://nzmt.org.nz/vs (preferred)
... subject Σ1..1Reference(Patient | Group)Who or group medication request is for

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptpreferredhttp://nzmt.org.nz/vs
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzeps-long-term-medication 0..1booleanNZePS Long Term Medication Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
... nzeps-supply-period-reason 0..1stringNZePS Supply Period Reason
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason
... nzeps-unusual-dose-quantity 0..1booleanNZePS Unusual Dose Quantity Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal ids for this request
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.

... statusReason 0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

... intent ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... category 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.


... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] Σ1..1Medication to be taken
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptMedication to be taken
Binding: http://nzmt.org.nz/vs (preferred)
... subject Σ1..1Reference(Patient | Group)Who or group medication request is for
... encounter 0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn Σ0..1dateTimeWhen request was initially authored
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/What requested the Request
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.


... reasonReference 0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.

... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*DosageHow the medication should be taken
... dispenseRequest 0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill 0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntNumber of refills authorized
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution 0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy 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..1Reference(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

PathConformanceValueSet
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptpreferredhttp://nzmt.org.nz/vs
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason

This structure is derived from MedicationRequest

Summary

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationRequest.medication[x] is sliced based on the value of type:$this

Differential View

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzeps-long-term-medication 0..1booleanNZePS Long Term Medication Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
... nzeps-supply-period-reason 0..1stringNZePS Supply Period Reason
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason
... Slices for medication[x] 1..1CodeableConcept, Reference(Medication)Medication to be taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptMedication to be taken
Binding: http://nzmt.org.nz/vs (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationRequest.medication[x]:medicationCodeableConceptpreferredhttp://nzmt.org.nz/vs

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzeps-long-term-medication 0..1booleanNZePS Long Term Medication Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
... nzeps-unusual-dose-quantity 0..1booleanNZePS Unusual Dose Quantity Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.

... intent ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... Slices for medication[x] Σ1..1Medication to be taken
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptMedication to be taken
Binding: http://nzmt.org.nz/vs (preferred)
... subject Σ1..1Reference(Patient | Group)Who or group medication request is for

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptpreferredhttp://nzmt.org.nz/vs

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzeps-long-term-medication 0..1booleanNZePS Long Term Medication Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
... nzeps-supply-period-reason 0..1stringNZePS Supply Period Reason
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason
... nzeps-unusual-dose-quantity 0..1booleanNZePS Unusual Dose Quantity Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal ids for this request
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.

... statusReason 0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

... intent ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... category 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.


... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] Σ1..1Medication to be taken
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptMedication to be taken
Binding: http://nzmt.org.nz/vs (preferred)
... subject Σ1..1Reference(Patient | Group)Who or group medication request is for
... encounter 0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn Σ0..1dateTimeWhen request was initially authored
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/What requested the Request
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.


... reasonReference 0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.

... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*DosageHow the medication should be taken
... dispenseRequest 0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill 0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntNumber of refills authorized
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution 0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy 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..1Reference(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

PathConformanceValueSet
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptpreferredhttp://nzmt.org.nz/vs
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason

This structure is derived from MedicationRequest

Summary

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationRequest.medication[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron