NZ Shared Digital Health Record API
1.1.6 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

Resource Profile: SDHRMedicationRequest - Detailed Descriptions

Draft as of 2026-10-20

Definitions for the SDHRMedicationRequest resource profile.

See the documentation on how to interpret the contents of this table

0. MedicationRequest
Definition

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

ShortOrdering of medication for patient or group
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesPrescription, Order
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. MedicationRequest.id
Definition

The MDR identifier for this MedicationRequest resource, composed of the NZePS prescription SCID and the item sequence number.


The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortMDR record identifier (SCID + item sequence number)Logical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. MedicationRequest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..01
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. MedicationRequest.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..01
BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. MedicationRequest.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..01
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. MedicationRequest.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..0*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
12. MedicationRequest.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationRequest.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators:
  • value @ url
  • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

    14. MedicationRequest.extension:LongTermMedication
    Slice NameLongTermMedication
    Definition

    NZePS Long Term Medication Indicator

    ShortNZePS Long Term Medication Indicator
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(NZePS Long Term Medication Indicator) (Extension Type: boolean)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. MedicationRequest.extension:InstructionsModified
    Slice NameInstructionsModified
    Definition

    NZePS Patients Instructions modification indicator

    ShortNZePS Patient Instructions Modification Indicator
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(NZePS Patient Instructions Modification Indicator) (Extension Type: boolean)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. MedicationRequest.extension:MedicationModified
    Slice NameMedicationModified
    Definition

    NZePS medication modification indicator

    ShortNZePS Patient Medication Modification Indicator
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(NZePS Patient Medication Modification Indicator) (Extension Type: boolean)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. MedicationRequest.extension:ItemStatus
    Slice NameItemStatus
    Definition

    The NZePS item status supplied by MDR, returned separately from MedicationRequest.status. For active prescriptions it may indicate whether repeats remain. SEHRs may use it to display a repeats-remaining flag; SDHR status filtering uses MedicationRequest.status.

    ShortNZePS item status, including sub-status for active prescriptions
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(NZePS Item Status) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    22. MedicationRequest.modifierExtension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensionExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..0*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    24. MedicationRequest.identifier
    Definition

    NZePS SCID + item sequence number. This identifier links the prescription item to dispense records and excludes GTIN barcode values.


    Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

    ShortNZePS prescription item ID (SCID + item sequence number)External ids for this request
    Comments

    This is a business identifier, not a resource identifier.

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. MedicationRequest.identifier.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. MedicationRequest.identifier.system
    Definition

    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    ShortThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    Pattern Value
    {
      "system" : "https://standards.digital.health.nz/ns/nzeps-scid-item-id"
    }
    <system value="https://standards.digital.health.nz/ns/nzeps-scid-item-id"/>
    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. MedicationRequest.status
    Definition

    The FHIR MedicationRequest.status supplied by MDR, retained unchanged. SDHR uses this value for medication status filtering. The separate NZePS item-status extension may provide additional detail for active prescriptions and does not replace this status.


    A code specifying the current state of the order. Generally, this will be active or completed state.

    ShortStatus of the medication requestactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
    Comments

    This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

    Control1..1
    BindingThe codes SHALL be taken from medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1)

    A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.

    Typecode
    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. MedicationRequest.statusReason
    Definition

    Captures the reason for the current state of the MedicationRequest.

    ShortReason for current status
    Comments

    This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.

    Control0..01
    BindingFor example codes, see medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reason|4.0.1
    (example to http://hl7.org/fhir/ValueSet/medicationrequest-status-reason|4.0.1)

    Identifies the reasons for a given status.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. MedicationRequest.intent
    Definition

    Whether the request is a proposal, plan, or an original order.

    Shortproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
    Comments

    It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.

    An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.

    This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

    Control1..1
    BindingThe codes SHALL be taken from medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
    (required to http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1)

    The kind of medication order.

    Typecode
    Is Modifiertrue because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. MedicationRequest.category
    Definition

    Indicates the type of medication request, such as inpatient, outpatient, or community treatment.


    Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).

    ShortMedication request usage categoryType of medication usage
    Comments

    The category can be used to include where the medication is expected to be consumed or other types of requests.

    Control0..*
    BindingFor example codes, see medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-category|4.0.1
    (example to http://hl7.org/fhir/ValueSet/medicationrequest-category|4.0.1)

    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.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. MedicationRequest.priority
    Definition

    Indicates how quickly the Medication Request should be addressed with respect to other requests.

    Shortroutine | urgent | asap | stat
    Control0..01
    BindingThe codes SHALL be taken from RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1
    (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

    Identifies the level of importance to be assigned to actioning the request.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. MedicationRequest.doNotPerform
    Definition

    If true indicates that the provider is asking for the medication request not to occur.

    ShortTrue if request is prohibiting action
    Comments

    If do not perform is not specified, the request is a positive request e.g. "do perform".

    Control0..01
    Typeboolean
    Is Modifiertrue because This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. MedicationRequest.reported[x]
    Definition

    Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

    ShortReported rather than primary record
    Control0..01
    TypeChoice of: boolean, Reference(Patient, Practitioner, PractitionerRole, RelatedPerson, Organization)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. MedicationRequest.medication[x]
    Definition

    Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

    ShortMedication to be taken
    Comments

    If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.

    Control1..1
    BindingFor example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes|4.0.1
    (example to http://hl7.org/fhir/ValueSet/medication-codes|4.0.1)

    A coded concept identifying substance or product that can be ordered.

    TypeCodeableConcept, Reference(Medication)
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on MedicationRequest.medication[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • type @ $this
    • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

      46. MedicationRequest.medication[x]:medicationCodeableConcept
      Slice NamemedicationCodeableConcept
      Definition

      The medication requested for the patient, expressed as a codeable concept.


      Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

      ShortMedication to be taken
      Comments

      If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.

      Control1..1
      BindingFor example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes|4.0.1
      (example to http://hl7.org/fhir/ValueSet/medication-codes|4.0.1)

      A coded concept identifying substance or product that can be ordered.

      TypeCodeableConcept, Reference(Medication)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. MedicationRequest.medication[x]:medicationCodeableConcept.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..01
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      50. MedicationRequest.medication[x]:medicationCodeableConcept.extension
      Definition

      An Extension


      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortExtensionAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..0*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on MedicationRequest.medication[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

        52. MedicationRequest.subject
        Definition

        The patient who is the subject of this medication request.


        A link to a resource representing the person or set of individuals to whom the medication will be given.

        ShortPatient for the medication requestWho or group medication request is for
        Comments

        The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.

        Control1..1
        TypeReference(Patient, Patient, Group)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. MedicationRequest.subject.reference
        Definition

        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

        ShortMust be an absolute URL reference to the patient on the NHI system. See constraints for details.Literal reference, Relative, internal or absolute URL
        Comments

        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

        Control10..1
        This element is affected by the following invariants: ref-1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        nhi-url-format: 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})$'))
        56. MedicationRequest.subject.type
        Definition

        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

        ShortType the reference refers to (e.g. "Patient")
        Comments

        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

        Control10..1
        BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
        (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

        Aa resource (or, for logical models, the URI of the logical model).

        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Pattern Value
        {
          "type" : "Patient"
        }
        <type value="Patient"/>
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. MedicationRequest.subject.display
        Definition

        Plain text narrative that identifies the resource in addition to the resource reference.

        ShortText alternative for the resource
        Comments

        This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

        Control0..01
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. MedicationRequest.encounter
        Definition

        The Encounter during which this [x] was created or to which the creation of this record is tightly associated.

        ShortEncounter created as part of encounter/admission/stay
        Comments

        This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter." If there is a need to link to episodes of care they will be handled with an extension.

        Control0..01
        TypeReference(Encounter)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        62. MedicationRequest.supportingInformation
        Definition

        A reference to supporting information such as the prescribing facility location.


        Include additional information (for example, patient height and weight) that supports the ordering of the medication.

        ShortLocation or facility information supporting the requestInformation to support ordering of the medication
        Control0..*
        TypeReference(Resource)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        64. MedicationRequest.authoredOn
        Definition

        The date and time when the prescription item was initially written or authored.


        The date (and perhaps time) when the prescription was initially written or authored on.

        ShortWhen the request was authoredWhen request was initially authored
        Control0..1
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        66. MedicationRequest.requester
        Definition

        The practitioner or organization that requested or authorized the medication request.


        The individual, organization, or device that initiated the request and has responsibility for its activation.

        ShortWho requested the medication requestWho/What requested the Request
        Control0..1
        TypeReference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        68. MedicationRequest.performer
        Definition

        The specified desired performer of the medication treatment (e.g. the performer of the medication administration).

        ShortIntended performer of administration
        Control0..01
        TypeReference(Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson, CareTeam)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. MedicationRequest.performerType
        Definition

        Indicates the type of performer of the administration of the medication.

        ShortDesired kind of performer of the medication administration
        Comments

        If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.

        Control0..01
        BindingFor example codes, see ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role|4.0.1
        (example to http://hl7.org/fhir/ValueSet/performer-role|4.0.1)

        Identifies the type of individual that is desired to administer the medication.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        72. MedicationRequest.recorder
        Definition

        The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.

        ShortPerson who entered the request
        Control0..01
        TypeReference(Practitioner, PractitionerRole)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        74. MedicationRequest.reasonCode
        Definition

        The coded reason or indication for ordering the medication.


        The reason or the indication for ordering or not ordering the medication.

        ShortReason for the medication requestReason or indication for ordering or not ordering the medication
        Comments

        This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.

        Control0..*
        BindingFor example codes, see Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code|4.0.1
        (example to http://hl7.org/fhir/ValueSet/condition-code|4.0.1)

        A coded concept indicating why the medication was ordered.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        76. MedicationRequest.reasonReference
        Definition

        A reference to a condition or observation that supports why the medication was ordered.


        Condition or observation that supports why the medication was ordered.

        ShortReference supporting the medication request reasonCondition or observation that supports why the prescription is being written
        Comments

        This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode.

        Control0..*
        TypeReference(Condition, Observation)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        78. MedicationRequest.instantiatesCanonical
        Definition

        The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.

        ShortInstantiates FHIR protocol or definition
        Control0..0*
        Typecanonical
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        80. MedicationRequest.instantiatesUri
        Definition

        The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.

        ShortInstantiates external protocol or definition
        Control0..0*
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        82. MedicationRequest.basedOn
        Definition

        A plan or request that is fulfilled in whole or in part by this medication request.

        ShortWhat request fulfills
        Control0..0*
        TypeReference(CarePlan, MedicationRequest, ServiceRequest, ImmunizationRecommendation)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        84. MedicationRequest.groupIdentifier
        Definition

        A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.

        ShortComposite request this is part of
        Control0..01
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Requirements

        Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        86. MedicationRequest.courseOfTherapyType
        Definition

        The description of the overall patte3rn of the administration of the medication to the patient.

        ShortOverall pattern of medication administration
        Comments

        This attribute should not be confused with the protocol of the medication.

        Control0..01
        BindingFor example codes, see medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy|4.0.1
        (example to http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy|4.0.1)

        Identifies the overall pattern of medication administratio.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        88. MedicationRequest.insurance
        Definition

        Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

        ShortAssociated insurance coverage
        Control0..0*
        TypeReference(Coverage, ClaimResponse)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        90. MedicationRequest.note
        Definition

        Extra information about the prescription that could not be conveyed by the other attributes.

        ShortInformation about the prescription
        Control0..0*
        TypeAnnotation
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        92. MedicationRequest.substitution
        Definition

        Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.

        ShortAny restrictions on medication substitution
        Control0..01
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        96. MedicationRequest.priorPrescription
        Definition

        A link to a resource representing an earlier order related order or prescription.

        ShortAn order/prescription that is being replaced
        Control0..01
        TypeReference(MedicationRequest)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        98. MedicationRequest.detectedIssue
        Definition

        Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.

        ShortClinical Issue with action
        Comments

        This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.

        Control0..0*
        TypeReference(DetectedIssue)
        Is Modifierfalse
        Summaryfalse
        Alternate NamesContraindication, Drug Utilization Review (DUR), Alert
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        100. MedicationRequest.eventHistory
        Definition

        Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

        ShortA list of events of interest in the lifecycle
        Comments

        This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

        Control0..0*
        TypeReference(Provenance)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

        See the documentation on how to interpret the contents of this table

        0. MedicationRequest
        2. MedicationRequest.id
        Definition

        The MDR identifier for this MedicationRequest resource, composed of the NZePS prescription SCID and the item sequence number.

        ShortMDR record identifier (SCID + item sequence number)
        4. MedicationRequest.meta
        6. MedicationRequest.meta.id
        Control0..0
        8. MedicationRequest.meta.extension
        Control0..0
        10. MedicationRequest.meta.source
        Control0..0
        12. MedicationRequest.meta.profile
        Control0..0
        14. MedicationRequest.meta.security
        Control0..1
        16. MedicationRequest.meta.tag
        Control0..0
        18. MedicationRequest.implicitRules
        Control0..0
        20. MedicationRequest.language
        Control0..0
        22. MedicationRequest.text
        Control0..0
        24. MedicationRequest.contained
        Control0..0
        26. MedicationRequest.extension
        SlicingThis element introduces a set of slices on MedicationRequest.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
        • value @ url
        • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

          28. MedicationRequest.extension:LongTermMedication
          Slice NameLongTermMedication
          Control0..1
          TypeExtension(NZePS Long Term Medication Indicator) (Extension Type: boolean)
          30. MedicationRequest.extension:InstructionsModified
          Slice NameInstructionsModified
          Control0..1
          TypeExtension(NZePS Patient Instructions Modification Indicator) (Extension Type: boolean)
          32. MedicationRequest.extension:MedicationModified
          Slice NameMedicationModified
          Control0..1
          TypeExtension(NZePS Patient Medication Modification Indicator) (Extension Type: boolean)
          34. MedicationRequest.extension:ItemStatus
          Slice NameItemStatus
          Definition

          The NZePS item status supplied by MDR, returned separately from MedicationRequest.status. For active prescriptions it may indicate whether repeats remain. SEHRs may use it to display a repeats-remaining flag; SDHR status filtering uses MedicationRequest.status.

          ShortNZePS item status, including sub-status for active prescriptions
          Control0..1
          TypeExtension(NZePS Item Status) (Extension Type: code)
          36. MedicationRequest.modifierExtension
          Control0..0
          38. MedicationRequest.identifier
          Definition

          NZePS SCID + item sequence number. This identifier links the prescription item to dispense records and excludes GTIN barcode values.

          ShortNZePS prescription item ID (SCID + item sequence number)
          NoteThis is a business identifier, not a resource identifier (see discussion)
          40. MedicationRequest.identifier.system
          Control1..?
          Pattern Value
          {
            "system" : "https://standards.digital.health.nz/ns/nzeps-scid-item-id"
          }
          <system value="https://standards.digital.health.nz/ns/nzeps-scid-item-id"/>
          42. MedicationRequest.status
          Definition

          The FHIR MedicationRequest.status supplied by MDR, retained unchanged. SDHR uses this value for medication status filtering. The separate NZePS item-status extension may provide additional detail for active prescriptions and does not replace this status.

          ShortStatus of the medication request
          44. MedicationRequest.statusReason
          Control0..0
          46. MedicationRequest.category
          Definition

          Indicates the type of medication request, such as inpatient, outpatient, or community treatment.

          ShortMedication request usage category
          48. MedicationRequest.priority
          Control0..0
          50. MedicationRequest.doNotPerform
          Control0..0
          52. MedicationRequest.reported[x]
          Control0..0
          54. MedicationRequest.medication[x]
          TypeCodeableConcept, Reference(Medication)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          SlicingThis element introduces a set of slices on MedicationRequest.medication[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • type @ $this
          • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

            56. MedicationRequest.medication[x]:medicationCodeableConcept
            Slice NamemedicationCodeableConcept
            Definition

            The medication requested for the patient, expressed as a codeable concept.

            Control1..1
            TypeCodeableConcept
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            58. MedicationRequest.medication[x]:medicationCodeableConcept.id
            Control0..0
            60. MedicationRequest.medication[x]:medicationCodeableConcept.extension
            Control0..0
            62. MedicationRequest.medication[x]:medicationCodeableConcept.coding
            64. MedicationRequest.medication[x]:medicationCodeableConcept.coding.id
            Control0..0
            66. MedicationRequest.medication[x]:medicationCodeableConcept.coding.extension
            Control0..0
            68. MedicationRequest.medication[x]:medicationCodeableConcept.coding.version
            NoteThis is a business version Id, not a resource version Id (see discussion)
            Control0..0
            70. MedicationRequest.medication[x]:medicationCodeableConcept.coding.userSelected
            Control0..0
            72. MedicationRequest.subject
            Definition

            The patient who is the subject of this medication request.

            ShortPatient for the medication request
            TypeReference(Patient)
            74. MedicationRequest.subject.reference
            ShortMust be an absolute URL reference to the patient on the NHI system. See constraints for details.
            Control1..?
            Invariantsnhi-url-format: 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})$'))
            76. MedicationRequest.subject.type
            Control1..?
            Pattern Value
            {
              "type" : "Patient"
            }
            <type value="Patient"/>
            78. MedicationRequest.subject.display
            Control0..0
            80. MedicationRequest.encounter
            Control0..0
            82. MedicationRequest.supportingInformation
            Definition

            A reference to supporting information such as the prescribing facility location.

            ShortLocation or facility information supporting the request
            84. MedicationRequest.authoredOn
            Definition

            The date and time when the prescription item was initially written or authored.

            ShortWhen the request was authored
            86. MedicationRequest.requester
            Definition

            The practitioner or organization that requested or authorized the medication request.

            ShortWho requested the medication request
            88. MedicationRequest.performer
            Control0..0
            90. MedicationRequest.performerType
            Control0..0
            92. MedicationRequest.recorder
            Control0..0
            94. MedicationRequest.reasonCode
            Definition

            The coded reason or indication for ordering the medication.

            ShortReason for the medication request
            96. MedicationRequest.reasonReference
            Definition

            A reference to a condition or observation that supports why the medication was ordered.

            ShortReference supporting the medication request reason
            98. MedicationRequest.instantiatesCanonical
            Control0..0
            100. MedicationRequest.instantiatesUri
            Control0..0
            102. MedicationRequest.basedOn
            Control0..0
            104. MedicationRequest.groupIdentifier
            Control0..0
            106. MedicationRequest.courseOfTherapyType
            Control0..0
            108. MedicationRequest.insurance
            Control0..0
            110. MedicationRequest.note
            Control0..0
            112. MedicationRequest.dosageInstruction
            114. MedicationRequest.dosageInstruction.id
            Control0..0
            116. MedicationRequest.dosageInstruction.extension
            Control0..0
            118. MedicationRequest.dosageInstruction.modifierExtension
            Control0..0
            120. MedicationRequest.dosageInstruction.sequence
            Control0..0
            122. MedicationRequest.dosageInstruction.text
            Control0..0
            124. MedicationRequest.dosageInstruction.additionalInstruction
            Control0..0
            126. MedicationRequest.dosageInstruction.patientInstruction
            Definition

            Patient-facing instructions about how the medication should be taken.

            ShortPatient instructions
            128. MedicationRequest.dosageInstruction.timing
            Control0..0
            130. MedicationRequest.dosageInstruction.asNeeded[x]
            Control0..0
            132. MedicationRequest.dosageInstruction.site
            Control0..0
            134. MedicationRequest.dosageInstruction.method
            Control0..0
            136. MedicationRequest.dosageInstruction.doseAndRate
            Control0..0
            138. MedicationRequest.dosageInstruction.maxDosePerPeriod
            Control0..0
            140. MedicationRequest.dosageInstruction.maxDosePerAdministration
            Control0..0
            142. MedicationRequest.dosageInstruction.maxDosePerLifetime
            Control0..0
            144. MedicationRequest.dispenseRequest
            146. MedicationRequest.dispenseRequest.id
            Control0..0
            148. MedicationRequest.dispenseRequest.extension
            Control0..0
            150. MedicationRequest.dispenseRequest.modifierExtension
            Control0..0
            152. MedicationRequest.dispenseRequest.initialFill
            Control0..0
            154. MedicationRequest.dispenseRequest.dispenseInterval
            Control0..0
            156. MedicationRequest.dispenseRequest.validityPeriod
            158. MedicationRequest.dispenseRequest.validityPeriod.id
            Control0..0
            160. MedicationRequest.dispenseRequest.validityPeriod.extension
            Control0..0
            162. MedicationRequest.dispenseRequest.validityPeriod.start
            Control0..0
            164. MedicationRequest.dispenseRequest.validityPeriod.end
            Definition

            The end of the period over which the prescription is authorized.

            ShortPrescription expiry date
            166. MedicationRequest.dispenseRequest.numberOfRepeatsAllowed
            Definition

            The number of additional dispenses authorized after the initial dispense.

            ShortNumber of repeats allowed
            168. MedicationRequest.dispenseRequest.quantity
            Definition

            The quantity of medication to dispense for this request.

            ShortDispense quantity
            170. MedicationRequest.dispenseRequest.expectedSupplyDuration
            Control0..0
            172. MedicationRequest.dispenseRequest.performer
            Control0..0
            174. MedicationRequest.substitution
            Control0..0
            176. MedicationRequest.priorPrescription
            Control0..0
            178. MedicationRequest.detectedIssue
            Control0..0
            180. MedicationRequest.eventHistory
            Control0..0

            See the documentation on how to interpret the contents of this table

            0. MedicationRequest
            Definition

            An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

            ShortOrdering of medication for patient or group
            Control0..*
            Is Modifierfalse
            Summaryfalse
            Alternate NamesPrescription, Order
            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
            dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
            dom-6: A resource should have narrative for robust management (text.`div`.exists())
            2. MedicationRequest.id
            Definition

            The MDR identifier for this MedicationRequest resource, composed of the NZePS prescription SCID and the item sequence number.

            ShortMDR record identifier (SCID + item sequence number)
            Comments

            The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

            Control0..1
            Typeid
            Is Modifierfalse
            Summarytrue
            4. MedicationRequest.meta
            Definition

            The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

            ShortMetadata about the resource
            Control0..1
            TypeMeta
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            6. MedicationRequest.meta.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..0
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            8. MedicationRequest.meta.extension
            Definition

            An Extension

            ShortExtension
            Control0..0
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on MedicationRequest.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

              10. MedicationRequest.meta.versionId
              Definition

              The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

              ShortVersion specific identifier
              Comments

              The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

              Control0..1
              Typeid
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. MedicationRequest.meta.lastUpdated
              Definition

              When the resource last changed - e.g. when the version changed.

              ShortWhen the resource version last changed
              Comments

              This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

              Control0..1
              Typeinstant
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              14. MedicationRequest.meta.source
              Definition

              A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

              ShortIdentifies where the resource comes from
              Comments

              In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

              This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

              Control0..0
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              16. MedicationRequest.meta.profile
              Definition

              A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

              ShortProfiles this resource claims to conform to
              Comments

              It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

              Control0..0
              Typecanonical(StructureDefinition)
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              18. MedicationRequest.meta.security
              Definition

              Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

              ShortSecurity Labels applied to this resource
              Comments

              The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from All Security Labels
              (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

              Security Labels from the Healthcare Privacy and Security Classification System.

              TypeCoding
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              20. MedicationRequest.meta.tag
              Definition

              Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

              ShortTags applied to this resource
              Comments

              The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

              Control0..0
              BindingFor example codes, see CommonTags
              (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

              Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

              TypeCoding
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              22. MedicationRequest.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

              Control0..0
              Typeuri
              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              24. MedicationRequest.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

              Control0..0
              BindingThe codes SHOULD be taken from CommonLanguages
              (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

              A human language.

              Additional BindingsPurpose
              AllLanguagesMax Binding
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              26. MedicationRequest.text
              Definition

              A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

              ShortText summary of the resource, for human interpretation
              Comments

              Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

              Control0..0
              TypeNarrative
              Is Modifierfalse
              Summaryfalse
              Alternate Namesnarrative, html, xhtml, display
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              28. MedicationRequest.contained
              Definition

              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

              ShortContained, inline Resources
              Comments

              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

              Control0..0
              TypeResource
              Is Modifierfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              30. MedicationRequest.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on MedicationRequest.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
              • value @ url
              • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

                32. MedicationRequest.extension:LongTermMedication
                Slice NameLongTermMedication
                Definition

                NZePS Long Term Medication Indicator

                ShortNZePS Long Term Medication Indicator
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(NZePS Long Term Medication Indicator) (Extension Type: boolean)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                34. MedicationRequest.extension:InstructionsModified
                Slice NameInstructionsModified
                Definition

                NZePS Patients Instructions modification indicator

                ShortNZePS Patient Instructions Modification Indicator
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(NZePS Patient Instructions Modification Indicator) (Extension Type: boolean)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                36. MedicationRequest.extension:MedicationModified
                Slice NameMedicationModified
                Definition

                NZePS medication modification indicator

                ShortNZePS Patient Medication Modification Indicator
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(NZePS Patient Medication Modification Indicator) (Extension Type: boolean)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                38. MedicationRequest.extension:ItemStatus
                Slice NameItemStatus
                Definition

                The NZePS item status supplied by MDR, returned separately from MedicationRequest.status. For active prescriptions it may indicate whether repeats remain. SEHRs may use it to display a repeats-remaining flag; SDHR status filtering uses MedicationRequest.status.

                ShortNZePS item status, including sub-status for active prescriptions
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(NZePS Item Status) (Extension Type: code)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                40. MedicationRequest.modifierExtension
                Definition

                An Extension

                ShortExtension
                Control0..0
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                42. MedicationRequest.identifier
                Definition

                NZePS SCID + item sequence number. This identifier links the prescription item to dispense records and excludes GTIN barcode values.

                ShortNZePS prescription item ID (SCID + item sequence number)
                Comments

                This is a business identifier, not a resource identifier.

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..*
                TypeIdentifier
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                44. MedicationRequest.identifier.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                46. MedicationRequest.identifier.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on MedicationRequest.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 48. MedicationRequest.identifier.use
                  Definition

                  The purpose of this identifier.

                  Shortusual | official | temp | secondary | old (If known)
                  Comments

                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                  Control0..1
                  BindingThe codes SHALL be taken from IdentifierUse
                  (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                  Identifies the purpose for this identifier, if known .

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. MedicationRequest.identifier.type
                  Definition

                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                  ShortDescription of identifier
                  Comments

                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Allows users to make use of identifiers when the identifier system is not known.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  52. MedicationRequest.identifier.system
                  Definition

                  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                  ShortThe namespace for the identifier value
                  Comments

                  Identifier.system is always case sensitive.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                  Pattern Value
                  {
                    "system" : "https://standards.digital.health.nz/ns/nzeps-scid-item-id"
                  }
                  <system value="https://standards.digital.health.nz/ns/nzeps-scid-item-id"/>
                  ExampleGeneral: http://www.acme.com/identifiers/patient
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  54. MedicationRequest.identifier.value
                  Definition

                  The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                  ShortThe value that is unique
                  Comments

                  If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  ExampleGeneral: 123456
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. MedicationRequest.identifier.period
                  Definition

                  Time period during which identifier is/was valid for use.

                  ShortTime period when id is/was valid for use
                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  58. MedicationRequest.identifier.assigner
                  Definition

                  Organization that issued/manages the identifier.

                  ShortOrganization that issued id (may be just text)
                  Comments

                  The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                  Control0..1
                  TypeReference(Organization)
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  60. MedicationRequest.status
                  Definition

                  The FHIR MedicationRequest.status supplied by MDR, retained unchanged. SDHR uses this value for medication status filtering. The separate NZePS item-status extension may provide additional detail for active prescriptions and does not replace this status.

                  ShortStatus of the medication request
                  Comments

                  This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

                  Control1..1
                  BindingThe codes SHALL be taken from medicationrequest Status
                  (required to http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1)

                  A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.

                  Typecode
                  Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. MedicationRequest.statusReason
                  Definition

                  Captures the reason for the current state of the MedicationRequest.

                  ShortReason for current status
                  Comments

                  This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.

                  Control0..0
                  BindingFor example codes, see medicationRequest Status Reason Codes
                  (example to http://hl7.org/fhir/ValueSet/medicationrequest-status-reason|4.0.1)

                  Identifies the reasons for a given status.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  64. MedicationRequest.intent
                  Definition

                  Whether the request is a proposal, plan, or an original order.

                  Shortproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
                  Comments

                  It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.

                  An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.

                  This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

                  Control1..1
                  BindingThe codes SHALL be taken from medicationRequest Intent
                  (required to http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1)

                  The kind of medication order.

                  Typecode
                  Is Modifiertrue because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. MedicationRequest.category
                  Definition

                  Indicates the type of medication request, such as inpatient, outpatient, or community treatment.

                  ShortMedication request usage category
                  Comments

                  The category can be used to include where the medication is expected to be consumed or other types of requests.

                  Control0..*
                  BindingFor example codes, see medicationRequest Category Codes
                  (example to http://hl7.org/fhir/ValueSet/medicationrequest-category|4.0.1)

                  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.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  68. MedicationRequest.priority
                  Definition

                  Indicates how quickly the Medication Request should be addressed with respect to other requests.

                  Shortroutine | urgent | asap | stat
                  Control0..0
                  BindingThe codes SHALL be taken from RequestPriority
                  (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

                  Identifies the level of importance to be assigned to actioning the request.

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  70. MedicationRequest.doNotPerform
                  Definition

                  If true indicates that the provider is asking for the medication request not to occur.

                  ShortTrue if request is prohibiting action
                  Comments

                  If do not perform is not specified, the request is a positive request e.g. "do perform".

                  Control0..0
                  Typeboolean
                  Is Modifiertrue because This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  72. MedicationRequest.reported[x]
                  Definition

                  Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

                  ShortReported rather than primary record
                  Control0..0
                  TypeChoice of: boolean, Reference(Patient, Practitioner, PractitionerRole, RelatedPerson, Organization)
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  74. MedicationRequest.medication[x]
                  Definition

                  Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

                  ShortMedication to be taken
                  Comments

                  If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.

                  Control1..1
                  BindingFor example codes, see SNOMEDCTMedicationCodes
                  (example to http://hl7.org/fhir/ValueSet/medication-codes|4.0.1)

                  A coded concept identifying substance or product that can be ordered.

                  TypeCodeableConcept
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on MedicationRequest.medication[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                  • type @ $this
                  • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

                    76. MedicationRequest.medication[x]:medicationCodeableConcept
                    Slice NamemedicationCodeableConcept
                    Definition

                    The medication requested for the patient, expressed as a codeable concept.

                    ShortMedication to be taken
                    Comments

                    If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.

                    Control1..1
                    BindingFor example codes, see SNOMEDCTMedicationCodes
                    (example to http://hl7.org/fhir/ValueSet/medication-codes|4.0.1)

                    A coded concept identifying substance or product that can be ordered.

                    TypeCodeableConcept
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    78. MedicationRequest.medication[x]:medicationCodeableConcept.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..0
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    80. MedicationRequest.medication[x]:medicationCodeableConcept.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..0
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on MedicationRequest.medication[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

                      82. MedicationRequest.medication[x]:medicationCodeableConcept.coding
                      Definition

                      A reference to a code defined by a terminology system.

                      ShortCode defined by a terminology system
                      Comments

                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                      Control0..*
                      TypeCoding
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Allows for alternative encodings within a code system, and translations to other code systems.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      84. MedicationRequest.medication[x]:medicationCodeableConcept.coding.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..0
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      86. MedicationRequest.medication[x]:medicationCodeableConcept.coding.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..0
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on MedicationRequest.medication[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

                        88. MedicationRequest.medication[x]:medicationCodeableConcept.coding.system
                        Definition

                        The identification of the code system that defines the meaning of the symbol in the code.

                        ShortIdentity of the terminology system
                        Comments

                        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Need to be unambiguous about the source of the definition of the symbol.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        90. MedicationRequest.medication[x]:medicationCodeableConcept.coding.version
                        Definition

                        The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                        ShortVersion of the system - if relevant
                        Comments

                        Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                        NoteThis is a business version Id, not a resource version Id (see discussion)
                        Control0..0
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        92. MedicationRequest.medication[x]:medicationCodeableConcept.coding.code
                        Definition

                        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                        ShortSymbol in syntax defined by the system
                        Control0..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Need to refer to a particular code in the system.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        94. MedicationRequest.medication[x]:medicationCodeableConcept.coding.display
                        Definition

                        A representation of the meaning of the code in the system, following the rules of the system.

                        ShortRepresentation defined by the system
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        96. MedicationRequest.medication[x]:medicationCodeableConcept.coding.userSelected
                        Definition

                        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                        ShortIf this coding was chosen directly by the user
                        Comments

                        Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                        Control0..0
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        98. MedicationRequest.medication[x]:medicationCodeableConcept.text
                        Definition

                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                        ShortPlain text representation of the concept
                        Comments

                        Very often the text is the same as a displayName of one of the codings.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        100. MedicationRequest.subject
                        Definition

                        The patient who is the subject of this medication request.

                        ShortPatient for the medication request
                        Comments

                        The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.

                        Control1..1
                        TypeReference(Patient)
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        102. MedicationRequest.subject.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        104. MedicationRequest.subject.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on MedicationRequest.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 106. MedicationRequest.subject.reference
                          Definition

                          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                          ShortMust be an absolute URL reference to the patient on the NHI system. See constraints for details.
                          Comments

                          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                          Control1..1
                          This element is affected by the following invariants: ref-1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          nhi-url-format: 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})$'))
                          108. MedicationRequest.subject.type
                          Definition

                          The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                          The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                          ShortType the reference refers to (e.g. "Patient")
                          Comments

                          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                          Control1..1
                          BindingUnless not suitable, these codes SHALL be taken from ResourceType
                          (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                          Aa resource (or, for logical models, the URI of the logical model).

                          Typeuri
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Pattern Value
                          {
                            "type" : "Patient"
                          }
                          <type value="Patient"/>
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          110. MedicationRequest.subject.identifier
                          Definition

                          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                          ShortLogical reference, when literal reference is not known
                          Comments

                          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control0..1
                          TypeIdentifier
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          112. MedicationRequest.subject.display
                          Definition

                          Plain text narrative that identifies the resource in addition to the resource reference.

                          ShortText alternative for the resource
                          Comments

                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                          Control0..0
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          114. MedicationRequest.encounter
                          Definition

                          The Encounter during which this [x] was created or to which the creation of this record is tightly associated.

                          ShortEncounter created as part of encounter/admission/stay
                          Comments

                          This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter." If there is a need to link to episodes of care they will be handled with an extension.

                          Control0..0
                          TypeReference(Encounter)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          116. MedicationRequest.supportingInformation
                          Definition

                          A reference to supporting information such as the prescribing facility location.

                          ShortLocation or facility information supporting the request
                          Control0..*
                          TypeReference(Resource)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          118. MedicationRequest.authoredOn
                          Definition

                          The date and time when the prescription item was initially written or authored.

                          ShortWhen the request was authored
                          Control0..1
                          TypedateTime
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          120. MedicationRequest.requester
                          Definition

                          The practitioner or organization that requested or authorized the medication request.

                          ShortWho requested the medication request
                          Control0..1
                          TypeReference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          122. MedicationRequest.performer
                          Definition

                          The specified desired performer of the medication treatment (e.g. the performer of the medication administration).

                          ShortIntended performer of administration
                          Control0..0
                          TypeReference(Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson, CareTeam)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          124. MedicationRequest.performerType
                          Definition

                          Indicates the type of performer of the administration of the medication.

                          ShortDesired kind of performer of the medication administration
                          Comments

                          If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.

                          Control0..0
                          BindingFor example codes, see ProcedurePerformerRoleCodes
                          (example to http://hl7.org/fhir/ValueSet/performer-role|4.0.1)

                          Identifies the type of individual that is desired to administer the medication.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          126. MedicationRequest.recorder
                          Definition

                          The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.

                          ShortPerson who entered the request
                          Control0..0
                          TypeReference(Practitioner, PractitionerRole)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          128. MedicationRequest.reasonCode
                          Definition

                          The coded reason or indication for ordering the medication.

                          ShortReason for the medication request
                          Comments

                          This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.

                          Control0..*
                          BindingFor example codes, see Condition/Problem/DiagnosisCodes
                          (example to http://hl7.org/fhir/ValueSet/condition-code|4.0.1)

                          A coded concept indicating why the medication was ordered.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          130. MedicationRequest.reasonReference
                          Definition

                          A reference to a condition or observation that supports why the medication was ordered.

                          ShortReference supporting the medication request reason
                          Comments

                          This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode.

                          Control0..*
                          TypeReference(Condition, Observation)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          132. MedicationRequest.instantiatesCanonical
                          Definition

                          The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.

                          ShortInstantiates FHIR protocol or definition
                          Control0..0
                          Typecanonical
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          134. MedicationRequest.instantiatesUri
                          Definition

                          The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.

                          ShortInstantiates external protocol or definition
                          Control0..0
                          Typeuri
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          136. MedicationRequest.basedOn
                          Definition

                          A plan or request that is fulfilled in whole or in part by this medication request.

                          ShortWhat request fulfills
                          Control0..0
                          TypeReference(CarePlan, MedicationRequest, ServiceRequest, ImmunizationRecommendation)
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          138. MedicationRequest.groupIdentifier
                          Definition

                          A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.

                          ShortComposite request this is part of
                          Control0..0
                          TypeIdentifier
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          140. MedicationRequest.courseOfTherapyType
                          Definition

                          The description of the overall patte3rn of the administration of the medication to the patient.

                          ShortOverall pattern of medication administration
                          Comments

                          This attribute should not be confused with the protocol of the medication.

                          Control0..0
                          BindingFor example codes, see medicationRequest Course of Therapy Codes
                          (example to http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy|4.0.1)

                          Identifies the overall pattern of medication administratio.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          142. MedicationRequest.insurance
                          Definition

                          Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

                          ShortAssociated insurance coverage
                          Control0..0
                          TypeReference(Coverage, ClaimResponse)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          144. MedicationRequest.note
                          Definition

                          Extra information about the prescription that could not be conveyed by the other attributes.

                          ShortInformation about the prescription
                          Control0..0
                          TypeAnnotation
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          146. MedicationRequest.dosageInstruction
                          Definition

                          Indicates how the medication is to be used by the patient.

                          ShortHow the medication should be taken
                          Comments

                          There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.

                          Control0..*
                          TypeDosage
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          148. MedicationRequest.dosageInstruction.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..0
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          150. MedicationRequest.dosageInstruction.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..0
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on MedicationRequest.dosageInstruction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

                            152. MedicationRequest.dosageInstruction.modifierExtension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..0
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            154. MedicationRequest.dosageInstruction.sequence
                            Definition

                            Indicates the order in which the dosage instructions should be applied or interpreted.

                            ShortThe order of the dosage instructions
                            Control0..0
                            Typeinteger
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            156. MedicationRequest.dosageInstruction.text
                            Definition

                            Free text dosage instructions e.g. SIG.

                            ShortFree text dosage instructions e.g. SIG
                            Control0..0
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            158. MedicationRequest.dosageInstruction.additionalInstruction
                            Definition

                            Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").

                            ShortSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
                            Comments

                            Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text.

                            Control0..0
                            BindingFor example codes, see SNOMEDCTAdditionalDosageInstructions
                            (example to http://hl7.org/fhir/ValueSet/additional-instruction-codes|4.0.1)

                            A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            160. MedicationRequest.dosageInstruction.patientInstruction
                            Definition

                            Patient-facing instructions about how the medication should be taken.

                            ShortPatient instructions
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            162. MedicationRequest.dosageInstruction.timing
                            Definition

                            When medication should be administered.

                            ShortWhen medication should be administered
                            Comments

                            This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.

                            Control0..0
                            TypeTiming
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            164. MedicationRequest.dosageInstruction.asNeeded[x]
                            Definition

                            Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

                            ShortTake "as needed" (for x)
                            Comments

                            Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed".

                            Control0..0
                            BindingFor example codes, see SNOMEDCTMedicationAsNeededReasonCodes
                            (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1)

                            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.

                            TypeChoice of: boolean, CodeableConcept
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            166. MedicationRequest.dosageInstruction.site
                            Definition

                            Body site to administer to.

                            ShortBody site to administer to
                            Comments

                            If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.

                            Control0..0
                            BindingFor example codes, see SNOMEDCTAnatomicalStructureForAdministrationSiteCodes
                            (example to http://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1)

                            A coded concept describing the site location the medicine enters into or onto the body.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            A coded specification of the anatomic site where the medication first enters the body.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            168. MedicationRequest.dosageInstruction.route
                            Definition

                            How drug should enter body.

                            ShortHow drug should enter body
                            Control0..1
                            BindingFor example codes, see SNOMEDCTRouteCodes
                            (example to http://hl7.org/fhir/ValueSet/route-codes|4.0.1)

                            A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            170. MedicationRequest.dosageInstruction.method
                            Definition

                            Technique for administering medication.

                            ShortTechnique for administering medication
                            Comments

                            Terminologies used often pre-coordinate this term with the route and or form of administration.

                            Control0..0
                            BindingFor example codes, see SNOMEDCTAdministrationMethodCodes
                            (example to http://hl7.org/fhir/ValueSet/administration-method-codes|4.0.1)

                            A coded concept describing the technique by which the medicine is administered.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            172. MedicationRequest.dosageInstruction.doseAndRate
                            Definition

                            The amount of medication administered.

                            ShortAmount of medication administered
                            Control0..0
                            TypeElement
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            179. MedicationRequest.dosageInstruction.maxDosePerPeriod
                            Definition

                            Upper limit on medication per unit of time.

                            ShortUpper limit on medication per unit of time
                            Comments

                            This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".

                            Control0..0
                            TypeRatio
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            181. MedicationRequest.dosageInstruction.maxDosePerAdministration
                            Definition

                            Upper limit on medication per administration.

                            ShortUpper limit on medication per administration
                            Comments

                            This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.

                            Control0..0
                            TypeQuantity(SimpleQuantity)
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
                            183. MedicationRequest.dosageInstruction.maxDosePerLifetime
                            Definition

                            Upper limit on medication per lifetime of the patient.

                            ShortUpper limit on medication per lifetime of the patient
                            Control0..0
                            TypeQuantity(SimpleQuantity)
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
                            185. MedicationRequest.dispenseRequest
                            Definition

                            Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

                            ShortMedication supply authorization
                            Control0..1
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            187. MedicationRequest.dispenseRequest.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..0
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            189. MedicationRequest.dispenseRequest.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..0
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            191. MedicationRequest.dispenseRequest.modifierExtension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..0
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            193. MedicationRequest.dispenseRequest.initialFill
                            Definition

                            Indicates the quantity or duration for the first dispense of the medication.

                            ShortFirst fill details
                            Comments

                            If populating this element, either the quantity or the duration must be included.

                            Control0..0
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            200. MedicationRequest.dispenseRequest.dispenseInterval
                            Definition

                            The minimum period of time that must occur between dispenses of the medication.

                            ShortMinimum period of time between dispenses
                            Control0..0
                            TypeDuration
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            202. MedicationRequest.dispenseRequest.validityPeriod
                            Definition

                            This indicates the validity period of a prescription (stale dating the Prescription).

                            ShortTime period supply is authorized for
                            Comments

                            It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.

                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            204. MedicationRequest.dispenseRequest.validityPeriod.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..0
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            206. MedicationRequest.dispenseRequest.validityPeriod.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..0
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on MedicationRequest.dispenseRequest.validityPeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

                              208. MedicationRequest.dispenseRequest.validityPeriod.start
                              Definition

                              The start of the period. The boundary is inclusive.

                              ShortStarting time with inclusive boundary
                              Comments

                              If the low element is missing, the meaning is that the low boundary is not known.

                              Control0..0
                              This element is affected by the following invariants: per-1
                              TypedateTime
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              210. MedicationRequest.dispenseRequest.validityPeriod.end
                              Definition

                              The end of the period over which the prescription is authorized.

                              ShortPrescription expiry date
                              Comments

                              The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                              Control0..1
                              This element is affected by the following invariants: per-1
                              TypedateTime
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              212. MedicationRequest.dispenseRequest.numberOfRepeatsAllowed
                              Definition

                              The number of additional dispenses authorized after the initial dispense.

                              ShortNumber of repeats allowed
                              Comments

                              If displaying "number of authorized fills", add 1 to this number.

                              Control0..1
                              TypeunsignedInt
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              214. MedicationRequest.dispenseRequest.quantity
                              Definition

                              The quantity of medication to dispense for this request.

                              ShortDispense quantity
                              Control0..1
                              TypeQuantity(SimpleQuantity)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
                              216. MedicationRequest.dispenseRequest.expectedSupplyDuration
                              Definition

                              Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.

                              ShortNumber of days supply per dispense
                              Comments

                              In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.

                              Control0..0
                              TypeDuration
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              218. MedicationRequest.dispenseRequest.performer
                              Definition

                              Indicates the intended dispensing Organization specified by the prescriber.

                              ShortIntended dispenser
                              Control0..0
                              TypeReference(Organization)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              220. MedicationRequest.substitution
                              Definition

                              Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.

                              ShortAny restrictions on medication substitution
                              Control0..0
                              TypeBackboneElement
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              227. MedicationRequest.priorPrescription
                              Definition

                              A link to a resource representing an earlier order related order or prescription.

                              ShortAn order/prescription that is being replaced
                              Control0..0
                              TypeReference(MedicationRequest)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              229. MedicationRequest.detectedIssue
                              Definition

                              Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.

                              ShortClinical Issue with action
                              Comments

                              This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.

                              Control0..0
                              TypeReference(DetectedIssue)
                              Is Modifierfalse
                              Summaryfalse
                              Alternate NamesContraindication, Drug Utilization Review (DUR), Alert
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              231. MedicationRequest.eventHistory
                              Definition

                              Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

                              ShortA list of events of interest in the lifecycle
                              Comments

                              This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

                              Control0..0
                              TypeReference(Provenance)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))