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

Resource Profile: HCIM AdministrationAgreement

Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement Version: 1.3.15
Active as of 2025-09-22 Computable Name: Zib AdministrationAgreement

Copyright/Legal: CC0

This profile is based on the Dutch Health and Care Information (HCIM) models (Dutch: Zorginformatiebouwsteen or ZIB) Toedieningsafspraak version 1.0, year 2017.

The goal of the administration agreement is to provide insight into the concrete instructions for administration/use of medication.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense AdministrationAgreement
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: ToedieningsafspraakAanvullendeInformatieCodelijst (extensible): 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"}]}
.... extension:medicationTreatment 0..1 Identifier Medication Treatment
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:stopType 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required)
.... modifierExtension:repeatPeriodCyclicalSchedule 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
... identifier 0..* Identifier External identifier
... category 1..1 CodeableConcept Type of medication dispense
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:administrationAgreementCode 0..1 Coding AdministrationAgreementCode
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 0..1 code Symbol in syntax defined by the system
Fixed Value: 422037009
...... display 0..1 string Representation defined by the system
... Slices for medicationReference Content/Rules for all slices
.... medicationReference:medicationReference 1..1 Reference(HCIM PharmaceuticalProduct) MedicineForAdministrationAgreement
... subject 0..1 Reference(nl-core-patient | Group) Who the dispense is for
... context 0..1 Reference(HCIM Encounter | nl-core-episodeofcare) Encounter / Episode associated with event
... performer 0..* BackboneElement Supplier
.... actor 1..1 Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | Device | nl-core-relatedperson) Individual who was performing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... onBehalfOf 0..1 Reference(nl-core-organization) Organization organization was acting for
... authorizingPrescription 0..* Reference(HCIM MedicationAgreement) MedicationAgreement
... note 0..* Annotation Comment
... dosageInstruction 0..* Zib InstructionsForUse How the medication is to be used by the patient or administered by the caregiver

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationDispense.extension:additionalInformation.valueCodeableConcept:valueCodeableConceptextensibleToedieningsafspraakAanvullendeInformatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000
From this IG
MedicationDispense.modifierExtension:stopType.valueCodeableConcept:valueCodeableConceptrequiredStoptype
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense AdministrationAgreement
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: ToedieningsafspraakAanvullendeInformatieCodelijst (extensible): 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"}]}
.... extension:medicationTreatment 0..1 Identifier Medication Treatment
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:stopType ?! 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required)
.... modifierExtension:repeatPeriodCyclicalSchedule ?! 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
... status ?!Σ 0..1 code CanceledIndicator
Binding: MedicationDispenseStatus (required): A coded concept specifying the state of the dispense event.
... category 1..1 CodeableConcept Type of medication dispense
Binding: MedicationDispenseCategory (preferred): A code describing where the dispensed medication is expected to be consumed or administered
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:administrationAgreementCode Σ 0..1 Coding AdministrationAgreementCode
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: 422037009
...... display Σ 0..1 string Representation defined by the system
... Slices for medication[x] Σ 1..1 Reference() What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ 1..1 Reference(HCIM PharmaceuticalProduct) MedicineForAdministrationAgreement
... subject Σ 0..1 Reference(nl-core-patient | Group) Who the dispense is for
... context 0..1 Reference(HCIM Encounter | nl-core-episodeofcare) Encounter / Episode associated with event
... performer 0..* BackboneElement Supplier
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor 1..1 Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | Device | nl-core-relatedperson) Individual who was performing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... onBehalfOf 0..1 Reference(nl-core-organization) Organization organization was acting for
... authorizingPrescription 0..* Reference(HCIM MedicationAgreement) MedicationAgreement
... note 0..* Annotation Comment
... dosageInstruction 0..* Zib InstructionsForUse How the medication is to be used by the patient or administered by the caregiver

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.extension:additionalInformation.value[x]:valueCodeableConceptextensibleToedieningsafspraakAanvullendeInformatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000
From this IG
MedicationDispense.modifierExtension:stopType.value[x]:valueCodeableConceptrequiredStoptype
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300
From this IG
MedicationDispense.statusrequiredMedicationDispenseStatus
http://hl7.org/fhir/ValueSet/medication-dispense-status|3.0.2
From the FHIR Standard
MedicationDispense.categorypreferredMedicationDispenseCategory
http://hl7.org/fhir/ValueSet/medication-dispense-category|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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()
dom-4errorMedicationDispenseIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense AdministrationAgreement
Constraints: mdd-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: ToedieningsafspraakAanvullendeInformatieCodelijst (extensible): 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"}]}
.... extension:medicationTreatment 0..1 Identifier Medication Treatment
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:stopType ?! 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required)
.... modifierExtension:repeatPeriodCyclicalSchedule ?! 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!Σ 0..1 code CanceledIndicator
Binding: MedicationDispenseStatus (required): A coded concept specifying the state of the dispense event.
... category 1..1 CodeableConcept Type of medication dispense
Binding: MedicationDispenseCategory (preferred): A code describing where the dispensed medication is expected to be consumed or administered
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:administrationAgreementCode Σ 0..1 Coding AdministrationAgreementCode
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: 422037009
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... Slices for medication[x] Σ 1..1 Reference() What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ 1..1 Reference(HCIM PharmaceuticalProduct) MedicineForAdministrationAgreement
... subject Σ 0..1 Reference(nl-core-patient | Group) Who the dispense is for
... context 0..1 Reference(HCIM Encounter | nl-core-episodeofcare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer 0..* BackboneElement Supplier
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor 1..1 Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | Device | nl-core-relatedperson) Individual who was performing
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... onBehalfOf 0..1 Reference(nl-core-organization) Organization organization was acting for
... authorizingPrescription 0..* Reference(HCIM MedicationAgreement) MedicationAgreement
... type 0..1 CodeableConcept ​Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType|2014-03-26 (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity 0..1 SimpleQuantity Amount dispensed
... daysSupply 0..1 SimpleQuantity Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the medication was sent
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Comment
... dosageInstruction 0..* Zib InstructionsForUse How the medication is to be used by the patient or administered by the caregiver
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept ​Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode|2014-03-26 (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription
.... reason 0..* CodeableConcept ​Why was substitution made
Binding: SubstanceAdminSubstitutionReason|2014-03-26 (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed
.... responsibleParty 0..* Reference(Practitioner) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... notDone 0..1 boolean Whether the dispense was or was not performed
... notDoneReason[x] 0..1 Why a dispense was not performed
.... notDoneReasonCodeableConcept CodeableConcept
.... notDoneReasonReference Reference(DetectedIssue)
... eventHistory 0..* Reference(Provenance) A list of releveant lifecycle events

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.languageextensibleCommon Languages
http://hl7.org/fhir/ValueSet/languages|3.0.2
From the FHIR Standard
Additional Bindings Purpose
All Languages Max Binding
MedicationDispense.extension:additionalInformation.value[x]:valueCodeableConceptextensibleToedieningsafspraakAanvullendeInformatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000
From this IG
MedicationDispense.modifierExtension:stopType.value[x]:valueCodeableConceptrequiredStoptype
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300
From this IG
MedicationDispense.statusrequiredMedicationDispenseStatus
http://hl7.org/fhir/ValueSet/medication-dispense-status|3.0.2
From the FHIR Standard
MedicationDispense.categorypreferredMedicationDispenseCategory
http://hl7.org/fhir/ValueSet/medication-dispense-category|3.0.2
From the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://hl7.org/fhir/ValueSet/v3-ActPharmacySupplyType|2014-03-26
From the FHIR Standard
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
http://hl7.org/fhir/ValueSet/v3-ActSubstanceAdminSubstitutionCode|2014-03-26
From the FHIR Standard
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason|2014-03-26
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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()
dom-4errorMedicationDispenseIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispense

Summary

Mandatory: 1 element
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationDispense.category.coding

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense AdministrationAgreement
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: ToedieningsafspraakAanvullendeInformatieCodelijst (extensible): 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"}]}
.... extension:medicationTreatment 0..1 Identifier Medication Treatment
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:stopType 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required)
.... modifierExtension:repeatPeriodCyclicalSchedule 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
... identifier 0..* Identifier External identifier
... category 1..1 CodeableConcept Type of medication dispense
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:administrationAgreementCode 0..1 Coding AdministrationAgreementCode
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 0..1 code Symbol in syntax defined by the system
Fixed Value: 422037009
...... display 0..1 string Representation defined by the system
... Slices for medicationReference Content/Rules for all slices
.... medicationReference:medicationReference 1..1 Reference(HCIM PharmaceuticalProduct) MedicineForAdministrationAgreement
... subject 0..1 Reference(nl-core-patient | Group) Who the dispense is for
... context 0..1 Reference(HCIM Encounter | nl-core-episodeofcare) Encounter / Episode associated with event
... performer 0..* BackboneElement Supplier
.... actor 1..1 Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | Device | nl-core-relatedperson) Individual who was performing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... onBehalfOf 0..1 Reference(nl-core-organization) Organization organization was acting for
... authorizingPrescription 0..* Reference(HCIM MedicationAgreement) MedicationAgreement
... note 0..* Annotation Comment
... dosageInstruction 0..* Zib InstructionsForUse How the medication is to be used by the patient or administered by the caregiver

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationDispense.extension:additionalInformation.valueCodeableConcept:valueCodeableConceptextensibleToedieningsafspraakAanvullendeInformatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000
From this IG
MedicationDispense.modifierExtension:stopType.valueCodeableConcept:valueCodeableConceptrequiredStoptype

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense AdministrationAgreement
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: ToedieningsafspraakAanvullendeInformatieCodelijst (extensible): 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"}]}
.... extension:medicationTreatment 0..1 Identifier Medication Treatment
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:stopType ?! 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required)
.... modifierExtension:repeatPeriodCyclicalSchedule ?! 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
... status ?!Σ 0..1 code CanceledIndicator
Binding: MedicationDispenseStatus (required): A coded concept specifying the state of the dispense event.
... category 1..1 CodeableConcept Type of medication dispense
Binding: MedicationDispenseCategory (preferred): A code describing where the dispensed medication is expected to be consumed or administered
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:administrationAgreementCode Σ 0..1 Coding AdministrationAgreementCode
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: 422037009
...... display Σ 0..1 string Representation defined by the system
... Slices for medication[x] Σ 1..1 Reference() What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ 1..1 Reference(HCIM PharmaceuticalProduct) MedicineForAdministrationAgreement
... subject Σ 0..1 Reference(nl-core-patient | Group) Who the dispense is for
... context 0..1 Reference(HCIM Encounter | nl-core-episodeofcare) Encounter / Episode associated with event
... performer 0..* BackboneElement Supplier
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor 1..1 Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | Device | nl-core-relatedperson) Individual who was performing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... onBehalfOf 0..1 Reference(nl-core-organization) Organization organization was acting for
... authorizingPrescription 0..* Reference(HCIM MedicationAgreement) MedicationAgreement
... note 0..* Annotation Comment
... dosageInstruction 0..* Zib InstructionsForUse How the medication is to be used by the patient or administered by the caregiver

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.extension:additionalInformation.value[x]:valueCodeableConceptextensibleToedieningsafspraakAanvullendeInformatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000
From this IG
MedicationDispense.modifierExtension:stopType.value[x]:valueCodeableConceptrequiredStoptype
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300
From this IG
MedicationDispense.statusrequiredMedicationDispenseStatus
http://hl7.org/fhir/ValueSet/medication-dispense-status|3.0.2
From the FHIR Standard
MedicationDispense.categorypreferredMedicationDispenseCategory
http://hl7.org/fhir/ValueSet/medication-dispense-category|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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()
dom-4errorMedicationDispenseIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense AdministrationAgreement
Constraints: mdd-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: ToedieningsafspraakAanvullendeInformatieCodelijst (extensible): 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"}]}
.... extension:medicationTreatment 0..1 Identifier Medication Treatment
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:stopType ?! 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required)
.... modifierExtension:repeatPeriodCyclicalSchedule ?! 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!Σ 0..1 code CanceledIndicator
Binding: MedicationDispenseStatus (required): A coded concept specifying the state of the dispense event.
... category 1..1 CodeableConcept Type of medication dispense
Binding: MedicationDispenseCategory (preferred): A code describing where the dispensed medication is expected to be consumed or administered
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:administrationAgreementCode Σ 0..1 Coding AdministrationAgreementCode
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: 422037009
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... Slices for medication[x] Σ 1..1 Reference() What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ 1..1 Reference(HCIM PharmaceuticalProduct) MedicineForAdministrationAgreement
... subject Σ 0..1 Reference(nl-core-patient | Group) Who the dispense is for
... context 0..1 Reference(HCIM Encounter | nl-core-episodeofcare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer 0..* BackboneElement Supplier
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor 1..1 Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | Device | nl-core-relatedperson) Individual who was performing
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... onBehalfOf 0..1 Reference(nl-core-organization) Organization organization was acting for
... authorizingPrescription 0..* Reference(HCIM MedicationAgreement) MedicationAgreement
... type 0..1 CodeableConcept ​Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType|2014-03-26 (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity 0..1 SimpleQuantity Amount dispensed
... daysSupply 0..1 SimpleQuantity Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the medication was sent
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Comment
... dosageInstruction 0..* Zib InstructionsForUse How the medication is to be used by the patient or administered by the caregiver
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept ​Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode|2014-03-26 (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription
.... reason 0..* CodeableConcept ​Why was substitution made
Binding: SubstanceAdminSubstitutionReason|2014-03-26 (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed
.... responsibleParty 0..* Reference(Practitioner) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... notDone 0..1 boolean Whether the dispense was or was not performed
... notDoneReason[x] 0..1 Why a dispense was not performed
.... notDoneReasonCodeableConcept CodeableConcept
.... notDoneReasonReference Reference(DetectedIssue)
... eventHistory 0..* Reference(Provenance) A list of releveant lifecycle events

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.languageextensibleCommon Languages
http://hl7.org/fhir/ValueSet/languages|3.0.2
From the FHIR Standard
Additional Bindings Purpose
All Languages Max Binding
MedicationDispense.extension:additionalInformation.value[x]:valueCodeableConceptextensibleToedieningsafspraakAanvullendeInformatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000
From this IG
MedicationDispense.modifierExtension:stopType.value[x]:valueCodeableConceptrequiredStoptype
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300
From this IG
MedicationDispense.statusrequiredMedicationDispenseStatus
http://hl7.org/fhir/ValueSet/medication-dispense-status|3.0.2
From the FHIR Standard
MedicationDispense.categorypreferredMedicationDispenseCategory
http://hl7.org/fhir/ValueSet/medication-dispense-category|3.0.2
From the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://hl7.org/fhir/ValueSet/v3-ActPharmacySupplyType|2014-03-26
From the FHIR Standard
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
http://hl7.org/fhir/ValueSet/v3-ActSubstanceAdminSubstitutionCode|2014-03-26
From the FHIR Standard
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason|2014-03-26
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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()
dom-4errorMedicationDispenseIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispense

Summary

Mandatory: 1 element
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationDispense.category.coding

 

Other representations of profile: CSV, Excel, Schematron