Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2025-09-22 |
Definitions for the zib-AdministrationAgreement resource profile.
Guidance on how to interpret the contents of this table can be foundhere
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. |
Short | AdministrationAgreement |
Alternate Names | Toedieningsafspraak |
2. MedicationDispense.extension | |
Slicing | This element introduces a set of slices on MedicationDispense.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. MedicationDispense.extension:authoredOn | |
Slice Name | authoredOn |
Definition | The time at which the agreement was made. |
Short | AdministrationAgreementDateTime |
Control | 0..1 |
Type | Extension(HCIM Authored On) (Extension Type: dateTime) |
Alternate Names | ToedieningsafspraakDatumTijd |
6. MedicationDispense.extension:agreementReason | |
Slice Name | agreementReason |
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 |
Short | AgreementReason |
Control | 0..1 |
Type | Extension(HCIM Reason For Dispense) (Extension Type: string) |
Alternate Names | RedenAfspraak |
8. MedicationDispense.extension:periodOfUse | |
Slice Name | periodOfUse |
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. |
Short | PeriodOfUse |
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 |
Type | Extension(HCIM Medication Period Of Use) (Extension Type: Period) |
10. MedicationDispense.extension:usageDuration | |
Slice Name | usageDuration |
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. |
Short | Duration |
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 |
Control | 0..1 |
Type | Extension(HCIM MedicationUse Duration) (Extension Type: Duration) |
Alternate Names | Gebruiksduur |
12. MedicationDispense.extension:additionalInformation | |
Slice Name | additionalInformation |
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. |
Short | AdministrationAgreementAdditionalInformation |
Control | 0..1 |
Type | Extension(HCIM AdditionalInformation) (Extension Type: CodeableConcept) |
Alternate Names | ToedieningsafspraakAanvullendeInformatie |
14. MedicationDispense.extension:additionalInformation.valueCodeableConcept:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
Binding | Unless 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 |
Example | Example 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" }] } |
16. MedicationDispense.extension:medicationTreatment | |
Slice Name | medicationTreatment |
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. |
Short | Medication Treatment |
Comments | No HCIM concept is available for this element. Therefore a mapping to the relevant element Medication Process data element is provided. |
Control | 0..1 |
Type | Extension(HCIM MedicationTreatment) (Extension Type: Identifier) |
Alternate Names | Medicamenteuze behandeling |
18. MedicationDispense.modifierExtension | |
Slicing | This element introduces a set of slices on MedicationDispense.modifierExtension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. MedicationDispense.modifierExtension:stopType | |
Slice Name | stopType |
Short | AdministrationAgreementStopType |
Control | 0..1 |
Type | Extension(HCIM Medication StopType) (Extension Type: CodeableConcept) |
22. MedicationDispense.modifierExtension:stopType.valueCodeableConcept:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
24. MedicationDispense.modifierExtension:repeatPeriodCyclicalSchedule | |
Slice Name | repeatPeriodCyclicalSchedule |
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 |
Short | RepeatPeriodCyclicalSchedule |
Control | 0..1 |
Type | Extension(HCIM Medication RepeatPeriodCyclicalSchedule) (Extension Type: Duration) |
Label | HerhaalperiodeCyclischSchema |
26. MedicationDispense.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
28. MedicationDispense.status | |
Definition | In the event of an error correction, the value of this element shall be 'entered-in-error'. |
Short | CanceledIndicator |
Alternate Names | GeannuleerdIndicator |
30. MedicationDispense.category | |
Control | 1..? |
32. MedicationDispense.category.coding | |
Slicing | This element introduces a set of slices on MedicationDispense.category.coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
34. MedicationDispense.category.coding:administrationAgreementCode | |
Slice Name | administrationAgreementCode |
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. |
Short | AdministrationAgreementCode |
Control | 0..1 |
36. MedicationDispense.category.coding:administrationAgreementCode.system | |
Fixed Value | http://snomed.info/sct |
38. MedicationDispense.category.coding:administrationAgreementCode.code | |
Fixed Value | 422037009 |
40. MedicationDispense.category.coding:administrationAgreementCode.display | |
Default Value | Provider medication administration instructions (procedure) |
42. MedicationDispense.medicationReference:medicationReference | |
Slice Name | medicationReference |
Definition | Medicine in the AdministrationAgreement. |
Short | MedicineForAdministrationAgreement |
Type | Reference(HCIM PharmaceuticalProduct) |
Alternate Names | GeneesmiddelBijToedieningsAfspraak, Product |
44. MedicationDispense.subject | |
Type | Reference(nl-core-patient, Group) |
46. MedicationDispense.context | |
Type | Reference(HCIM Encounter, nl-core-episodeofcare) |
48. MedicationDispense.performer | |
Definition | The supplier (pharmacist) that entered the administration agreement. |
Short | Supplier |
Alternate Names | Verstrekker |
50. MedicationDispense.performer.actor | |
Comments | The health professional's speciality, role, and organization are captured and communicated through the PractitionerRole Resource based on the nl-core-practitionerrole profile. |
Type | Reference(nl-core-practitioner, nl-core-organization, nl-core-patient, Device, nl-core-relatedperson) |
52. MedicationDispense.performer.actor.extension | |
Slicing | This element introduces a set of slices on MedicationDispense.performer.actor.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
54. MedicationDispense.performer.actor.extension:practitionerRole | |
Slice Name | practitionerRole |
Control | 0..1 |
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) |
56. MedicationDispense.performer.onBehalfOf | |
Type | Reference(nl-core-organization) |
58. MedicationDispense.authorizingPrescription | |
Definition | Relationship to the medication agreement on which the administration agreement is based. |
Short | MedicationAgreement |
Type | Reference(HCIM MedicationAgreement) |
Alternate Names | Medicatieafspraak |
60. MedicationDispense.note | |
Definition | Comments on the administration agreement. |
Short | Comment |
Alternate Names | Toelichting |
62. MedicationDispense.dosageInstruction | |
Type | Dosage(HCIM InstructionsForUse) |
Guidance on how to interpret the contents of this table can be foundhere
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. Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order. |
Short | AdministrationAgreementDispensing a medication to a named patient |
Comments | The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html). |
Control | 0..* |
Alternate Names | Toedieningsafspraak |
Invariants | dom-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 )dom-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. |
Short | A 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. |
Control | 0..1 |
Type | uri |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
4. MedicationDispense.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on MedicationDispense.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. MedicationDispense.extension:authoredOn | |
Slice Name | authoredOn |
Definition | The time at which the agreement was made. |
Short | AdministrationAgreementDateTime |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM Authored On) (Extension Type: dateTime) |
Alternate Names | ToedieningsafspraakDatumTijd |
Invariants | ele-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:agreementReason | |
Slice Name | agreementReason |
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 |
Short | AgreementReason |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM Reason For Dispense) (Extension Type: string) |
Alternate Names | RedenAfspraak |
Invariants | ele-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:periodOfUse | |
Slice Name | periodOfUse |
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. |
Short | PeriodOfUse |
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 |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM Medication Period Of Use) (Extension Type: Period) |
Alternate Names | Gebruiksperiode |
Invariants | ele-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:usageDuration | |
Slice Name | usageDuration |
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. |
Short | Duration |
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 |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM MedicationUse Duration) (Extension Type: Duration) |
Alternate Names | Gebruiksduur |
Invariants | ele-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 | |
Slice Name | additionalInformation |
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. |
Short | AdministrationAgreementAdditionalInformation |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM AdditionalInformation) (Extension Type: CodeableConcept) |
Alternate Names | ToedieningsafspraakAanvullendeInformatie |
Invariants | ele-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() ) |
16. MedicationDispense.extension:additionalInformation.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies 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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation |
18. MedicationDispense.extension:additionalInformation.value[x] | |
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). |
Short | Value of extension |
Control | 0..1 |
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on MedicationDispense.extension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
20. MedicationDispense.extension:additionalInformation.value[x]:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
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). |
Short | Value of extension |
Control | 0..1 |
Binding | Unless 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 |
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Example | Example 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" }] } |
22. MedicationDispense.extension:medicationTreatment | |
Slice Name | medicationTreatment |
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. |
Short | Medication Treatment |
Comments | No HCIM concept is available for this element. Therefore a mapping to the relevant element Medication Process data element is provided. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM MedicationTreatment) (Extension Type: Identifier) |
Alternate Names | Medicamenteuze behandeling |
Invariants | ele-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.modifierExtension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. 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. |
Short | ExtensionExtensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on MedicationDispense.modifierExtension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
26. MedicationDispense.modifierExtension:stopType | |
Slice Name | stopType |
Definition | The manner in which (and indicator that) this medication is discontinued (temporarily or permanently). |
Short | AdministrationAgreementStopType |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM Medication StopType) (Extension Type: CodeableConcept) |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Invariants | ele-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() ) |
28. MedicationDispense.modifierExtension:stopType.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies 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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType |
30. MedicationDispense.modifierExtension:stopType.value[x] | |
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). |
Short | Value of extension |
Control | 0..1 |
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on MedicationDispense.modifierExtension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
32. MedicationDispense.modifierExtension:stopType.value[x]:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
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). |
Short | Value of extension |
Control | 0..1 |
Binding | The 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 ) |
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] |
34. MedicationDispense.modifierExtension:repeatPeriodCyclicalSchedule | |
Slice Name | repeatPeriodCyclicalSchedule |
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 |
Short | RepeatPeriodCyclicalSchedule |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM Medication RepeatPeriodCyclicalSchedule) (Extension Type: Duration) |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Label | HerhaalperiodeCyclischSchema |
Invariants | ele-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.identifier | |
Definition | Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR. |
Short | External identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
38. 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. |
Short | CanceledIndicatorpreparation | 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. |
Control | 0..1 |
Binding | The 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|3.0.2 )A coded concept specifying the state of the dispense event. |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | GeannuleerdIndicator |
40. MedicationDispense.category | |
Definition | Indicates type of medication dispense and where the medication is expected to be consumed or administered. |
Short | Type of medication dispense |
Control | 10..1 |
Binding | The 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|3.0.2 )A code describing where the dispensed medication is expected to be consumed or administered |
Type | CodeableConcept |
42. MedicationDispense.category.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code 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. |
Control | 0..* |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Slicing | This element introduces a set of slices on MedicationDispense.category.coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
44. MedicationDispense.category.coding:administrationAgreementCode | |
Slice Name | administrationAgreementCode |
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. |
Short | AdministrationAgreementCodeCode 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. |
Control | 0..1* |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
46. MedicationDispense.category.coding:administrationAgreementCode.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity 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. |
Control | 0..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Fixed Value | http://snomed.info/sct |
48. 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). |
Short | Symbol in syntax defined by the system |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 422037009 |
50. MedicationDispense.category.coding:administrationAgreementCode.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Short | Representation defined by the system |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
52. MedicationDispense.medication[x] | |
Definition | 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. |
Short | What 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. . |
Control | 1..1 |
Type | Reference(Medication), CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Summary | true |
Slicing | This element introduces a set of slices on MedicationDispense.medication[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
54. MedicationDispense.medication[x]:medicationReference | |
Slice Name | medicationReference |
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. |
Short | MedicineForAdministrationAgreementWhat 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. . |
Control | 1..1 |
Type | Reference(HCIM PharmaceuticalProduct, Medication), CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Summary | true |
Alternate Names | GeneesmiddelBijToedieningsAfspraak, Product |
56. MedicationDispense.subject | |
Definition | A link to a resource representing the person or the group to whom the medication will be given. |
Short | Who the dispense is for |
Comments | SubstanceAdministration->subject->Patient. |
Control | 0..1 |
Type | Reference(nl-core-patient, Group, Patient) |
Summary | true |
58. MedicationDispense.context | |
Definition | The encounter or episode of care that establishes the context for this event. |
Short | Encounter / Episode associated with event |
Control | 0..1 |
Type | Reference(HCIM Encounter, nl-core-episodeofcare, Encounter, EpisodeOfCare) |
60. MedicationDispense.performer | |
Definition | The supplier (pharmacist) that entered the administration agreement. Indicates who or what performed the event. It should be assumed that the performer is the dispenser of the medication. |
Short | SupplierWho performed event |
Comments | The performer will be reviewed as part of STU4. |
Control | 0..* |
Type | BackboneElement |
Alternate Names | Verstrekker |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
62. 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. |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Summary | true |
Alternate Names | extensions, user content, modifiers |
64. 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. |
Short | Individual 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. |
Control | 1..1 |
Type | Reference(nl-core-practitioner, nl-core-organization, nl-core-patient, Device, nl-core-relatedperson, Practitioner, Organization, Patient, RelatedPerson) |
66. MedicationDispense.performer.actor.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on MedicationDispense.performer.actor.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
68. MedicationDispense.performer.actor.extension:practitionerRole | |
Slice Name | practitionerRole |
Definition | Optional Extension Element - found in all resources. |
Short | Optional Extensions Element |
Control | 0..1 |
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) |
70. MedicationDispense.performer.onBehalfOf | |
Definition | The organization the device or practitioner was acting on behalf of. |
Short | Organization organization was acting for |
Control | 0..1 |
Type | Reference(nl-core-organization, Organization) |
72. MedicationDispense.authorizingPrescription | |
Definition | Relationship to the medication agreement on which the administration agreement is based. Indicates the medication order that is being dispensed against. |
Short | MedicationAgreementMedication order that authorizes the dispense |
Comments | Maps to basedOn in Event logical model. |
Control | 0..* |
Type | Reference(HCIM MedicationAgreement, MedicationRequest) |
Alternate Names | Medicatieafspraak |
74. MedicationDispense.note | |
Definition | Comments on the administration agreement. Extra information about the dispense that could not be conveyed in the other attributes. |
Short | CommentInformation about the dispense |
Control | 0..* |
Type | Annotation |
Alternate Names | Toelichting |
76. MedicationDispense.dosageInstruction | |
Definition | Indicates how the medication is to be used by the patient. |
Short | How the medication is to be used by the patient or administered by the caregiver |
Comments | 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. |
Control | 0..* |
Type | Dosage(HCIM InstructionsForUse) |
Guidance on how to interpret the contents of this table can be foundhere
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. | ||||
Short | AdministrationAgreement | ||||
Comments | The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html). | ||||
Control | 0..* | ||||
Alternate Names | Toedieningsafspraak | ||||
Invariants | dom-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. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
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. | ||||
Short | A 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
8. MedicationDispense.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language 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). | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2 )A human language.
| ||||
Type | code | ||||
Primitive Value | This 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. | ||||
Short | Text 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. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, 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. | ||||
Short | Contained, 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. MedicationDispense.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on MedicationDispense.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
16. MedicationDispense.extension:authoredOn | |||||
Slice Name | authoredOn | ||||
Definition | The time at which the agreement was made. | ||||
Short | AdministrationAgreementDateTime | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM Authored On) (Extension Type: dateTime) | ||||
Alternate Names | ToedieningsafspraakDatumTijd | ||||
Invariants | ele-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 Name | agreementReason | ||||
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 | ||||
Short | AgreementReason | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM Reason For Dispense) (Extension Type: string) | ||||
Alternate Names | RedenAfspraak | ||||
Invariants | ele-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 Name | periodOfUse | ||||
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. | ||||
Short | PeriodOfUse | ||||
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 | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM Medication Period Of Use) (Extension Type: Period) | ||||
Alternate Names | Gebruiksperiode | ||||
Invariants | ele-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 Name | usageDuration | ||||
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. | ||||
Short | Duration | ||||
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 | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM MedicationUse Duration) (Extension Type: Duration) | ||||
Alternate Names | Gebruiksduur | ||||
Invariants | ele-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 Name | additionalInformation | ||||
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. | ||||
Short | AdministrationAgreementAdditionalInformation | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM AdditionalInformation) (Extension Type: CodeableConcept) | ||||
Alternate Names | ToedieningsafspraakAanvullendeInformatie | ||||
Invariants | ele-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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In 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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on MedicationDispense.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
30. MedicationDispense.extension:additionalInformation.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies 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. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation | ||||
32. MedicationDispense.extension:additionalInformation.value[x] | |||||
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). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Slicing | This element introduces a set of slices on MedicationDispense.extension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
34. MedicationDispense.extension:additionalInformation.value[x]:valueCodeableConcept | |||||
Slice Name | valueCodeableConcept | ||||
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). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Binding | Unless 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 | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Example | Example 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" }] } | ||||
36. MedicationDispense.extension:medicationTreatment | |||||
Slice Name | medicationTreatment | ||||
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. | ||||
Short | Medication Treatment | ||||
Comments | No HCIM concept is available for this element. Therefore a mapping to the relevant element Medication Process data element is provided. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM MedicationTreatment) (Extension Type: Identifier) | ||||
Alternate Names | Medicamenteuze behandeling | ||||
Invariants | ele-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() ) | ||||
38. MedicationDispense.modifierExtension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Slicing | This element introduces a set of slices on MedicationDispense.modifierExtension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
40. MedicationDispense.modifierExtension:stopType | |||||
Slice Name | stopType | ||||
Definition | The manner in which (and indicator that) this medication is discontinued (temporarily or permanently). | ||||
Short | AdministrationAgreementStopType | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM Medication StopType) (Extension Type: CodeableConcept) | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Invariants | ele-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() ) | ||||
42. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
44. 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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on MedicationDispense.modifierExtension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
46. MedicationDispense.modifierExtension:stopType.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies 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. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType | ||||
48. MedicationDispense.modifierExtension:stopType.value[x] | |||||
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). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Slicing | This element introduces a set of slices on MedicationDispense.modifierExtension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
50. MedicationDispense.modifierExtension:stopType.value[x]:valueCodeableConcept | |||||
Slice Name | valueCodeableConcept | ||||
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). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Binding | The 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 ) | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
52. MedicationDispense.modifierExtension:repeatPeriodCyclicalSchedule | |||||
Slice Name | repeatPeriodCyclicalSchedule | ||||
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 | ||||
Short | RepeatPeriodCyclicalSchedule | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM Medication RepeatPeriodCyclicalSchedule) (Extension Type: Duration) | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Label | HerhaalperiodeCyclischSchema | ||||
Invariants | ele-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() ) | ||||
54. MedicationDispense.identifier | |||||
Definition | Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR. | ||||
Short | External identifier | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
56. MedicationDispense.partOf | |||||
Definition | The procedure that the dispense is done because of. | ||||
Short | Event that dispense is part of | ||||
Control | 0..* | ||||
Type | Reference(Procedure) | ||||
58. MedicationDispense.status | |||||
Definition | In the event of an error correction, the value of this element shall be 'entered-in-error'. | ||||
Short | CanceledIndicator | ||||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from MedicationDispenseStatus (required to http://hl7.org/fhir/ValueSet/medication-dispense-status|3.0.2 )A coded concept specifying the state of the dispense event. | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | GeannuleerdIndicator | ||||
60. MedicationDispense.category | |||||
Definition | Indicates type of medication dispense and where the medication is expected to be consumed or administered. | ||||
Short | Type of medication dispense | ||||
Control | 1..1 | ||||
Binding | The codes SHOULD be taken from MedicationDispenseCategory (preferred to http://hl7.org/fhir/ValueSet/medication-dispense-category|3.0.2 )A code describing where the dispensed medication is expected to be consumed or administered | ||||
Type | CodeableConcept | ||||
62. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
64. 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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on MedicationDispense.category.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
66. MedicationDispense.category.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code 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. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Slicing | This element introduces a set of slices on MedicationDispense.category.coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
68. MedicationDispense.category.coding:administrationAgreementCode | |||||
Slice Name | administrationAgreementCode | ||||
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. | ||||
Short | AdministrationAgreementCode | ||||
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. | ||||
Control | 0..1 | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
70. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
72. 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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on MedicationDispense.category.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
74. MedicationDispense.category.coding:administrationAgreementCode.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Short | Identity 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Fixed Value | http://snomed.info/sct | ||||
76. 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. | ||||
Short | Version 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. | ||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
78. 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). | ||||
Short | Symbol in syntax defined by the system | ||||
Control | 0..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 422037009 | ||||
80. MedicationDispense.category.coding:administrationAgreementCode.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Short | Representation defined by the system | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
82. 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). | ||||
Short | If 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. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
84. 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. | ||||
Short | Plain text representation of the concept | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
86. MedicationDispense.medication[x] | |||||
Definition | 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. | ||||
Short | What 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. . | ||||
Control | 1..1 | ||||
Type | Reference | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Summary | true | ||||
Slicing | This element introduces a set of slices on MedicationDispense.medication[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
88. MedicationDispense.medication[x]:medicationReference | |||||
Slice Name | medicationReference | ||||
Definition | Medicine in the AdministrationAgreement. | ||||
Short | MedicineForAdministrationAgreement | ||||
Control | 1..1 | ||||
Type | Reference(HCIM PharmaceuticalProduct) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Summary | true | ||||
Alternate Names | GeneesmiddelBijToedieningsAfspraak, Product | ||||
90. MedicationDispense.subject | |||||
Definition | A link to a resource representing the person or the group to whom the medication will be given. | ||||
Short | Who the dispense is for | ||||
Comments | SubstanceAdministration->subject->Patient. | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-patient, Group) | ||||
Summary | true | ||||
92. MedicationDispense.context | |||||
Definition | The encounter or episode of care that establishes the context for this event. | ||||
Short | Encounter / Episode associated with event | ||||
Control | 0..1 | ||||
Type | Reference(HCIM Encounter, nl-core-episodeofcare) | ||||
94. MedicationDispense.supportingInformation | |||||
Definition | Additional information that supports the medication being dispensed. | ||||
Short | Information that supports the dispensing of the medication | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
96. MedicationDispense.performer | |||||
Definition | The supplier (pharmacist) that entered the administration agreement. | ||||
Short | Supplier | ||||
Comments | The performer will be reviewed as part of STU4. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Alternate Names | Verstrekker | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
98. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
100. 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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
102. 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. | ||||
Short | Extensions 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
104. 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. | ||||
Short | Individual 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. | ||||
Control | 1..1 | ||||
Type | Reference(nl-core-practitioner, nl-core-organization, nl-core-patient, Device, nl-core-relatedperson) | ||||
106. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
108. MedicationDispense.performer.actor.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on MedicationDispense.performer.actor.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
110. MedicationDispense.performer.actor.extension:practitionerRole | |||||
Slice Name | practitionerRole | ||||
Definition | Optional Extension Element - found in all resources. | ||||
Short | Optional Extensions Element | ||||
Control | 0..1 | ||||
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) | ||||
112. 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. | ||||
Short | Literal reference, Relative, internal or absolute URL | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
114. 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. | ||||
Short | Logical 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. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
116. MedicationDispense.performer.actor.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Short | Text 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
118. MedicationDispense.performer.onBehalfOf | |||||
Definition | The organization the device or practitioner was acting on behalf of. | ||||
Short | Organization organization was acting for | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-organization) | ||||
120. MedicationDispense.authorizingPrescription | |||||
Definition | Relationship to the medication agreement on which the administration agreement is based. | ||||
Short | MedicationAgreement | ||||
Comments | Maps to basedOn in Event logical model. | ||||
Control | 0..* | ||||
Type | Reference(HCIM MedicationAgreement) | ||||
Alternate Names | Medicatieafspraak | ||||
122. 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. | ||||
Short | Trial fill, partial fill, emergency fill, etc. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ActPharmacySupplyType|2014-03-26 (example to http://hl7.org/fhir/ValueSet/v3-ActPharmacySupplyType|2014-03-26 )Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. | ||||
Type | CodeableConcept | ||||
124. MedicationDispense.quantity | |||||
Definition | The amount of medication that has been dispensed. Includes unit of measure. | ||||
Short | Amount dispensed | ||||
Control | 0..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
126. MedicationDispense.daysSupply | |||||
Definition | The amount of medication expressed as a timing amount. | ||||
Short | Amount of medication expressed as a timing amount | ||||
Control | 0..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
128. MedicationDispense.whenPrepared | |||||
Definition | The time when the dispensed product was packaged and reviewed. | ||||
Short | When product was packaged and reviewed | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
130. MedicationDispense.whenHandedOver | |||||
Definition | The time the dispensed product was provided to the patient or their representative. | ||||
Short | When product was given out | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
132. MedicationDispense.destination | |||||
Definition | Identification of the facility/location where the medication was shipped to, as part of the dispense event. | ||||
Short | Where the medication was sent | ||||
Control | 0..1 | ||||
Type | Reference(Location) | ||||
134. 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. | ||||
Short | Who collected the medication | ||||
Control | 0..* | ||||
Type | Reference(Patient, Practitioner) | ||||
136. MedicationDispense.note | |||||
Definition | Comments on the administration agreement. | ||||
Short | Comment | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Alternate Names | Toelichting | ||||
138. MedicationDispense.dosageInstruction | |||||
Definition | Indicates how the medication is to be used by the patient. | ||||
Short | How the medication is to be used by the patient or administered by the caregiver | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Dosage(HCIM InstructionsForUse) | ||||
140. 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. | ||||
Short | Whether a substitution was performed on the dispense | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
142. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
144. 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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
146. 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. | ||||
Short | Extensions 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
148. MedicationDispense.substitution.wasSubstituted | |||||
Definition | True if the dispenser dispensed a different drug or product from what was prescribed. | ||||
Short | Whether a substitution was or was not performed on the dispense | ||||
Control | 1..1 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
150. MedicationDispense.substitution.type | |||||
Definition | A code signifying whether a different drug was dispensed from what was prescribed. | ||||
Short | Code signifying whether a different drug was dispensed from what was prescribed | ||||
Control | 0..1 | ||||
Binding | For example codes, see ActSubstanceAdminSubstitutionCode|2014-03-26 (example to http://hl7.org/fhir/ValueSet/v3-ActSubstanceAdminSubstitutionCode|2014-03-26 )A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription | ||||
Type | CodeableConcept | ||||
152. MedicationDispense.substitution.reason | |||||
Definition | Indicates the reason for the substitution of (or lack of substitution) from what was prescribed. | ||||
Short | Why was substitution made | ||||
Control | 0..* | ||||
Binding | For example codes, see SubstanceAdminSubstitutionReason|2014-03-26 (example to http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason|2014-03-26 )A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed | ||||
Type | CodeableConcept | ||||
154. MedicationDispense.substitution.responsibleParty | |||||
Definition | The person or organization that has primary responsibility for the substitution. | ||||
Short | Who is responsible for the substitution | ||||
Control | 0..* | ||||
Type | Reference(Practitioner) | ||||
156. 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. | ||||
Short | Clinical issue with action | ||||
Control | 0..* | ||||
Type | Reference(DetectedIssue) | ||||
Alternate Names | Contraindication, Drug Utilization Review (DUR), Alert | ||||
158. MedicationDispense.notDone | |||||
Definition | True if the dispense was not performed for some reason. | ||||
Short | Whether the dispense was or was not performed | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
160. MedicationDispense.notDoneReason[x] | |||||
Definition | Indicates the reason why a dispense was not performed. | ||||
Short | Why a dispense was not performed | ||||
Control | 0..1 | ||||
Type | Choice of: CodeableConcept, Reference(DetectedIssue) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
162. MedicationDispense.eventHistory | |||||
Definition | A summary of the events of interest that have occurred, such as when the dispense was verified. | ||||
Short | A 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.). | ||||
Control | 0..* | ||||
Type | Reference(Provenance) |