RIVO-Noord Zorgviewer Implementation Guide
1.25.0 - master Netherlands flag

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

Resource Profile: Toedieningsafspraak

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Toedieningsafspraak Version: 1.25.0
Active as of 2026-08-21 Computable Name: Toedieningsafspraak

Medicatie Toedingingsafspraak

Dit profiel is het resultaat van de vergelijking tussen de zib2017 STU3 en zibs2020 R4 FHIR Profiel, relevante informatiestandarden en de implementaties in de ontsloten systemen en instellingen. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

De specificatie op deze pagina is work-in-progress of gemaakt als uitwerking van een analyse als voorbeeld voor verdere discussie.

Zorginformatiebouwsteen

ZIB Toedieningsafspraak

View Definition

ViewDefinition voor Toedieningsafspraak

UI Wireframe

Toedieningsafspraak

>< Bron Start Eind Medicatie Dosering & instructies Toedieningsweg Stop type
+ MP9 11-11-2022 IBUPROFEN TABLET 600MG Vanaf 11 nov 2022, gedurende 3 weken, 1 maal per dag 1 stuk, oraal oraal
Afspraakdatum
11-11-2022
Verstrekker
Healthcare provider (organization), Apotheek de Gulle Gaper
Type
toedieningsafspraak

Kolomdefinities

Kolom label FHIR Path Expression FHIR Type Zib element Toelichting of regels
Bron meta.extension('http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source').valueUri string nvt Lookup adhv uri (AGB-Z of OID) <adressering-base>/Organization?identifier=<.meta.tag.code> en gebruik dan Organization.name
Start extension('http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period').valuePeriod.start dateTime Gebruiksperiode::TijdsInterval/startDatumTijd
Eind extension('http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period').valuePeriod.end dateTime Gebruiksperiode::TijdsInterval/eindDatumTijd
Medicatie medication.display string Afgesprokengeneesmiddel::Product
Dosering & instructies extension('http://nictiz.nl/fhir/StructureDefinition/ext-RenderedDosageInstruction').valueString | dosageInstruction.text string Gebruiksinstructie/Omschrijving, Gebruiksinstructie/AanvullendeInstructie N.B. Als text niet beschikbaar dan samenstellen uit discrete informatie en markeren met een icoontje ⓘ
Toedieningsweg iif(exists(dosageInstruction.route.text), dosageInstruction.route.text, dosageInstruction.route.coding.display) string Gebruiksinstructie/Toedieningsweg
Stop type '' string StopType niet beschikbaar
UITKLAPVELD
+Medicatie vorm medication.resolve().form.coding.display string Afgesprokengeneesmiddel::FarmaceutischProduct/FarmaceutischeVorm
+Afspraakdatum extension('http://nictiz.nl/fhir/StructureDefinition/ext-AdministrationAgreement.AdministrationAgreementDateTime').valueDateTime dateTime MedicatieafspraakDatumTijd
+Verstrekker performer.actor.display string Verstrekker::Zorgverlener
+Type 'toedieningsafspraak' string nvt

Request

  1. Opvragen (search) medicatie gebruik

    GET <ontsluiten-bronsysteem-base>/MedicationDispense?category=http://snomed.info/sct|422037009&_include=MedicationDispense:medication&patient=<fhir_patient_id>

Bronsysteem herkennen

De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de AGB, OID of URA identifier van de zorgaanbieder (zie Organization voor voorbeelden). Dit wordt vervolgens gebruikt in de "Bron" kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

"meta": {
    "extension": [ {
        "url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
        "valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
    } ]
}

Alternatief: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient). Elke patient heeft een Patient.managingOrganization en in de gerefereerde Organization.identifier staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* Zib AdministrationAgreement AdministrationAgreement
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
Constraints: ext-1
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
Constraints: ext-1
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
Constraints: ext-1
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
Constraints: ext-1
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
Constraints: ext-1
..... extension 0..0 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] Content/Rules for all slices
...... 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
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
.... modifierExtension:stopType ?! 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
Constraints: ext-1
..... extension 0..0 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] Content/Rules for all slices
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required): StopType
.... modifierExtension:repeatPeriodCyclicalSchedule ?! 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
Constraints: ext-1
... category S 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
... Slices for medicationReference Content/Rules for all slices
.... medicationReference:medicationReference SΣ 1..1 Reference(Medication) MedicineForAdministrationAgreement
..... display SΣ 0..1 string Text alternative for the resource
... dosageInstruction 0..* Zib InstructionsForUse InstructionsForUse
.... text SΣ 0..1 string Description
.... Slices for asNeededCodeableConcept Content/Rules for all slices
..... asNeededCodeableConcept:asNeededCodeableConcept Σ 0..1 CodeableConcept AsNeeded
Binding: ZonodigCriteriumCodelijst (extensible): ZonodigCriteriumCodelijst
.... route Σ 0..1 CodeableConcept RouteOfAdministration
Binding: MedicatieToedieningswegCodelijst (extensible): ToedieningswegCodelijst
Example Example of RouteOfAdministration: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.4.9","code":"oraal","display":"Oraal"}]}
..... text SΣ 0..1 string Plain text representation of the concept
.... Slices for dose[x] Σ 0..1 Dose
Slice: Unordered, Open by type:$this
..... doseRange Range
..... doseQuantity Quantity(SimpleQuantity)
..... dose[x]:doseQuantity ΣC 0..1 SimpleQuantity A fixed quantity (no comparator)
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
Constraints: qty-3, sqty-1
..... dose[x]:doseRange Σ 0..1 Range Amount of medication per dose

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.extension:additionalInformation.​value[x]:valueCodeableConcept Base extensible ToedieningsafspraakAanvullendeInformatieCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.modifierExtension:stopType.​value[x]:valueCodeableConcept Base required Stoptype 📦2016-06-17T10:13:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.status Base required MedicationDispenseStatus 📦3.0.2 FHIR Std.
MedicationDispense.category Base preferred MedicationDispenseCategory 📦3.0.2 FHIR Std.
MedicationDispense.dosageInstruction.​asNeededCodeableConcept:asNeededCodeableConcept Base extensible ZonodigCriteriumCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​route Base extensible MedicatieToedieningswegCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​dose[x]:doseQuantity Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3

Constraints

Id Grade Path(s) Description Expression
dom-1 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense 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()
dom-4 error MedicationDispense 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error MedicationDispense.extension:authoredOn, MedicationDispense.extension:agreementReason, MedicationDispense.extension:periodOfUse, MedicationDispense.extension:usageDuration, MedicationDispense.extension:additionalInformation, MedicationDispense.extension:medicationTreatment, MedicationDispense.modifierExtension:stopType, MedicationDispense.modifierExtension:repeatPeriodCyclicalSchedule Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3 error MedicationDispense.dosageInstruction.dose[x]:doseQuantity If a code for the unit is present, the system SHALL also be present code.empty() or system.exists()
sqty-1 error MedicationDispense.dosageInstruction.dose[x]:doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from Zib AdministrationAgreement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* Zib AdministrationAgreement AdministrationAgreement
... category S 1..1 CodeableConcept Type of medication dispense
... medicationReference S 1..1 Reference(Medication) MedicineForAdministrationAgreement
.... display S 0..1 string Text alternative for the resource
... dosageInstruction
.... text S 0..1 string Description
.... route
..... text S 0..1 string Plain text representation of the concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* Zib AdministrationAgreement 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 Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
Constraints: ext-1
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
Constraints: ext-1
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
Constraints: ext-1
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
Constraints: ext-1
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
Constraints: ext-1
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..0 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] Content/Rules for all slices
...... 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
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
.... modifierExtension:stopType ?! 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
Constraints: ext-1
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..0 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] Content/Rules for all slices
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required): StopType
.... modifierExtension:repeatPeriodCyclicalSchedule ?! 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
Constraints: ext-1
... 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 S 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 medicationReference Content/Rules for all slices
.... medicationReference:medicationReference SΣ 1..1 Reference(Medication) MedicineForAdministrationAgreement
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... 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 SΣ 0..1 string Text alternative for the resource
... 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 Additional Content defined by implementations
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
Constraints: ext-1
..... 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 (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 InstructionsForUse
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... sequence Σ 0..1 integer SequenceNumber
.... text SΣ 0..1 string Description
.... additionalInstruction Σ 0..* CodeableConcept AdditionalInstructions
Binding: Aanvullende gebruiksinstructie (extensible): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Zib AdministrationSchedule AdministeringSchedule
.... Slices for asNeededCodeableConcept Content/Rules for all slices
..... asNeededCodeableConcept:asNeededCodeableConcept Σ 0..1 CodeableConcept AsNeeded
Binding: ZonodigCriteriumCodelijst (extensible): ZonodigCriteriumCodelijst
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route Σ 0..1 CodeableConcept RouteOfAdministration
Binding: MedicatieToedieningswegCodelijst (extensible): ToedieningswegCodelijst
Example Example of RouteOfAdministration: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.4.9","code":"oraal","display":"Oraal"}]}
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMED CT Administration Method Codes (example): A coded concept describing the technique by which the medicine is administered.
.... Slices for dose[x] Σ 0..1 Dose
Slice: Unordered, Open by type:$this
..... doseRange Range
..... doseQuantity Quantity(SimpleQuantity)
..... dose[x]:doseQuantity ΣC 0..1 SimpleQuantity A fixed quantity (no comparator)
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
Constraints: qty-3, sqty-1
..... dose[x]:doseRange Σ 0..1 Range Amount of medication per dose
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... low ΣC 0..1 SimpleQuantity Low limit
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
...... high ΣC 0..1 SimpleQuantity High limit
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
.... maxDosePerPeriod Σ 0..1 Ratio MaximumDose
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... numerator Σ 0..1 Quantity Numerator value
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
..... denominator Σ 0..1 Quantity Denominator value
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient
.... rate[x] Σ 0..1 AdministeringSpeed
..... rateRatio Ratio
..... rateRange Range
..... rateQuantity Quantity(SimpleQuantity)
... 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 (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 (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

Path Status Usage ValueSet Version Source
MedicationDispense.language Base extensible Common Languages 📦3.0.2 FHIR Std.
MedicationDispense.extension:additionalInformation.​value[x]:valueCodeableConcept Base extensible ToedieningsafspraakAanvullendeInformatieCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.modifierExtension:stopType.​value[x]:valueCodeableConcept Base required Stoptype 📦2016-06-17T10:13:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.status Base required MedicationDispenseStatus 📦3.0.2 FHIR Std.
MedicationDispense.category Base preferred MedicationDispenseCategory 📦3.0.2 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦2014-03-26 FHIR Std.
MedicationDispense.dosageInstruction.​additionalInstruction Base extensible Aanvullende gebruiksinstructie 📦2016-04-07T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​asNeededCodeableConcept:asNeededCodeableConcept Base extensible ZonodigCriteriumCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📦3.0.2 FHIR Std.
MedicationDispense.dosageInstruction.​route Base extensible MedicatieToedieningswegCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📦3.0.2 FHIR Std.
MedicationDispense.dosageInstruction.​dose[x]:doseQuantity Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​dose[x]:doseRange.low Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​dose[x]:doseRange.high Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​maxDosePerPeriod.numerator Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦2014-03-26 FHIR Std.
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦2014-03-26 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense 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()
dom-4 error MedicationDispense 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error MedicationDispense.extension:authoredOn, MedicationDispense.extension:agreementReason, MedicationDispense.extension:periodOfUse, MedicationDispense.extension:usageDuration, MedicationDispense.extension:additionalInformation, MedicationDispense.extension:medicationTreatment, MedicationDispense.modifierExtension:stopType, MedicationDispense.modifierExtension:repeatPeriodCyclicalSchedule, MedicationDispense.performer.actor.extension:practitionerRole Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3 error MedicationDispense.dosageInstruction.dose[x]:doseQuantity If a code for the unit is present, the system SHALL also be present code.empty() or system.exists()
sqty-1 error MedicationDispense.dosageInstruction.dose[x]:doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from Zib AdministrationAgreement

Summary

Must-Support: 5 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* Zib AdministrationAgreement AdministrationAgreement
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
Constraints: ext-1
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
Constraints: ext-1
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
Constraints: ext-1
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
Constraints: ext-1
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
Constraints: ext-1
..... extension 0..0 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] Content/Rules for all slices
...... 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
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
.... modifierExtension:stopType ?! 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
Constraints: ext-1
..... extension 0..0 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] Content/Rules for all slices
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required): StopType
.... modifierExtension:repeatPeriodCyclicalSchedule ?! 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
Constraints: ext-1
... category S 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
... Slices for medicationReference Content/Rules for all slices
.... medicationReference:medicationReference SΣ 1..1 Reference(Medication) MedicineForAdministrationAgreement
..... display SΣ 0..1 string Text alternative for the resource
... dosageInstruction 0..* Zib InstructionsForUse InstructionsForUse
.... text SΣ 0..1 string Description
.... Slices for asNeededCodeableConcept Content/Rules for all slices
..... asNeededCodeableConcept:asNeededCodeableConcept Σ 0..1 CodeableConcept AsNeeded
Binding: ZonodigCriteriumCodelijst (extensible): ZonodigCriteriumCodelijst
.... route Σ 0..1 CodeableConcept RouteOfAdministration
Binding: MedicatieToedieningswegCodelijst (extensible): ToedieningswegCodelijst
Example Example of RouteOfAdministration: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.4.9","code":"oraal","display":"Oraal"}]}
..... text SΣ 0..1 string Plain text representation of the concept
.... Slices for dose[x] Σ 0..1 Dose
Slice: Unordered, Open by type:$this
..... doseRange Range
..... doseQuantity Quantity(SimpleQuantity)
..... dose[x]:doseQuantity ΣC 0..1 SimpleQuantity A fixed quantity (no comparator)
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
Constraints: qty-3, sqty-1
..... dose[x]:doseRange Σ 0..1 Range Amount of medication per dose

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.extension:additionalInformation.​value[x]:valueCodeableConcept Base extensible ToedieningsafspraakAanvullendeInformatieCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.modifierExtension:stopType.​value[x]:valueCodeableConcept Base required Stoptype 📦2016-06-17T10:13:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.status Base required MedicationDispenseStatus 📦3.0.2 FHIR Std.
MedicationDispense.category Base preferred MedicationDispenseCategory 📦3.0.2 FHIR Std.
MedicationDispense.dosageInstruction.​asNeededCodeableConcept:asNeededCodeableConcept Base extensible ZonodigCriteriumCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​route Base extensible MedicatieToedieningswegCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​dose[x]:doseQuantity Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3

Constraints

Id Grade Path(s) Description Expression
dom-1 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense 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()
dom-4 error MedicationDispense 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error MedicationDispense.extension:authoredOn, MedicationDispense.extension:agreementReason, MedicationDispense.extension:periodOfUse, MedicationDispense.extension:usageDuration, MedicationDispense.extension:additionalInformation, MedicationDispense.extension:medicationTreatment, MedicationDispense.modifierExtension:stopType, MedicationDispense.modifierExtension:repeatPeriodCyclicalSchedule Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3 error MedicationDispense.dosageInstruction.dose[x]:doseQuantity If a code for the unit is present, the system SHALL also be present code.empty() or system.exists()
sqty-1 error MedicationDispense.dosageInstruction.dose[x]:doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

Differential View

This structure is derived from Zib AdministrationAgreement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* Zib AdministrationAgreement AdministrationAgreement
... category S 1..1 CodeableConcept Type of medication dispense
... medicationReference S 1..1 Reference(Medication) MedicineForAdministrationAgreement
.... display S 0..1 string Text alternative for the resource
... dosageInstruction
.... text S 0..1 string Description
.... route
..... text S 0..1 string Plain text representation of the concept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* Zib AdministrationAgreement 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 Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... extension:authoredOn 0..1 dateTime AdministrationAgreementDateTime
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn
Constraints: ext-1
.... extension:agreementReason 0..1 string AgreementReason
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason
Constraints: ext-1
.... extension:periodOfUse 0..* Period PeriodOfUse
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse
Constraints: ext-1
.... extension:usageDuration 0..1 Duration Duration
URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration
Constraints: ext-1
.... extension:additionalInformation 0..1 (Complex) AdministrationAgreementAdditionalInformation
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation
Constraints: ext-1
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..0 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] Content/Rules for all slices
...... 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
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
.... modifierExtension:stopType ?! 0..1 (Complex) AdministrationAgreementStopType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType
Constraints: ext-1
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..0 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] Content/Rules for all slices
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: Stoptype (required): StopType
.... modifierExtension:repeatPeriodCyclicalSchedule ?! 0..1 Duration RepeatPeriodCyclicalSchedule
URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule
Constraints: ext-1
... 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 S 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 medicationReference Content/Rules for all slices
.... medicationReference:medicationReference SΣ 1..1 Reference(Medication) MedicineForAdministrationAgreement
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... 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 SΣ 0..1 string Text alternative for the resource
... 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 Additional Content defined by implementations
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
Constraints: ext-1
..... 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 (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 InstructionsForUse
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... sequence Σ 0..1 integer SequenceNumber
.... text SΣ 0..1 string Description
.... additionalInstruction Σ 0..* CodeableConcept AdditionalInstructions
Binding: Aanvullende gebruiksinstructie (extensible): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Zib AdministrationSchedule AdministeringSchedule
.... Slices for asNeededCodeableConcept Content/Rules for all slices
..... asNeededCodeableConcept:asNeededCodeableConcept Σ 0..1 CodeableConcept AsNeeded
Binding: ZonodigCriteriumCodelijst (extensible): ZonodigCriteriumCodelijst
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route Σ 0..1 CodeableConcept RouteOfAdministration
Binding: MedicatieToedieningswegCodelijst (extensible): ToedieningswegCodelijst
Example Example of RouteOfAdministration: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.4.9","code":"oraal","display":"Oraal"}]}
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMED CT Administration Method Codes (example): A coded concept describing the technique by which the medicine is administered.
.... Slices for dose[x] Σ 0..1 Dose
Slice: Unordered, Open by type:$this
..... doseRange Range
..... doseQuantity Quantity(SimpleQuantity)
..... dose[x]:doseQuantity ΣC 0..1 SimpleQuantity A fixed quantity (no comparator)
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
Constraints: qty-3, sqty-1
..... dose[x]:doseRange Σ 0..1 Range Amount of medication per dose
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... low ΣC 0..1 SimpleQuantity Low limit
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
...... high ΣC 0..1 SimpleQuantity High limit
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
.... maxDosePerPeriod Σ 0..1 Ratio MaximumDose
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... numerator Σ 0..1 Quantity Numerator value
Binding: G-Standaard Eenhedentabel (required): GstdTabel902
..... denominator Σ 0..1 Quantity Denominator value
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient
.... rate[x] Σ 0..1 AdministeringSpeed
..... rateRatio Ratio
..... rateRange Range
..... rateQuantity Quantity(SimpleQuantity)
... 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 (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 (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

Path Status Usage ValueSet Version Source
MedicationDispense.language Base extensible Common Languages 📦3.0.2 FHIR Std.
MedicationDispense.extension:additionalInformation.​value[x]:valueCodeableConcept Base extensible ToedieningsafspraakAanvullendeInformatieCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.modifierExtension:stopType.​value[x]:valueCodeableConcept Base required Stoptype 📦2016-06-17T10:13:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.status Base required MedicationDispenseStatus 📦3.0.2 FHIR Std.
MedicationDispense.category Base preferred MedicationDispenseCategory 📦3.0.2 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦2014-03-26 FHIR Std.
MedicationDispense.dosageInstruction.​additionalInstruction Base extensible Aanvullende gebruiksinstructie 📦2016-04-07T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​asNeededCodeableConcept:asNeededCodeableConcept Base extensible ZonodigCriteriumCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📦3.0.2 FHIR Std.
MedicationDispense.dosageInstruction.​route Base extensible MedicatieToedieningswegCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📦3.0.2 FHIR Std.
MedicationDispense.dosageInstruction.​dose[x]:doseQuantity Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​dose[x]:doseRange.low Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​dose[x]:doseRange.high Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.dosageInstruction.​maxDosePerPeriod.numerator Base required G-Standaard Eenhedentabel 📦2016-08-30T20:24:53 Nictiz FHIR NL STU3 Zib2017 v2.3
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦2014-03-26 FHIR Std.
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦2014-03-26 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense 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()
dom-4 error MedicationDispense 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error MedicationDispense.extension:authoredOn, MedicationDispense.extension:agreementReason, MedicationDispense.extension:periodOfUse, MedicationDispense.extension:usageDuration, MedicationDispense.extension:additionalInformation, MedicationDispense.extension:medicationTreatment, MedicationDispense.modifierExtension:stopType, MedicationDispense.modifierExtension:repeatPeriodCyclicalSchedule, MedicationDispense.performer.actor.extension:practitionerRole Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3 error MedicationDispense.dosageInstruction.dose[x]:doseQuantity If a code for the unit is present, the system SHALL also be present code.empty() or system.exists()
sqty-1 error MedicationDispense.dosageInstruction.dose[x]:doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from Zib AdministrationAgreement

Summary

Must-Support: 5 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron