Cumuluz Translate Implementation Guide
0.1.0 - ci-build

Cumuluz Translate Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: XIB Medication Administration Agreement / Dispense

Official URL: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationDispense Version: 0.1.0
Draft as of 2026-07-11 Computable Name: XibMedicationDispense

XIB medication dispense target profile for implemented dispense and Dutch administration-agreement data points.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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.

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:agreementReason S 0..1 CodeableConcept XIB Administration Agreement Reason
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-AdministrationAgreementReason
.... extension:periodOfUse S 0..1 Period XIB Medication Period Of Use
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPeriodOfUse
.... extension:usageDuration S 0..1 Duration XIB Medication Use Duration
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationUseDuration
.... extension:additionalInformation S 0..1 CodeableConcept XIB Medication Additional Information
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationAdditionalInformation
.... extension:medicationTreatment S 0..1 Identifier XIB Medication Treatment
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationTreatment
.... extension:stopType S 0..1 CodeableConcept XIB Medication Stop Type
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationStopType
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... medication[x] SΣ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 0..1 Reference(Patient | Group) Who the dispense is for
... performer S 0..* BackboneElement Who performed event
.... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
..... extension:performerOnBehalfOf 0..1 Reference(Organization) XIB Medication Performer On Behalf Of
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPerformerOnBehalfOf
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was performing
... dosageInstruction S 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... Slices voor extension Content/regels voor alle slices
..... extension:dosageDetails 0..1 (Complex) XIB Medication Dosage Details
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationDosageDetails
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constrains

Id Grade Pad(en) Omschrijving Expressie
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 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()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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

This structure is derived from MedicationDispense

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:agreementReason S 0..1 CodeableConcept XIB Administration Agreement Reason
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-AdministrationAgreementReason
.... extension:periodOfUse S 0..1 Period XIB Medication Period Of Use
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPeriodOfUse
.... extension:usageDuration S 0..1 Duration XIB Medication Use Duration
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationUseDuration
.... extension:additionalInformation S 0..1 CodeableConcept XIB Medication Additional Information
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationAdditionalInformation
.... extension:medicationTreatment S 0..1 Identifier XIB Medication Treatment
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationTreatment
.... extension:stopType S 0..1 CodeableConcept XIB Medication Stop Type
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationStopType
... status S 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
... medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was supplied
... performer S 0..* BackboneElement Who performed event
.... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
..... extension:performerOnBehalfOf 0..1 Reference(Organization) XIB Medication Performer On Behalf Of
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPerformerOnBehalfOf
... dosageInstruction S 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... Slices voor extension Content/regels voor alle slices
..... extension:dosageDetails 0..1 (Complex) XIB Medication Dosage Details
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationDosageDetails

doco Documentatie voor dit formaat
NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
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: CommonLanguages (preferred): A human language.
Additionele bindingsDoel
AllLanguages 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 voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:agreementReason S 0..1 CodeableConcept XIB Administration Agreement Reason
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-AdministrationAgreementReason
.... extension:periodOfUse S 0..1 Period XIB Medication Period Of Use
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPeriodOfUse
.... extension:usageDuration S 0..1 Duration XIB Medication Use Duration
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationUseDuration
.... extension:additionalInformation S 0..1 CodeableConcept XIB Medication Additional Information
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationAdditionalInformation
.... extension:medicationTreatment S 0..1 Identifier XIB Medication Treatment
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationTreatment
.... extension:stopType S 0..1 CodeableConcept XIB Medication Stop Type
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationStopType
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!SΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
... statusReason[x] 0..1 Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
.... statusReasonCodeableConcept CodeableConcept
.... statusReasonReference Reference(DetectedIssue)
... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... medication[x] SΣ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 0..1 Reference(Patient | Group) Who the dispense is for
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
..... extension:performerOnBehalfOf 0..1 Reference(Organization) XIB Medication Performer On Behalf Of
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPerformerOnBehalfOf
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function 0..1 CodeableConcept Who performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.
.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was performing
... location 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
... 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(4.0.1) Amount dispensed
... daysSupply 0..1 SimpleQuantity(4.0.1) 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 Information about the dispense
... dosageInstruction S 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... id 0..1 string Unique id for inter-element referencing
.... Slices voor extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
..... extension:dosageDetails 0..1 (Complex) XIB Medication Dosage Details
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationDosageDetails
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): 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 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 | PractitionerRole) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.2
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.2
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.2

Constrains

Id Grade Pad(en) Omschrijving Expressie
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 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()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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

Key Elements View

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:agreementReason S 0..1 CodeableConcept XIB Administration Agreement Reason
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-AdministrationAgreementReason
.... extension:periodOfUse S 0..1 Period XIB Medication Period Of Use
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPeriodOfUse
.... extension:usageDuration S 0..1 Duration XIB Medication Use Duration
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationUseDuration
.... extension:additionalInformation S 0..1 CodeableConcept XIB Medication Additional Information
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationAdditionalInformation
.... extension:medicationTreatment S 0..1 Identifier XIB Medication Treatment
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationTreatment
.... extension:stopType S 0..1 CodeableConcept XIB Medication Stop Type
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationStopType
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... medication[x] SΣ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 0..1 Reference(Patient | Group) Who the dispense is for
... performer S 0..* BackboneElement Who performed event
.... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
..... extension:performerOnBehalfOf 0..1 Reference(Organization) XIB Medication Performer On Behalf Of
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPerformerOnBehalfOf
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was performing
... dosageInstruction S 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... Slices voor extension Content/regels voor alle slices
..... extension:dosageDetails 0..1 (Complex) XIB Medication Dosage Details
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationDosageDetails
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constrains

Id Grade Pad(en) Omschrijving Expressie
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 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()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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

Differential View

This structure is derived from MedicationDispense

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:agreementReason S 0..1 CodeableConcept XIB Administration Agreement Reason
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-AdministrationAgreementReason
.... extension:periodOfUse S 0..1 Period XIB Medication Period Of Use
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPeriodOfUse
.... extension:usageDuration S 0..1 Duration XIB Medication Use Duration
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationUseDuration
.... extension:additionalInformation S 0..1 CodeableConcept XIB Medication Additional Information
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationAdditionalInformation
.... extension:medicationTreatment S 0..1 Identifier XIB Medication Treatment
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationTreatment
.... extension:stopType S 0..1 CodeableConcept XIB Medication Stop Type
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationStopType
... status S 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
... medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was supplied
... performer S 0..* BackboneElement Who performed event
.... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
..... extension:performerOnBehalfOf 0..1 Reference(Organization) XIB Medication Performer On Behalf Of
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPerformerOnBehalfOf
... dosageInstruction S 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... Slices voor extension Content/regels voor alle slices
..... extension:dosageDetails 0..1 (Complex) XIB Medication Dosage Details
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationDosageDetails

doco Documentatie voor dit formaat

Snapshot View

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
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: CommonLanguages (preferred): A human language.
Additionele bindingsDoel
AllLanguages 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 voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:agreementReason S 0..1 CodeableConcept XIB Administration Agreement Reason
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-AdministrationAgreementReason
.... extension:periodOfUse S 0..1 Period XIB Medication Period Of Use
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPeriodOfUse
.... extension:usageDuration S 0..1 Duration XIB Medication Use Duration
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationUseDuration
.... extension:additionalInformation S 0..1 CodeableConcept XIB Medication Additional Information
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationAdditionalInformation
.... extension:medicationTreatment S 0..1 Identifier XIB Medication Treatment
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationTreatment
.... extension:stopType S 0..1 CodeableConcept XIB Medication Stop Type
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationStopType
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!SΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
... statusReason[x] 0..1 Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
.... statusReasonCodeableConcept CodeableConcept
.... statusReasonReference Reference(DetectedIssue)
... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... medication[x] SΣ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject SΣ 0..1 Reference(Patient | Group) Who the dispense is for
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
..... extension:performerOnBehalfOf 0..1 Reference(Organization) XIB Medication Performer On Behalf Of
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationPerformerOnBehalfOf
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function 0..1 CodeableConcept Who performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.
.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was performing
... location 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
... 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(4.0.1) Amount dispensed
... daysSupply 0..1 SimpleQuantity(4.0.1) 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 Information about the dispense
... dosageInstruction S 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... id 0..1 string Unique id for inter-element referencing
.... Slices voor extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
..... extension:dosageDetails 0..1 (Complex) XIB Medication Dosage Details
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-MedicationDosageDetails
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): 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 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 | PractitionerRole) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.2
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.2
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.2

Constrains

Id Grade Pad(en) Omschrijving Expressie
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 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()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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

 

Other representations of profile: CSV, Excel, Schematron