Official URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-dispense | Version: 1.0.5-ballot.1 | |||
Draft as of 2025-02-14 | Computable Name: EPAMedicationDispense |
Defines the medication dispense resource for the Medication Service in the ePA system.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label mdd-1: whenHandedOver cannot be before whenPrepared |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | RxPrescriptionProcessIdentifier | Extension URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
0..* | Identifier | External identifier Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
0..1 | RxOriginatorProcessIdentifier | External identifier ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of medication dispense Binding: EPA Medication Dispense ValueSet (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Missing value indicates a prescription dispense. Binding: EPAMedicationDispenseCategoryVS (required): Defines the context of a Dispensation: prescription or non-prescription ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Medication) | What medication was supplied ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Who the dispense is for ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierKvid10 | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Who performed event ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
C | 1..1 | Reference(Organization | PractitionerRole) | Individual who was performing ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
C | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | dateTime | When product was given out ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Dosage | Hier werden Informationen zur Dosierung angegeben. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Hier kann die Dosieranweisung in Form eines Freitextes abgebildet werden. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | boolean | Whether a substitution was or was not performed on the dispense ele-1: All FHIR elements must have a @value or children | |
![]() |
Path | Conformance | ValueSet | URI |
MedicationDispense.status | required | EPAMedicationDispenseStatusVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-status-vs | |
MedicationDispense.category | required | EPAMedicationDispenseCategoryVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-category-vs |
Id | Grade | Path(s) | Details | Requirements |
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** elements | 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 | |
ref-1 | error | MedicationDispense.subject, MedicationDispense.performer.actor, MedicationDispense.authorizingPrescription | SHALL 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
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MedicationDispense | Dispensing a medication to a named patient | |
![]() ![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
S | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | RxPrescriptionProcessIdentifier | Extension URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension | |
![]() ![]() ![]() |
0..* | Identifier | External identifier Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
0..1 | RxOriginatorProcessIdentifier | External identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier | |
![]() ![]() ![]() |
1..1 | code | Status of medication dispense Binding: EPA Medication Dispense ValueSet (required) | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Missing value indicates a prescription dispense. Binding: EPAMedicationDispenseCategoryVS (required): Defines the context of a Dispensation: prescription or non-prescription |
![]() ![]() ![]() |
S | 1..1 | Reference(Medication) | What medication was supplied |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Who the dispense is for |
![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierKvid10 | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization | PractitionerRole) | Individual who was performing | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
S | 1..1 | dateTime | When product was given out |
![]() ![]() ![]() |
S | 0..* | Dosage | Hier werden Informationen zur Dosierung angegeben. |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Hier kann die Dosieranweisung in Form eines Freitextes abgebildet werden. |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
![]() |
Path | Conformance | ValueSet | URI |
MedicationDispense.status | required | EPAMedicationDispenseStatusVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-status-vs | |
MedicationDispense.category | required | EPAMedicationDispenseCategoryVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-category-vs |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
0..1 | RxPrescriptionProcessIdentifier | Extension URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension | |||||
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
0..* | Identifier | External identifier Slice: Unordered, Open by pattern:$this | |||||
![]() ![]() ![]() ![]() |
0..1 | RxOriginatorProcessIdentifier | External identifier Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
C | 0..* | Reference(Procedure) | Event that dispense is part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of medication dispense Binding: EPA Medication Dispense ValueSet (required) | ||||
![]() ![]() ![]() |
0..1 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(DetectedIssue) | |||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Missing value indicates a prescription dispense. Binding: EPAMedicationDispenseCategoryVS (required): Defines the context of a Dispensation: prescription or non-prescription | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Medication) | What medication was supplied | ||||
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Who the dispense is for ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierKvid10 | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
C | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Resource) | Information that supports the dispensing of the medication ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Who performed event | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | Reference(Organization | PractitionerRole) | Individual who was performing ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..1 | Reference(Location) | Where the dispense occurred ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Amount dispensed qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When product was packaged and reviewed | ||||
![]() ![]() ![]() |
S | 1..1 | dateTime | When product was given out | ||||
![]() ![]() ![]() |
C | 0..1 | Reference(Location) | Where the medication was sent ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Patient | Practitioner) | Who collected the medication ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
0..* | Annotation | Information about the dispense | |||||
![]() ![]() ![]() |
S | 0..* | Dosage | Hier werden Informationen zur Dosierung angegeben. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Hier kann die Dosieranweisung in Form eines Freitextes abgebildet werden. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | |||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Element | Amount of medication administered | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per dose | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Ratio | Upper limit on medication per unit of time rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | SimpleQuantity | Upper limit on medication per administration qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(DetectedIssue) | Clinical issue with action ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Provenance) | A list of relevant lifecycle events ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationDispense.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationDispense.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationDispense.status | required | EPAMedicationDispenseStatusVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-status-vs | ||||
MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason from the FHIR Standard | ||||
MedicationDispense.category | required | EPAMedicationDispenseCategoryVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-category-vs | ||||
MedicationDispense.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-function from the FHIR Standard | ||||
MedicationDispense.authorizingPrescription.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard | ||||
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
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** elements | 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.quantity, MedicationDispense.daysSupply, MedicationDispense.dosageInstruction.maxDosePerAdministration, MedicationDispense.dosageInstruction.maxDosePerLifetime | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
rat-1 | error | MedicationDispense.dosageInstruction.maxDosePerPeriod | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
ref-1 | error | MedicationDispense.partOf, MedicationDispense.subject, MedicationDispense.context, MedicationDispense.supportingInformation, MedicationDispense.performer.actor, MedicationDispense.location, MedicationDispense.authorizingPrescription, MedicationDispense.destination, MedicationDispense.receiver, MedicationDispense.substitution.responsibleParty, MedicationDispense.detectedIssue, MedicationDispense.eventHistory | SHALL 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-1 | error | MedicationDispense.quantity, MedicationDispense.daysSupply, MedicationDispense.dosageInstruction.maxDosePerAdministration, MedicationDispense.dosageInstruction.maxDosePerLifetime | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from MedicationDispense
Summary
Mandatory: 4 elements(2 nested mandatory elements)
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:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label mdd-1: whenHandedOver cannot be before whenPrepared |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | RxPrescriptionProcessIdentifier | Extension URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
0..* | Identifier | External identifier Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
0..1 | RxOriginatorProcessIdentifier | External identifier ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of medication dispense Binding: EPA Medication Dispense ValueSet (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Missing value indicates a prescription dispense. Binding: EPAMedicationDispenseCategoryVS (required): Defines the context of a Dispensation: prescription or non-prescription ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Medication) | What medication was supplied ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Who the dispense is for ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierKvid10 | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Who performed event ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
C | 1..1 | Reference(Organization | PractitionerRole) | Individual who was performing ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
C | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | dateTime | When product was given out ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Dosage | Hier werden Informationen zur Dosierung angegeben. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Hier kann die Dosieranweisung in Form eines Freitextes abgebildet werden. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | boolean | Whether a substitution was or was not performed on the dispense ele-1: All FHIR elements must have a @value or children | |
![]() |
Path | Conformance | ValueSet | URI |
MedicationDispense.status | required | EPAMedicationDispenseStatusVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-status-vs | |
MedicationDispense.category | required | EPAMedicationDispenseCategoryVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-category-vs |
Id | Grade | Path(s) | Details | Requirements |
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** elements | 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 | |
ref-1 | error | MedicationDispense.subject, MedicationDispense.performer.actor, MedicationDispense.authorizingPrescription | SHALL 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
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MedicationDispense | Dispensing a medication to a named patient | |
![]() ![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
S | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | RxPrescriptionProcessIdentifier | Extension URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension | |
![]() ![]() ![]() |
0..* | Identifier | External identifier Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
0..1 | RxOriginatorProcessIdentifier | External identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier | |
![]() ![]() ![]() |
1..1 | code | Status of medication dispense Binding: EPA Medication Dispense ValueSet (required) | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Missing value indicates a prescription dispense. Binding: EPAMedicationDispenseCategoryVS (required): Defines the context of a Dispensation: prescription or non-prescription |
![]() ![]() ![]() |
S | 1..1 | Reference(Medication) | What medication was supplied |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Who the dispense is for |
![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierKvid10 | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization | PractitionerRole) | Individual who was performing | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
S | 1..1 | dateTime | When product was given out |
![]() ![]() ![]() |
S | 0..* | Dosage | Hier werden Informationen zur Dosierung angegeben. |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Hier kann die Dosieranweisung in Form eines Freitextes abgebildet werden. |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
![]() |
Path | Conformance | ValueSet | URI |
MedicationDispense.status | required | EPAMedicationDispenseStatusVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-status-vs | |
MedicationDispense.category | required | EPAMedicationDispenseCategoryVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-category-vs |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
0..1 | RxPrescriptionProcessIdentifier | Extension URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension | |||||
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
0..* | Identifier | External identifier Slice: Unordered, Open by pattern:$this | |||||
![]() ![]() ![]() ![]() |
0..1 | RxOriginatorProcessIdentifier | External identifier Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
C | 0..* | Reference(Procedure) | Event that dispense is part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of medication dispense Binding: EPA Medication Dispense ValueSet (required) | ||||
![]() ![]() ![]() |
0..1 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(DetectedIssue) | |||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Missing value indicates a prescription dispense. Binding: EPAMedicationDispenseCategoryVS (required): Defines the context of a Dispensation: prescription or non-prescription | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Medication) | What medication was supplied | ||||
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Who the dispense is for ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierKvid10 | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
C | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Resource) | Information that supports the dispensing of the medication ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Who performed event | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | Reference(Organization | PractitionerRole) | Individual who was performing ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..1 | Reference(Location) | Where the dispense occurred ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Amount dispensed qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When product was packaged and reviewed | ||||
![]() ![]() ![]() |
S | 1..1 | dateTime | When product was given out | ||||
![]() ![]() ![]() |
C | 0..1 | Reference(Location) | Where the medication was sent ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Patient | Practitioner) | Who collected the medication ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
0..* | Annotation | Information about the dispense | |||||
![]() ![]() ![]() |
S | 0..* | Dosage | Hier werden Informationen zur Dosierung angegeben. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Hier kann die Dosieranweisung in Form eines Freitextes abgebildet werden. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | |||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Element | Amount of medication administered | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per dose | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Ratio | Upper limit on medication per unit of time rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | SimpleQuantity | Upper limit on medication per administration qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(DetectedIssue) | Clinical issue with action ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Provenance) | A list of relevant lifecycle events ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationDispense.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationDispense.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationDispense.status | required | EPAMedicationDispenseStatusVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-status-vs | ||||
MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason from the FHIR Standard | ||||
MedicationDispense.category | required | EPAMedicationDispenseCategoryVShttps://gematik.de/fhir/terminology/ValueSet/epa-medication-dispense-category-vs | ||||
MedicationDispense.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-function from the FHIR Standard | ||||
MedicationDispense.authorizingPrescription.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard | ||||
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
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** elements | 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.quantity, MedicationDispense.daysSupply, MedicationDispense.dosageInstruction.maxDosePerAdministration, MedicationDispense.dosageInstruction.maxDosePerLifetime | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
rat-1 | error | MedicationDispense.dosageInstruction.maxDosePerPeriod | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
ref-1 | error | MedicationDispense.partOf, MedicationDispense.subject, MedicationDispense.context, MedicationDispense.supportingInformation, MedicationDispense.performer.actor, MedicationDispense.location, MedicationDispense.authorizingPrescription, MedicationDispense.destination, MedicationDispense.receiver, MedicationDispense.substitution.responsibleParty, MedicationDispense.detectedIssue, MedicationDispense.eventHistory | SHALL 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-1 | error | MedicationDispense.quantity, MedicationDispense.daysSupply, MedicationDispense.dosageInstruction.maxDosePerAdministration, MedicationDispense.dosageInstruction.maxDosePerLifetime | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from MedicationDispense
Summary
Mandatory: 4 elements(2 nested mandatory elements)
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:
Other representations of profile: CSV, Excel, Schematron