RIVO-Noord Zorgviewer Implementation Guide
1.28.0 - master Netherlands flag

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.28.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Toedieningsafspraak - Detailed Descriptions

Active as of 2026-11-19

Definitions for the Toedieningsafspraak resource profile.

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

0. MedicationDispense
Definition

An administration agreement is the use (or administering) instructions from the pharmacist to the patient (or their representative or administrator), whereby a medication agreement is structured at a concrete level.


This is the base resource type for everything.

ShortAdministrationAgreementBase Resource
Comments

The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html).

Control0..*
Alternate NamesToedieningsafspraak
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
mdd-1: whenHandedOver cannot be before whenPrepared (whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared)
2. MedicationDispense.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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. MedicationDispense.extension:authoredOn
Slice NameauthoredOn
Definition

The time at which the agreement was made.

ShortAdministrationAgreementDateTime
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Authored On) (Extension Type: dateTime)
Alternate Namesextensions, user content, ToedieningsafspraakDatumTijd
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. MedicationDispense.extension:agreementReason
Slice NameagreementReason
Definition

Reason for this agreement. This will often be the same reason as the one for the medication agreement. This field has the option to - if applicable - enter a specific reason for the administration agreement. Examples include: substitution, transfer to GDS, patient request for different product, etc

ShortAgreementReason
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Reason For Dispense) (Extension Type: string)
Alternate Namesextensions, user content, RedenAfspraak
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. MedicationDispense.extension:periodOfUse
Slice NameperiodOfUse
Definition

Start date: This is the time at which the agreement was to take effect (or took effect or will take effect). This is the time at which the instructions for use in this agreement start. In the case of an agreement to discontinue use, this is the start date of the original administration agreement. The end date indicates from when the medication is to be discontinued.

End date: The time at which the period of use ends (or ended or will end). In the case of an agreement to discontinue use, this is the time at which the medication is to be discontinued. To avoid confusion between 'to' and 'up to', the submission of time is always mandatory for the end date.

With medication for an indefinite period only a start date is indicated.

ShortPeriodOfUse
Comments

According to the HCIM TimeInterval, a time interval is defined by either a start and end time, a start time and duration, or a duration and end time. As this HCIM is expressed by the periodOfUse and usageDuration extensions in this profile, this means that precisely two elements out of .valuePeriod.start, .valuePeriod.end (both in the periodOfUse extension) and .valueDuration (in the usageDuration extension) should be present in order to correctly represent the time interval in which the agreement is used (and in particular not all three elements).

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Medication Period Of Use) (Extension Type: Period)
Alternate Namesextensions, user content, Gebruiksperiode
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. MedicationDispense.extension:usageDuration
Slice NameusageDuration
Definition

The intended duration of use. E.g. 5 days or 8 weeks. It is not allowed to indicate the duration in months, because different months have a variable duration in days.

ShortDuration
Comments

According to the HCIM TimeInterval, a time interval is defined by either a start and end time, a start time and duration, or a duration and end time. As this HCIM is expressed by the periodOfUse and usageDuration extensions in this profile, this means that precisely two elements out of .valuePeriod.start, .valuePeriod.end (both in the periodOfUse extension) and .valueDuration (in the usageDuration extension) should be present in order to correctly represent the time interval in which the agreement is used (and in particular not all three elements).

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM MedicationUse Duration) (Extension Type: Duration)
Alternate Namesextensions, user content, Gebruiksduur
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. MedicationDispense.extension:additionalInformation
Slice NameadditionalInformation
Definition

Additional information includes details on the structure of the agreement made.

This element mainly contains information that until now has been structured with ZZ rules. The medication-related topics that are now supported by the ZZ rules are best supported with a system functionality. A process has been started for this by Z-index/KNMP. For now, the following list will be used. This list will be replaced by a thesaurus in the G standard at a later stage.

ShortAdministrationAgreementAdditionalInformation
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM AdditionalInformation) (Extension Type: CodeableConcept)
Alternate Namesextensions, user content, ToedieningsafspraakAanvullendeInformatie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. MedicationDispense.extension:additionalInformation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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..0*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. MedicationDispense.extension:additionalInformation.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Value
{
  "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation"
}
<url value="http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation"/>
18. MedicationDispense.extension:additionalInformation.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

ShortValue of extension
Control0..1
BindingUnless not suitable, these codes SHALL be taken from For codes, see ToedieningsafspraakAanvullendeInformatieCodelijst
(extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000)

AdministrationAgreementAdditionalInformation

TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
ExampleExample of AdditionalInformation: { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.2.3.999", "code" : "4", "display" : "Medicatieafspraak gewijzigd: dosering" }] }
20. MedicationDispense.extension:medicationTreatment
Slice NamemedicationTreatment
Definition

This extension is to describe which overarching medication treatment this information is part of. This is done by the use of an identifier of that medication treatment.

ShortMedication Treatment
Comments

No HCIM concept is available for this element. Therefore a mapping to the relevant element Medication Process data element is provided.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM MedicationTreatment) (Extension Type: Identifier)
Alternate Namesextensions, user content, Medicamenteuze behandeling
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. MedicationDispense.modifierExtension
Definition

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. Usually modifier elements provide negation or qualification. In order 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.

ShortExtensions 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..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. MedicationDispense.modifierExtension:stopType
Slice NamestopType
Definition

The manner in which (and indicator that) this medication is discontinued (temporarily or permanently).

ShortAdministrationAgreementStopType
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Medication StopType) (Extension Type: CodeableConcept)
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. MedicationDispense.modifierExtension:stopType.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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..0*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.modifierExtension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. MedicationDispense.modifierExtension:stopType.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Value
{
  "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType"
}
<url value="http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType"/>
30. MedicationDispense.modifierExtension:stopType.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

ShortValue of extension
Control0..1
BindingThe codes SHALL be taken from For codes, see Stoptype
(required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300)

StopType

TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
32. MedicationDispense.modifierExtension:repeatPeriodCyclicalSchedule
Slice NamerepeatPeriodCyclicalSchedule
Definition

The repeated period in a cyclical schedule (of one or more dosing instructions). A cyclic schedule is noted in days, the corresponding dosing duration is also in days.

Examples of a cyclical schedule: contraceptive pill (21 days, 1 pill 1x a day, then skip for 7 days, repeat), repeat period here is 28 days. RepeatPeriodCyclicalSchedule

ShortRepeatPeriodCyclicalSchedule
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Medication RepeatPeriodCyclicalSchedule) (Extension Type: Duration)
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
LabelHerhaalperiodeCyclischSchema
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. MedicationDispense.status
Definition

In the event of an error correction, the value of this element shall be 'entered-in-error'.


A code specifying the state of the set of dispense events.

ShortCanceledIndicatorpreparation | in-progress | on-hold | completed | entered-in-error | stopped
Comments

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

Control0..1
BindingThe codes SHALL be taken from MedicationDispenseStatushttp://hl7.org/fhir/ValueSet/medication-dispense-status|3.0.2
(required to http://hl7.org/fhir/ValueSet/medication-dispense-status)

A coded concept specifying the state of the dispense event.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesGeannuleerdIndicator
36. MedicationDispense.category
Definition

Indicates type of medication dispense and where the medication is expected to be consumed or administered.

ShortType of medication dispense
Control10..1
BindingThe codes SHOULD be taken from MedicationDispenseCategoryhttp://hl7.org/fhir/ValueSet/medication-dispense-category|3.0.2
(preferred to http://hl7.org/fhir/ValueSet/medication-dispense-category)

A code describing where the dispensed medication is expected to be consumed or administered

TypeCodeableConcept
Must Supporttrue
38. MedicationDispense.category.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
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

SlicingThis element introduces a set of slices on MedicationDispense.category.coding. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
40. MedicationDispense.category.coding:administrationAgreementCode
Slice NameadministrationAgreementCode
Definition

Category SNOMED code used for indexing/retrieval of the HCIM AdministrationAgreement. The SNOMED code 422037009 for this resource is stated in the Medication Process v09.


A reference to a code defined by a terminology system.

ShortAdministrationAgreementCodeCode 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..1*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

42. MedicationDispense.category.coding:administrationAgreementCode.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 de-reference to some definition that establish the system clearly and unambiguously.

Control0..1
Typeuri
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.

Fixed Value
{
  "system" : "http://snomed.info/sct"
}
<system value="http://snomed.info/sct"/>
44. MedicationDispense.category.coding:administrationAgreementCode.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
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.

Fixed Value
{
  "code" : "422037009"
}
<code value="422037009"/>
46. MedicationDispense.medicationReference:medicationReference
Slice NamemedicationReference
Definition

Medicine in the AdministrationAgreement.


Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

ShortMedicineForAdministrationAgreementWhat medication was supplied
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, then you must reference the Medication resource. .

Control1..1
TypeReference(Medication, Medication), CodeableConcept
Must Supporttrue
Summarytrue
Alternate NamesGeneesmiddelBijToedieningsAfspraak, Product
48. MedicationDispense.medicationReference:medicationReference.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..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
50. MedicationDispense.dosageInstruction
Definition

Instructions for the use of the medication, e.g. dose and route of administration. In the event of medication use, this is the pattern of use established by the patient or which the patient followed


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

ShortInstructionsForUseHow the medication is to be used by the patient or administered by the caregiver
Comments

The wiki page https://informatiestandaarden.nictiz.nl/wiki/mp:V9.0Voorbeeldendoseringen provides dosage instruction examples. These examples consists of functional data and their representation in FHIR and CDA.


When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Control0..*
This element is affected by the following invariants: ele-1
TypeDosage(HCIM InstructionsForUse The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
Alternate NamesGebruiksinstructie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
52. MedicationDispense.dosageInstruction.text
Definition

Textual description of the complete instructions for use including the period of use.


Free text dosage instructions e.g. SIG.

ShortDescriptionFree text dosage instructions e.g. SIG
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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.

Alternate NamesOmschrijving
54. MedicationDispense.dosageInstruction.asNeededCodeableConcept:asNeededCodeableConcept
Slice NameasNeededCodeableConcept
Definition

As needed means that the dose is only to be administered under certain conditions.


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

ShortAsNeededTake "as needed" (for x)
Comments

Using the term 'as needed' or a specific reason (eg 'in case of pain') to use medication leads to ambiguity. It is not always clear whether the whole dose is 'as needed' or only part of the dose. For example: 1x daily 1-2 tablets as needed. This can mean: 1 tablet fixed per day and 1 tablet as needed or, as needed, a maximum of 2 tablets.As needed medication is not included in GDS. In the first situation, 1 tablet comes in the GDS (drug dispensing systems) and 1 tablet is delivered separately. In the second situation there is only separate delivery.The system must make sufficiently clear whether the entire instruction or part of the dose is necessary. The HCIM supports both options described above.


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..1
BindingUnless not suitable, these codes SHALL be taken from For example codes, see ZonodigCriteriumCodelijsthttp://hl7.org/fhir/ValueSet/medication-as-needed-reason|3.0.2
(extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.4--20171231000000)

ZonodigCriteriumCodelijst


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.

TypeCodeableConcept, boolean
Summarytrue
Alternate NamesZo nodig, Criterium
56. MedicationDispense.dosageInstruction.route
Definition

The route through which the medication is administered (oral, nasal, intravenous, etc.)


How drug should enter body.

ShortRouteOfAdministrationHow drug should enter body
Control0..1
BindingUnless not suitable, these codes SHALL be taken from For example codes, see MedicatieToedieningswegCodelijsthttp://hl7.org/fhir/ValueSet/route-codes|3.0.2
(extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.1--20171231000000)

ToedieningswegCodelijst


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

TypeCodeableConcept
Summarytrue
Requirements

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

Alternate NamesToedieningsweg
ExampleExample of RouteOfAdministration: { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.4.9", "code" : "oraal", "display" : "Oraal" }] }
58. MedicationDispense.dosageInstruction.route.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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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.

60. MedicationDispense.dosageInstruction.dose[x]
Definition

The dose indicates the dose amount per administration.

The dosage is described in the unit accompanying the product; usually, this is just a number of units or doses. Liquids and other divisible products will usually include a unit of volume (preferably "ml").

In many cases, the prescriber will want to indicate the dose in units of weight of the active ingredient.

If only the ingredient is included and not the product, then the amount of that ingredient will be given. Paracetamol 1000mg is equivalent to 2 Paracetamol 500mg tablets or units.

The dosage is sometimes given as a calculation, in which the patient’s body weight or body surface area is used as a parameter. The calculation is however no more than an aid in reaching a decision.

In the event of constant administration, sometimes the dose is given in addition to the administration speed (infusion rate) (e.g. 20ml in a syringe or 500ml in a bag), but it is often also omitted.

A general dosage recommendation such as ‘Use according to protocol’ or ‘See instructions’ can be sufficient. In that case, no dose is given.


Amount of medication per dose.

ShortDoseAmount of medication per dose
Comments

Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

Control0..1
TypeChoice of: Range, Quantity(SimpleQuantity The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Summarytrue
Requirements

The amount of therapeutic or other substance given at one administration event.

Alternate NamesKeerdosis
SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.dose[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
62. MedicationDispense.dosageInstruction.dose[x]:doseQuantity
Slice NamedoseQuantity
Definition

The comparator is not used on a SimpleQuantity


Amount of medication per dose.

ShortA fixed quantity (no comparator)Amount of medication per dose
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.


Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For codes, see G-Standaard Eenhedentabel
(required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453)

GstdTabel902

TypeQuantity(SimpleQuantity), Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Summarytrue
Requirements

The amount of therapeutic or other substance given at one administration event.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
64. MedicationDispense.dosageInstruction.dose[x]:doseRange
Slice NamedoseRange
Definition

Amount of medication per dose.

ShortAmount of medication per dose
Comments

Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

Control0..1
TypeRange, Quantity(SimpleQuantity The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Summarytrue
Requirements

The amount of therapeutic or other substance given at one administration event.

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

0. MedicationDispense
2. MedicationDispense.category
Must Supporttrue
4. MedicationDispense.medicationReference
TypeReference(Medication)
Must Supporttrue
6. MedicationDispense.medicationReference.display
Must Supporttrue
8. MedicationDispense.dosageInstruction
10. MedicationDispense.dosageInstruction.text
Must Supporttrue
12. MedicationDispense.dosageInstruction.route
14. MedicationDispense.dosageInstruction.route.text
Must Supporttrue

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

0. MedicationDispense
Definition

An administration agreement is the use (or administering) instructions from the pharmacist to the patient (or their representative or administrator), whereby a medication agreement is structured at a concrete level.

ShortAdministrationAgreement
Comments

The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html).

Control0..*
Alternate NamesToedieningsafspraak
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
mdd-1: whenHandedOver cannot be before whenPrepared (whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared)
2. MedicationDispense.id
Definition

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

ShortLogical 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. MedicationDispense.meta
Definition

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

ShortMetadata about the resource
Control0..1
TypeMeta
Summarytrue
6. MedicationDispense.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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
8. MedicationDispense.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..1
BindingUnless not suitable, these codes SHALL be taken from Common Languages
(extensible to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional BindingsPurpose
All LanguagesMax Binding
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. MedicationDispense.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later.

Control0..1
This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
12. MedicationDispense.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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
14. MedicationDispense.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. MedicationDispense.extension:authoredOn
Slice NameauthoredOn
Definition

The time at which the agreement was made.

ShortAdministrationAgreementDateTime
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Authored On) (Extension Type: dateTime)
Alternate Namesextensions, user content, ToedieningsafspraakDatumTijd
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. MedicationDispense.extension:agreementReason
Slice NameagreementReason
Definition

Reason for this agreement. This will often be the same reason as the one for the medication agreement. This field has the option to - if applicable - enter a specific reason for the administration agreement. Examples include: substitution, transfer to GDS, patient request for different product, etc

ShortAgreementReason
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Reason For Dispense) (Extension Type: string)
Alternate Namesextensions, user content, RedenAfspraak
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. MedicationDispense.extension:periodOfUse
Slice NameperiodOfUse
Definition

Start date: This is the time at which the agreement was to take effect (or took effect or will take effect). This is the time at which the instructions for use in this agreement start. In the case of an agreement to discontinue use, this is the start date of the original administration agreement. The end date indicates from when the medication is to be discontinued.

End date: The time at which the period of use ends (or ended or will end). In the case of an agreement to discontinue use, this is the time at which the medication is to be discontinued. To avoid confusion between 'to' and 'up to', the submission of time is always mandatory for the end date.

With medication for an indefinite period only a start date is indicated.

ShortPeriodOfUse
Comments

According to the HCIM TimeInterval, a time interval is defined by either a start and end time, a start time and duration, or a duration and end time. As this HCIM is expressed by the periodOfUse and usageDuration extensions in this profile, this means that precisely two elements out of .valuePeriod.start, .valuePeriod.end (both in the periodOfUse extension) and .valueDuration (in the usageDuration extension) should be present in order to correctly represent the time interval in which the agreement is used (and in particular not all three elements).

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Medication Period Of Use) (Extension Type: Period)
Alternate Namesextensions, user content, Gebruiksperiode
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. MedicationDispense.extension:usageDuration
Slice NameusageDuration
Definition

The intended duration of use. E.g. 5 days or 8 weeks. It is not allowed to indicate the duration in months, because different months have a variable duration in days.

ShortDuration
Comments

According to the HCIM TimeInterval, a time interval is defined by either a start and end time, a start time and duration, or a duration and end time. As this HCIM is expressed by the periodOfUse and usageDuration extensions in this profile, this means that precisely two elements out of .valuePeriod.start, .valuePeriod.end (both in the periodOfUse extension) and .valueDuration (in the usageDuration extension) should be present in order to correctly represent the time interval in which the agreement is used (and in particular not all three elements).

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM MedicationUse Duration) (Extension Type: Duration)
Alternate Namesextensions, user content, Gebruiksduur
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. MedicationDispense.extension:additionalInformation
Slice NameadditionalInformation
Definition

Additional information includes details on the structure of the agreement made.

This element mainly contains information that until now has been structured with ZZ rules. The medication-related topics that are now supported by the ZZ rules are best supported with a system functionality. A process has been started for this by Z-index/KNMP. For now, the following list will be used. This list will be replaced by a thesaurus in the G standard at a later stage.

ShortAdministrationAgreementAdditionalInformation
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM AdditionalInformation) (Extension Type: CodeableConcept)
Alternate Namesextensions, user content, ToedieningsafspraakAanvullendeInformatie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. MedicationDispense.extension:additionalInformation.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
28. MedicationDispense.extension:additionalInformation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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..0
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
30. MedicationDispense.extension:additionalInformation.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Value
{
  "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation"
}
<url value="http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation"/>
32. MedicationDispense.extension:additionalInformation.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

ShortValue of extension
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ToedieningsafspraakAanvullendeInformatieCodelijst
(extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000)

AdministrationAgreementAdditionalInformation

TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
ExampleExample of AdditionalInformation: { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.2.3.999", "code" : "4", "display" : "Medicatieafspraak gewijzigd: dosering" }] }
34. MedicationDispense.extension:medicationTreatment
Slice NamemedicationTreatment
Definition

This extension is to describe which overarching medication treatment this information is part of. This is done by the use of an identifier of that medication treatment.

ShortMedication Treatment
Comments

No HCIM concept is available for this element. Therefore a mapping to the relevant element Medication Process data element is provided.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM MedicationTreatment) (Extension Type: Identifier)
Alternate Namesextensions, user content, Medicamenteuze behandeling
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. MedicationDispense.modifierExtension
Definition

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. Usually modifier elements provide negation or qualification. In order 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.

ShortExtensions 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..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
38. MedicationDispense.modifierExtension:stopType
Slice NamestopType
Definition

The manner in which (and indicator that) this medication is discontinued (temporarily or permanently).

ShortAdministrationAgreementStopType
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Medication StopType) (Extension Type: CodeableConcept)
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. MedicationDispense.modifierExtension:stopType.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
42. MedicationDispense.modifierExtension:stopType.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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..0
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.modifierExtension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. MedicationDispense.modifierExtension:stopType.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Value
{
  "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType"
}
<url value="http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType"/>
46. MedicationDispense.modifierExtension:stopType.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

ShortValue of extension
Control0..1
BindingThe codes SHALL be taken from Stoptype
(required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300)

StopType

TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
48. MedicationDispense.modifierExtension:repeatPeriodCyclicalSchedule
Slice NamerepeatPeriodCyclicalSchedule
Definition

The repeated period in a cyclical schedule (of one or more dosing instructions). A cyclic schedule is noted in days, the corresponding dosing duration is also in days.

Examples of a cyclical schedule: contraceptive pill (21 days, 1 pill 1x a day, then skip for 7 days, repeat), repeat period here is 28 days. RepeatPeriodCyclicalSchedule

ShortRepeatPeriodCyclicalSchedule
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..1
This element is affected by the following invariants: ele-1
TypeExtension(HCIM Medication RepeatPeriodCyclicalSchedule) (Extension Type: Duration)
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
LabelHerhaalperiodeCyclischSchema
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
50. MedicationDispense.identifier
Definition

Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.

ShortExternal identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
52. MedicationDispense.partOf
Definition

The procedure that the dispense is done because of.

ShortEvent that dispense is part of
Control0..*
TypeReference(Procedure)
54. MedicationDispense.status
Definition

In the event of an error correction, the value of this element shall be 'entered-in-error'.

ShortCanceledIndicator
Comments

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

Control0..1
BindingThe codes SHALL be taken from MedicationDispenseStatus
(required to http://hl7.org/fhir/ValueSet/medication-dispense-status)

A coded concept specifying the state of the dispense event.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesGeannuleerdIndicator
56. MedicationDispense.category
Definition

Indicates type of medication dispense and where the medication is expected to be consumed or administered.

ShortType of medication dispense
Control1..1
BindingThe codes SHOULD be taken from MedicationDispenseCategory
(preferred to http://hl7.org/fhir/ValueSet/medication-dispense-category)

A code describing where the dispensed medication is expected to be consumed or administered

TypeCodeableConcept
Must Supporttrue
58. MedicationDispense.category.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
60. MedicationDispense.category.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.category.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
62. MedicationDispense.category.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
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

SlicingThis element introduces a set of slices on MedicationDispense.category.coding. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
64. MedicationDispense.category.coding:administrationAgreementCode
Slice NameadministrationAgreementCode
Definition

Category SNOMED code used for indexing/retrieval of the HCIM AdministrationAgreement. The SNOMED code 422037009 for this resource is stated in the Medication Process v09.

ShortAdministrationAgreementCode
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..1
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

66. MedicationDispense.category.coding:administrationAgreementCode.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
68. MedicationDispense.category.coding:administrationAgreementCode.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.category.coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
70. MedicationDispense.category.coding:administrationAgreementCode.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 de-reference to some definition that establish the system clearly and unambiguously.

Control0..1
Typeuri
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.

Fixed Value
{
  "system" : "http://snomed.info/sct"
}
<system value="http://snomed.info/sct"/>
72. MedicationDispense.category.coding:administrationAgreementCode.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..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
74. MedicationDispense.category.coding:administrationAgreementCode.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
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.

Fixed Value
{
  "code" : "422037009"
}
<code value="422037009"/>
76. MedicationDispense.category.coding:administrationAgreementCode.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
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.

Default ValueProvider medication administration instructions (procedure)
78. MedicationDispense.category.coding:administrationAgreementCode.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. 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..1
Typeboolean
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.

80. MedicationDispense.category.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
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.

82. MedicationDispense.medicationReference:medicationReference
Slice NamemedicationReference
Definition

Medicine in the AdministrationAgreement.

ShortMedicineForAdministrationAgreement
Control1..1
TypeReference(Medication)
Must Supporttrue
Summarytrue
Alternate NamesGeneesmiddelBijToedieningsAfspraak, Product
84. MedicationDispense.medicationReference:medicationReference.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
86. MedicationDispense.medicationReference:medicationReference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.medicationReference.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
88. MedicationDispense.medicationReference:medicationReference.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.

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

Control0..1
This element is affected by the following invariants: ref-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
90. MedicationDispense.medicationReference:medicationReference.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
92. MedicationDispense.medicationReference:medicationReference.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..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
94. MedicationDispense.subject
Definition

A link to a resource representing the person or the group to whom the medication will be given.

ShortWho the dispense is for
Comments

SubstanceAdministration->subject->Patient.

Control0..1
TypeReference(nl-core-patient, Group)
Summarytrue
96. MedicationDispense.context
Definition

The encounter or episode of care that establishes the context for this event.

ShortEncounter / Episode associated with event
Control0..1
TypeReference(HCIM Encounter, nl-core-episodeofcare)
98. MedicationDispense.supportingInformation
Definition

Additional information that supports the medication being dispensed.

ShortInformation that supports the dispensing of the medication
Control0..*
TypeReference(Resource)
100. MedicationDispense.performer
Definition

The supplier (pharmacist) that entered the administration agreement.

ShortSupplier
Comments

The performer will be reviewed as part of STU4.

Control0..*
TypeBackboneElement
Alternate NamesVerstrekker
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
102. MedicationDispense.performer.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
104. MedicationDispense.performer.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
106. MedicationDispense.performer.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

ShortExtensions 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..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Summarytrue
Alternate Namesextensions, user content, modifiers
108. MedicationDispense.performer.actor
Definition

The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

ShortIndividual who was performing
Comments

The health professional's speciality, role, and organization are captured and communicated through the PractitionerRole Resource based on the nl-core-practitionerrole profile.

Control1..1
TypeReference(nl-core-practitioner, nl-core-organization, nl-core-patient, Device, nl-core-relatedperson)
110. MedicationDispense.performer.actor.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
112. MedicationDispense.performer.actor.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.performer.actor.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
114. MedicationDispense.performer.actor.extension:practitionerRole
Slice NamepractitionerRole
Definition

Optional Extension Element - found in all resources.

ShortOptional Extensions Element
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..1
This element is affected by the following invariants: ele-1
TypeExtension(PractitionerRole Reference) (Extension Type: Reference(nl-core-practitionerrole))
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
116. MedicationDispense.performer.actor.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.

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

Control0..1
This element is affected by the following invariants: ref-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
118. MedicationDispense.performer.actor.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
120. MedicationDispense.performer.actor.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..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
122. MedicationDispense.performer.onBehalfOf
Definition

The organization the device or practitioner was acting on behalf of.

ShortOrganization organization was acting for
Control0..1
TypeReference(nl-core-organization)
124. MedicationDispense.authorizingPrescription
Definition

Relationship to the medication agreement on which the administration agreement is based.

ShortMedicationAgreement
Comments

Maps to basedOn in Event logical model.

Control0..*
TypeReference(HCIM MedicationAgreement)
Alternate NamesMedicatieafspraak
126. MedicationDispense.type
Definition

Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

ShortTrial fill, partial fill, emergency fill, etc.
Control0..1
BindingFor example codes, see ActPharmacySupplyType
(example to http://hl7.org/fhir/ValueSet/v3-ActPharmacySupplyType)

Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

TypeCodeableConcept
128. MedicationDispense.quantity
Definition

The amount of medication that has been dispensed. Includes unit of measure.

ShortAmount dispensed
Control0..1
TypeQuantity(SimpleQuantity)
Invariantssqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
130. MedicationDispense.daysSupply
Definition

The amount of medication expressed as a timing amount.

ShortAmount of medication expressed as a timing amount
Control0..1
TypeQuantity(SimpleQuantity)
Invariantssqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
132. MedicationDispense.whenPrepared
Definition

The time when the dispensed product was packaged and reviewed.

ShortWhen product was packaged and reviewed
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
134. MedicationDispense.whenHandedOver
Definition

The time the dispensed product was provided to the patient or their representative.

ShortWhen product was given out
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
136. MedicationDispense.destination
Definition

Identification of the facility/location where the medication was shipped to, as part of the dispense event.

ShortWhere the medication was sent
Control0..1
TypeReference(Location)
138. MedicationDispense.receiver
Definition

Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

ShortWho collected the medication
Control0..*
TypeReference(Patient, Practitioner)
140. MedicationDispense.note
Definition

Comments on the administration agreement.

ShortComment
Control0..*
TypeAnnotation
Alternate NamesToelichting
142. MedicationDispense.dosageInstruction
Definition

Instructions for the use of the medication, e.g. dose and route of administration. In the event of medication use, this is the pattern of use established by the patient or which the patient followed

ShortInstructionsForUse
Comments

The wiki page https://informatiestandaarden.nictiz.nl/wiki/mp:V9.0Voorbeeldendoseringen provides dosage instruction examples. These examples consists of functional data and their representation in FHIR and CDA.

Control0..*
This element is affected by the following invariants: ele-1
TypeDosage(HCIM InstructionsForUse The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
Alternate NamesGebruiksinstructie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
144. MedicationDispense.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.

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
146. MedicationDispense.dosageInstruction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
148. MedicationDispense.dosageInstruction.sequence
Definition

This indicates the sequence of the dosing instructions within the medication agreement.

ShortSequenceNumber
Control0..1
Typeinteger
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.

Alternate NamesVolgnummer
150. MedicationDispense.dosageInstruction.text
Definition

Textual description of the complete instructions for use including the period of use.

ShortDescription
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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.

Alternate NamesOmschrijving
152. MedicationDispense.dosageInstruction.additionalInstruction
Definition

The additional instructions contain extra information on the use of or considerations for the current prescription. This can also include all instructions for use. The text can come from the original 'paper' medication prescription, but can also be generated from the coded information. This concept may contain more information than what is structurally coded in the information below, but may not conflict with it. The instructions may not conflict with other components of the request for administration. The instructions can also refer to an existing protocol. The G standard contains many texts that can support this attribute, in for example G standard table 362, which contains texts from the general practitioners’ standard WCIA table 25. If desired, these texts can be used to structure this concept.

ShortAdditionalInstructions
Control0..*
BindingUnless not suitable, these codes SHALL be taken from Aanvullende gebruiksinstructie
(extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.9--20160407000000)

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

TypeCodeableConcept
Summarytrue
Requirements

Additional instruction such as "Swallow with plenty of water" which may or may not be coded.

Alternate NamesAanvullendeInstructie
154. MedicationDispense.dosageInstruction.patientInstruction
Definition

Instructions in terms that are understood by the patient or consumer.

ShortPatient or consumer oriented instructions
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
156. MedicationDispense.dosageInstruction.timing
Definition

Specifications of the times at which the medication is to be administered. This is indicated as follows: Time(s) (16:00) or indications (“before meals”) at which the medication is to be taken each day. A specific number of times the medication is to be taken each day (“3x a day“), indicated with the frequency A time interval between consecutive doses (“Every 2 hours”, “every 3 days”), indicated with the word Interval. Combined periods with an interval and duration (“1 daily for three out of four weeks: the pill schedule”) If a certain medication is not to be taken daily, the aforementioned can be combined with daily indications: One or more week days on which the medication is to be administered (e.g. “Monday, Wednesday, Friday”) ”3x a week”, “2x a month”. The specified administration “infinite” is automatically to be repeated until: The end date and time has been reached The total administration duration has been reached (14 days) A specific amount of administrations has been reached (“20 doses”, “one-time only”), to be entered in the NumberOfDoses concept.

ShortAdministeringSchedule
Comments

A timing schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.

Control0..1
This element is affected by the following invariants: ele-1
TypeTiming(HCIM AdministrationSchedule The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
Summarytrue
Requirements

The timing schedule for giving the medication to the patient. The Schedule 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.

Alternate NamesToedieningsschema
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
158. MedicationDispense.dosageInstruction.asNeededCodeableConcept:asNeededCodeableConcept
Slice NameasNeededCodeableConcept
Definition

As needed means that the dose is only to be administered under certain conditions.

ShortAsNeeded
Comments

Using the term 'as needed' or a specific reason (eg 'in case of pain') to use medication leads to ambiguity. It is not always clear whether the whole dose is 'as needed' or only part of the dose. For example: 1x daily 1-2 tablets as needed. This can mean: 1 tablet fixed per day and 1 tablet as needed or, as needed, a maximum of 2 tablets.As needed medication is not included in GDS. In the first situation, 1 tablet comes in the GDS (drug dispensing systems) and 1 tablet is delivered separately. In the second situation there is only separate delivery.The system must make sufficiently clear whether the entire instruction or part of the dose is necessary. The HCIM supports both options described above.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from ZonodigCriteriumCodelijst
(extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.4--20171231000000)

ZonodigCriteriumCodelijst

TypeCodeableConcept
Summarytrue
Alternate NamesZo nodig, Criterium
160. MedicationDispense.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 body-site-instance. May be a summary code, or a reference to a very precise definition of the location, or both.

Control0..1
BindingFor example codes, see SNOMED CT Anatomical Structure for Administration Site Codes
(example to http://hl7.org/fhir/ValueSet/approach-site-codes)

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

TypeCodeableConcept
Summarytrue
Requirements

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

162. MedicationDispense.dosageInstruction.route
Definition

The route through which the medication is administered (oral, nasal, intravenous, etc.)

ShortRouteOfAdministration
Control0..1
BindingUnless not suitable, these codes SHALL be taken from MedicatieToedieningswegCodelijst
(extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.1--20171231000000)

ToedieningswegCodelijst

TypeCodeableConcept
Summarytrue
Requirements

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

Alternate NamesToedieningsweg
ExampleExample of RouteOfAdministration: { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.4.9", "code" : "oraal", "display" : "Oraal" }] }
164. MedicationDispense.dosageInstruction.route.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
166. MedicationDispense.dosageInstruction.route.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.route.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
168. MedicationDispense.dosageInstruction.route.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
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

170. MedicationDispense.dosageInstruction.route.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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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.

172. MedicationDispense.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..1
BindingFor example codes, see SNOMED CT Administration Method Codes
(example to http://hl7.org/fhir/ValueSet/administration-method-codes)

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

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

174. MedicationDispense.dosageInstruction.dose[x]
Definition

The dose indicates the dose amount per administration.

The dosage is described in the unit accompanying the product; usually, this is just a number of units or doses. Liquids and other divisible products will usually include a unit of volume (preferably "ml").

In many cases, the prescriber will want to indicate the dose in units of weight of the active ingredient.

If only the ingredient is included and not the product, then the amount of that ingredient will be given. Paracetamol 1000mg is equivalent to 2 Paracetamol 500mg tablets or units.

The dosage is sometimes given as a calculation, in which the patient’s body weight or body surface area is used as a parameter. The calculation is however no more than an aid in reaching a decision.

In the event of constant administration, sometimes the dose is given in addition to the administration speed (infusion rate) (e.g. 20ml in a syringe or 500ml in a bag), but it is often also omitted.

A general dosage recommendation such as ‘Use according to protocol’ or ‘See instructions’ can be sufficient. In that case, no dose is given.

ShortDose
Comments

Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

Control0..1
TypeChoice of: Range, Quantity(SimpleQuantity The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Summarytrue
Requirements

The amount of therapeutic or other substance given at one administration event.

Alternate NamesKeerdosis
SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.dose[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
176. MedicationDispense.dosageInstruction.dose[x]:doseQuantity
Slice NamedoseQuantity
Definition

The comparator is not used on a SimpleQuantity

ShortA fixed quantity (no comparator)
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from G-Standaard Eenhedentabel
(required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453)

GstdTabel902

TypeQuantity(SimpleQuantity)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Summarytrue
Requirements

The amount of therapeutic or other substance given at one administration event.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
178. MedicationDispense.dosageInstruction.dose[x]:doseRange
Slice NamedoseRange
Definition

Amount of medication per dose.

ShortAmount of medication per dose
Comments

Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

Control0..1
TypeRange
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Summarytrue
Requirements

The amount of therapeutic or other substance given at one administration event.

180. MedicationDispense.dosageInstruction.dose[x]:doseRange.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
182. MedicationDispense.dosageInstruction.dose[x]:doseRange.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.dose[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
184. MedicationDispense.dosageInstruction.dose[x]:doseRange.low
Definition

The low limit. The boundary is inclusive.

ShortLow limit
Comments

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

Control0..1
This element is affected by the following invariants: rng-2
BindingThe codes SHALL be taken from G-Standaard Eenhedentabel
(required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453)

GstdTabel902

TypeQuantity(SimpleQuantity)
Summarytrue
Invariantssqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
186. MedicationDispense.dosageInstruction.dose[x]:doseRange.high
Definition

The high limit. The boundary is inclusive.

ShortHigh limit
Comments

If the high element is missing, the high boundary is not known.

Control0..1
This element is affected by the following invariants: rng-2
BindingThe codes SHALL be taken from G-Standaard Eenhedentabel
(required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453)

GstdTabel902

TypeQuantity(SimpleQuantity)
Summarytrue
Invariantssqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
188. MedicationDispense.dosageInstruction.maxDosePerPeriod
Definition

A maximum dose indicates the maximum duration a product can be used with an ‘as needed’ prescription.

For example: - Max 6 units per day - Max 200ml per week

ShortMaximumDose
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..1
TypeRatio
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.

Alternate NamesMaximale dosering, Maximale dosis (per dag enz.)
190. MedicationDispense.dosageInstruction.maxDosePerPeriod.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
192. MedicationDispense.dosageInstruction.maxDosePerPeriod.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.maxDosePerPeriod.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
194. MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator
Definition

The value of the numerator.

ShortNumerator value
Control0..1
BindingThe codes SHALL be taken from G-Standaard Eenhedentabel
(required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453)

GstdTabel902

TypeQuantity
Summarytrue
196. MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator
Definition

The value of the denominator.

ShortDenominator value
Control0..1
TypeQuantity
Summarytrue
198. MedicationDispense.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..1
TypeQuantity(SimpleQuantity)
Summarytrue
Requirements

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

Invariantssqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
200. MedicationDispense.dosageInstruction.maxDosePerLifetime
Definition

Upper limit on medication per lifetime of the patient.

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

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

Invariantssqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
202. MedicationDispense.dosageInstruction.rate[x]
Definition

The administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. Entering an interval (such as 0-10 ml/hour) is also a commonly used option. For example, with an administering speed of 10ml/hour: amount = 10, dose unit = ml time unit = hour

ShortAdministeringSpeed
Comments

It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate.

Control0..1
TypeChoice of: Ratio, Range, Quantity(SimpleQuantity The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Summarytrue
Requirements

Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. 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.

Alternate NamesToedieningssnelheid, Inloopsnelheid
204. MedicationDispense.substitution
Definition

Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

ShortWhether a substitution was performed on the dispense
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
206. MedicationDispense.substitution.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
208. MedicationDispense.substitution.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
210. MedicationDispense.substitution.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

ShortExtensions 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..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Summarytrue
Alternate Namesextensions, user content, modifiers
212. MedicationDispense.substitution.wasSubstituted
Definition

True if the dispenser dispensed a different drug or product from what was prescribed.

ShortWhether a substitution was or was not performed on the dispense
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
214. MedicationDispense.substitution.type
Definition

A code signifying whether a different drug was dispensed from what was prescribed.

ShortCode signifying whether a different drug was dispensed from what was prescribed
Control0..1
BindingFor example codes, see ActSubstanceAdminSubstitutionCode
(example to http://hl7.org/fhir/ValueSet/v3-ActSubstanceAdminSubstitutionCode)

A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription

TypeCodeableConcept
216. MedicationDispense.substitution.reason
Definition

Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.

ShortWhy was substitution made
Control0..*
BindingFor example codes, see SubstanceAdminSubstitutionReason
(example to http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason)

A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed

TypeCodeableConcept
218. MedicationDispense.substitution.responsibleParty
Definition

The person or organization that has primary responsibility for the substitution.

ShortWho is responsible for the substitution
Control0..*
TypeReference(Practitioner)
220. MedicationDispense.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
Control0..*
TypeReference(DetectedIssue)
Alternate NamesContraindication, Drug Utilization Review (DUR), Alert
222. MedicationDispense.notDone
Definition

True if the dispense was not performed for some reason.

ShortWhether the dispense was or was not performed
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
224. MedicationDispense.notDoneReason[x]
Definition

Indicates the reason why a dispense was not performed.

ShortWhy a dispense was not performed
Control0..1
TypeChoice of: CodeableConcept, Reference(DetectedIssue)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
226. MedicationDispense.eventHistory
Definition

A summary of the events of interest that have occurred, such as when the dispense was verified.

ShortA list of releveant lifecycle events
Comments

This may 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..*
TypeReference(Provenance)