FHIR New Zealand Patient Summary IG
0.7.0 - ci-build NZ

FHIR New Zealand Patient Summary IG - Local Development build (v0.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NZPS-MedicationRequest

Official URL: https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medicationrequest Version: 0.7.0
Active as of 2026-04-10 Realm: New Zealand flag Computable Name: NZPSMedicationRequest

MedicationRequest as referenced by the MedicationStatement resource constrained by this profile. Based on the IPS profile.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequestIPS Ordering of medication for patient or group
This profile also imposes the profile MedicationRequest resource for use in NZ
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
Required Pattern: false
... medication[x] SOΣ 1..1 Medication to be taken
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... medicationCodeableConcept CodeableConcept(CodeableConceptIPS)
.... medicationReference Reference(Medication (IPS))
... subject SOΣ 1..1 Reference(Patient (IPS)) Who or group medication request is for
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
... dosageInstruction SO 0..* Dosage How the medication should be taken
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text SOΣ 0..1 string Free text dosage instructions e.g. SIG
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... timing SOΣ 0..1 Timing When medication should be administered
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
From the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
From the FHIR Standard
MedicationRequest.medication[x]preferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationRequestIPS

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequestIPS Ordering of medication for patient or group
This profile also imposes the profile MedicationRequest resource for use in NZ

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequestIPS Ordering of medication for patient or group
This profile also imposes the profile MedicationRequest resource for use in NZ
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External ids for this request
... status ?!Σ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
... statusReason 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!Σ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.
... category 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
Required Pattern: false
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] SOΣ 1..1 Medication to be taken
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... medicationCodeableConcept CodeableConcept(CodeableConceptIPS)
.... medicationReference Reference(Medication (IPS))
... subject SOΣ 1..1 Reference(Patient (IPS)) Who or group medication request is for
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... 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 SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
... supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn Σ 0..1 dateTime When request was initially authored
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/What requested the Request
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
... reasonReference 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note 0..* Annotation Information about the prescription
... dosageInstruction SO 0..* Dosage How the medication should be taken
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... 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 SOΣ 0..1 string Free text dosage instructions e.g. SIG
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... 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 or consumer oriented instructions
.... timing SOΣ 0..1 Timing When medication should be administered
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... 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 (preferred): SNOMED Route Terms
Additional BindingsPurpose
Medicine EDQM Route of Administration - IPS candidate
.... 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
.... numberOfRepeatsAllowed 0..1 unsignedInt Number of refills authorized
.... quantity 0..1 SimpleQuantity(4.0.1) Amount of medication to supply per dispense
.... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1 Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
From the FHIR Standard
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason|4.0.1
From the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
From the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category|4.0.1
From the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
MedicationRequest.medication[x]preferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationRequest.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role|4.0.1
From the FHIR Standard
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code|4.0.1
From the FHIR Standard
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.routepreferredSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type|4.0.1
From the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationRequestIPS

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequestIPS Ordering of medication for patient or group
This profile also imposes the profile MedicationRequest resource for use in NZ
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
Required Pattern: false
... medication[x] SOΣ 1..1 Medication to be taken
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... medicationCodeableConcept CodeableConcept(CodeableConceptIPS)
.... medicationReference Reference(Medication (IPS))
... subject SOΣ 1..1 Reference(Patient (IPS)) Who or group medication request is for
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
... dosageInstruction SO 0..* Dosage How the medication should be taken
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text SOΣ 0..1 string Free text dosage instructions e.g. SIG
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... timing SOΣ 0..1 Timing When medication should be administered
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
From the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
From the FHIR Standard
MedicationRequest.medication[x]preferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from MedicationRequestIPS

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequestIPS Ordering of medication for patient or group
This profile also imposes the profile MedicationRequest resource for use in NZ

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequestIPS Ordering of medication for patient or group
This profile also imposes the profile MedicationRequest resource for use in NZ
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External ids for this request
... status ?!Σ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
... statusReason 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!Σ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.
... category 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
Required Pattern: false
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] SOΣ 1..1 Medication to be taken
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... medicationCodeableConcept CodeableConcept(CodeableConceptIPS)
.... medicationReference Reference(Medication (IPS))
... subject SOΣ 1..1 Reference(Patient (IPS)) Who or group medication request is for
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... 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 SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
... supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn Σ 0..1 dateTime When request was initially authored
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/What requested the Request
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
... reasonReference 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note 0..* Annotation Information about the prescription
... dosageInstruction SO 0..* Dosage How the medication should be taken
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... 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 SOΣ 0..1 string Free text dosage instructions e.g. SIG
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... 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 or consumer oriented instructions
.... timing SOΣ 0..1 Timing When medication should be administered
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationRequest (IPS)
SHALL:handle Consumer (IPS) from MedicationRequest (IPS)
SHOULD:display Consumer (IPS) from MedicationRequest (IPS)
.... 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 (preferred): SNOMED Route Terms
Additional BindingsPurpose
Medicine EDQM Route of Administration - IPS candidate
.... 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
.... numberOfRepeatsAllowed 0..1 unsignedInt Number of refills authorized
.... quantity 0..1 SimpleQuantity(4.0.1) Amount of medication to supply per dispense
.... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1 Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredmedicationrequest Status
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
From the FHIR Standard
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason|4.0.1
From the FHIR Standard
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
From the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category|4.0.1
From the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
MedicationRequest.medication[x]preferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationRequest.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role|4.0.1
From the FHIR Standard
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code|4.0.1
From the FHIR Standard
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.routepreferredSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes|4.0.1
From the FHIR Standard
MedicationRequest.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type|4.0.1
From the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationRequestIPS

Summary

 

Other representations of profile: CSV, Excel, Schematron