Implementation Guide
ePA Medication Service
Version 1.2.0-ballot.1 - draft

Resource Profile: EPA MedicationDispense

Official URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-dispense Version: 1.2.0-ballot.1
Draft as of 2025-08-01 Computable Name: EPAMedicationDispense

Defines the medication dispense resource for the Medication Service in the ePA system.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, mdd-1
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
... Slices for identifier 0..* Identifier External identifier
Slice: Unordered, Open by pattern:$this
.... identifier:RxOriginatorProcessIdentifier 0..1 RxOriginatorProcessIdentifier External identifier

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code Status of medication dispense
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
... category S 0..1 CodeableConcept Fehlender oder nicht vorhandener Wert weist auf eine Abgabe mit Verschreibung hin.
Binding: TI Medication Dispense Category ValueSet (required): Definiert den Kontext einer Abgabe: mit oder ohne ärztliche Verschreibung.
... medication[x] SΣ 1..1 Reference(Medication) What medication was supplied
... subject SΣC 1..1 Reference(Patient) Who the dispense is for
Constraints: ref-1
.... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
... performer S 1..1 BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor C 1..1 Reference(Organization | PractitionerRole) Individual who was performing
Constraints: ref-1
... authorizingPrescription C 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
Constraints: ref-1
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... whenHandedOver S 1..1 dateTime When product was given out
... dosageInstruction S 0..* DosageDgMP Hier werden Informationen zur Dosierung angegeben.
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
From the FHIR Standard
MedicationDispense.categoryrequiredTIMedicationDispenseCategoryVS
https://gematik.de/fhir/terminology/ValueSet/ti-medication-dispense-category-vs

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
ref-1errorMedicationDispense.subject, MedicationDispense.performer.actor, MedicationDispense.authorizingPrescriptionSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
... Slices for extension Content/Rules for all slices
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
... Slices for identifier 0..* Identifier External identifier
Slice: Unordered, Open by pattern:$this
.... identifier:RxOriginatorProcessIdentifier 0..1 RxOriginatorProcessIdentifier External identifier
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
... category S 0..1 CodeableConcept Fehlender oder nicht vorhandener Wert weist auf eine Abgabe mit Verschreibung hin.
Binding: TI Medication Dispense Category ValueSet (required): Definiert den Kontext einer Abgabe: mit oder ohne ärztliche Verschreibung.
... medication[x] S 1..1 Reference(Medication) What medication was supplied
... subject S 1..1 Reference(Patient) Who the dispense is for
.... identifier S 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
... performer S 1..1 BackboneElement Who performed event
.... actor 1..1 Reference(Organization | PractitionerRole) Individual who was performing
... authorizingPrescription
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... whenHandedOver S 1..1 dateTime When product was given out
... dosageInstruction S 0..* DosageDgMP Hier werden Informationen zur Dosierung angegeben.
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationDispense.categoryrequiredTIMedicationDispenseCategoryVS
https://gematik.de/fhir/terminology/ValueSet/ti-medication-dispense-category-vs
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, mdd-1
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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.
Additional BindingsPurpose
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 for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier 0..* Identifier External identifier
Slice: Unordered, Open by pattern:$this
.... identifier:RxOriginatorProcessIdentifier 0..1 RxOriginatorProcessIdentifier External identifier

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... partOf C 0..* Reference(Procedure) Event that dispense is part of
Constraints: ref-1
... status ?!SΣ 1..1 code Status of medication dispense
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 S 0..1 CodeableConcept Fehlender oder nicht vorhandener Wert weist auf eine Abgabe mit Verschreibung hin.
Binding: TI Medication Dispense Category ValueSet (required): Definiert den Kontext einer Abgabe: mit oder ohne ärztliche Verschreibung.
... medication[x] SΣ 1..1 Reference(Medication) What medication was supplied
... subject SΣC 1..1 Reference(Patient) Who the dispense is for
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... 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
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context C 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
Constraints: ref-1
... supportingInformation C 0..* Reference(Resource) Information that supports the dispensing of the medication
Constraints: ref-1
... performer S 1..1 BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 1..1 Reference(Organization | PractitionerRole) Individual who was performing
Constraints: ref-1
... location C 0..1 Reference(Location) Where the dispense occurred
Constraints: ref-1
... authorizingPrescription C 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 C 0..1 SimpleQuantity Amount dispensed
Constraints: qty-3, sqty-1
... daysSupply C 0..1 SimpleQuantity Amount of medication expressed as a timing amount
Constraints: qty-3, sqty-1
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver S 1..1 dateTime When product was given out
... destination C 0..1 Reference(Location) Where the medication was sent
Constraints: ref-1
... receiver C 0..* Reference(Patient | Practitioner) Who collected the medication
Constraints: ref-1
... note 0..* Annotation Information about the dispense
... dosageInstruction S 0..* DosageDgMP Hier werden Informationen zur Dosierung angegeben.
... substitution S 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
Slice: Unordered, Open by value:url
.... 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 C 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
Constraints: ref-1
... detectedIssue C 0..* Reference(DetectedIssue) Clinical issue with action
Constraints: ref-1
... eventHistory C 0..* Reference(Provenance) A list of relevant lifecycle events
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
MedicationDispense.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
MedicationDispense.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
From the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
From the FHIR Standard
MedicationDispense.categoryrequiredTIMedicationDispenseCategoryVS
https://gematik.de/fhir/terminology/ValueSet/ti-medication-dispense-category-vs
MedicationDispense.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
http://hl7.org/fhir/ValueSet/medicationdispense-performer-function
From the FHIR Standard
MedicationDispense.authorizingPrescription.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3errorMedicationDispense.quantity, MedicationDispense.daysSupplyIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorMedicationDispense.partOf, MedicationDispense.subject, MedicationDispense.context, MedicationDispense.supportingInformation, MedicationDispense.performer.actor, MedicationDispense.location, MedicationDispense.authorizingPrescription, MedicationDispense.destination, MedicationDispense.receiver, MedicationDispense.substitution.responsibleParty, MedicationDispense.detectedIssue, MedicationDispense.eventHistorySHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
sqty-1errorMedicationDispense.quantity, MedicationDispense.daysSupplyThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from MedicationDispense

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, mdd-1
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
... Slices for identifier 0..* Identifier External identifier
Slice: Unordered, Open by pattern:$this
.... identifier:RxOriginatorProcessIdentifier 0..1 RxOriginatorProcessIdentifier External identifier

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code Status of medication dispense
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
... category S 0..1 CodeableConcept Fehlender oder nicht vorhandener Wert weist auf eine Abgabe mit Verschreibung hin.
Binding: TI Medication Dispense Category ValueSet (required): Definiert den Kontext einer Abgabe: mit oder ohne ärztliche Verschreibung.
... medication[x] SΣ 1..1 Reference(Medication) What medication was supplied
... subject SΣC 1..1 Reference(Patient) Who the dispense is for
Constraints: ref-1
.... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
... performer S 1..1 BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor C 1..1 Reference(Organization | PractitionerRole) Individual who was performing
Constraints: ref-1
... authorizingPrescription C 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
Constraints: ref-1
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... whenHandedOver S 1..1 dateTime When product was given out
... dosageInstruction S 0..* DosageDgMP Hier werden Informationen zur Dosierung angegeben.
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
From the FHIR Standard
MedicationDispense.categoryrequiredTIMedicationDispenseCategoryVS
https://gematik.de/fhir/terminology/ValueSet/ti-medication-dispense-category-vs

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
ref-1errorMedicationDispense.subject, MedicationDispense.performer.actor, MedicationDispense.authorizingPrescriptionSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
... Slices for extension Content/Rules for all slices
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
... Slices for identifier 0..* Identifier External identifier
Slice: Unordered, Open by pattern:$this
.... identifier:RxOriginatorProcessIdentifier 0..1 RxOriginatorProcessIdentifier External identifier
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
... category S 0..1 CodeableConcept Fehlender oder nicht vorhandener Wert weist auf eine Abgabe mit Verschreibung hin.
Binding: TI Medication Dispense Category ValueSet (required): Definiert den Kontext einer Abgabe: mit oder ohne ärztliche Verschreibung.
... medication[x] S 1..1 Reference(Medication) What medication was supplied
... subject S 1..1 Reference(Patient) Who the dispense is for
.... identifier S 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
... performer S 1..1 BackboneElement Who performed event
.... actor 1..1 Reference(Organization | PractitionerRole) Individual who was performing
... authorizingPrescription
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... whenHandedOver S 1..1 dateTime When product was given out
... dosageInstruction S 0..* DosageDgMP Hier werden Informationen zur Dosierung angegeben.
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationDispense.categoryrequiredTIMedicationDispenseCategoryVS
https://gematik.de/fhir/terminology/ValueSet/ti-medication-dispense-category-vs

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, mdd-1
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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.
Additional BindingsPurpose
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 for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier 0..* Identifier External identifier
Slice: Unordered, Open by pattern:$this
.... identifier:RxOriginatorProcessIdentifier 0..1 RxOriginatorProcessIdentifier External identifier

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... partOf C 0..* Reference(Procedure) Event that dispense is part of
Constraints: ref-1
... status ?!SΣ 1..1 code Status of medication dispense
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 S 0..1 CodeableConcept Fehlender oder nicht vorhandener Wert weist auf eine Abgabe mit Verschreibung hin.
Binding: TI Medication Dispense Category ValueSet (required): Definiert den Kontext einer Abgabe: mit oder ohne ärztliche Verschreibung.
... medication[x] SΣ 1..1 Reference(Medication) What medication was supplied
... subject SΣC 1..1 Reference(Patient) Who the dispense is for
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... 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
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context C 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
Constraints: ref-1
... supportingInformation C 0..* Reference(Resource) Information that supports the dispensing of the medication
Constraints: ref-1
... performer S 1..1 BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 1..1 Reference(Organization | PractitionerRole) Individual who was performing
Constraints: ref-1
... location C 0..1 Reference(Location) Where the dispense occurred
Constraints: ref-1
... authorizingPrescription C 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 C 0..1 SimpleQuantity Amount dispensed
Constraints: qty-3, sqty-1
... daysSupply C 0..1 SimpleQuantity Amount of medication expressed as a timing amount
Constraints: qty-3, sqty-1
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver S 1..1 dateTime When product was given out
... destination C 0..1 Reference(Location) Where the medication was sent
Constraints: ref-1
... receiver C 0..* Reference(Patient | Practitioner) Who collected the medication
Constraints: ref-1
... note 0..* Annotation Information about the dispense
... dosageInstruction S 0..* DosageDgMP Hier werden Informationen zur Dosierung angegeben.
... substitution S 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
Slice: Unordered, Open by value:url
.... 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 C 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
Constraints: ref-1
... detectedIssue C 0..* Reference(DetectedIssue) Clinical issue with action
Constraints: ref-1
... eventHistory C 0..* Reference(Provenance) A list of relevant lifecycle events
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
MedicationDispense.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
MedicationDispense.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
From the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
From the FHIR Standard
MedicationDispense.categoryrequiredTIMedicationDispenseCategoryVS
https://gematik.de/fhir/terminology/ValueSet/ti-medication-dispense-category-vs
MedicationDispense.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
http://hl7.org/fhir/ValueSet/medicationdispense-performer-function
From the FHIR Standard
MedicationDispense.authorizingPrescription.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3errorMedicationDispense.quantity, MedicationDispense.daysSupplyIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorMedicationDispense.partOf, MedicationDispense.subject, MedicationDispense.context, MedicationDispense.supportingInformation, MedicationDispense.performer.actor, MedicationDispense.location, MedicationDispense.authorizingPrescription, MedicationDispense.destination, MedicationDispense.receiver, MedicationDispense.substitution.responsibleParty, MedicationDispense.detectedIssue, MedicationDispense.eventHistorySHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
sqty-1errorMedicationDispense.quantity, MedicationDispense.daysSupplyThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from MedicationDispense

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron