This page is part of the HL7 Belgium Medication Implementation Guide (v0.2.0: Trial Use Ballot 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Defining URL: | https://www.hl7belgium.org/profiles/hl7belgium/be-medication/StructureDefinition/be-medicationdispense |
Version: | 0.2.0 |
Name: | BeMedicationDispense |
Status: | Active as of 2021-07-12T21:59:30+02:00 |
Definition: | Defines constraints and extensions on the Medication Dispense resource for a record of a dispensation in Belgium. |
Publisher: | HL7 Belgium |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://www.hl7belgium.org/profiles/hl7belgium/be-medication/StructureDefinition/be-medicationdispense
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationDispense
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 17 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | MedicationDispense | The medication dispense entry | |
![]() ![]() ![]() | S | 0..* | Identifier | External identifier Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | External identifier |
![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: dguid | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gfd-dpp.be/fhir/reference/dguid | |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): The drug code. For example CNK code for the medication |
![]() ![]() ![]() | S | 0..1 | Reference(Medication) | What medication was supplied |
![]() ![]() ![]() | S | 1..1 | Reference(BePatient) | Who the dispense is for |
![]() ![]() ![]() | S | 0..1 | Reference(Encounter | EpisodeOfCare) | The dispense session identifier, for example an identifier of a visit to a pharmacy |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Required Pattern: https://www.gfd-dpp.be/fhir/reference/identifier_types | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: sguid | |
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | The namespace for the identifier value Required Pattern: https://www.gfd-dpp.be/fhir/reference/sguid | |
![]() ![]() ![]() | S | 1..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: dispenser | |
![]() ![]() ![]() ![]() | 1..1 | Reference(BeOrganization | BePractitioner) | Individual who was performing | |
![]() ![]() ![]() | S | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() | S | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | S | 0..1 | SimpleQuantity | Amount dispensed |
![]() ![]() ![]() | S | 1..1 | dateTime | When product was given out |
![]() ![]() ![]() | S | 0..* | Annotation | Information about the dispense |
![]() ![]() ![]() | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver |
![]() ![]() ![]() ![]() | S | 0..1 | string | Free text dosage instructions e.g. SIG |
![]() ![]() ![]() ![]() | S | 0..1 | string | Patient or consumer oriented instructions |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | MedicationDispense | The medication dispense entry |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | S | 0..* | Identifier | External identifier Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | External identifier |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: dguid |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gfd-dpp.be/fhir/reference/dguid |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | 0..* | Reference(Procedure) | Event that dispense is part of | |
![]() ![]() ![]() | ?!Σ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. |
![]() ![]() ![]() | 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) | |||
![]() ![]() ![]() | 0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered. | |
![]() ![]() ![]() | Σ | 1..1 | What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |
![]() ![]() ![]() ![]() | CodeableConcept | |||
![]() ![]() ![]() ![]() | Reference(Any) | |||
![]() ![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): The drug code. For example CNK code for the medication |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(Medication) | What medication was supplied |
![]() ![]() ![]() | SΣ | 1..1 | Reference(BePatient) | Who the dispense is for |
![]() ![]() ![]() | S | 0..1 | Reference(Encounter | EpisodeOfCare) | The dispense session identifier, for example an identifier of a visit to a pharmacy |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ΣI | 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Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: https://www.gfd-dpp.be/fhir/reference/identifier_types |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: sguid |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: https://www.gfd-dpp.be/fhir/reference/sguid |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | |
![]() ![]() ![]() | S | 1..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 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. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: dispenser |
![]() ![]() ![]() ![]() | 1..1 | Reference(BeOrganization | BePractitioner) | Individual who was performing | |
![]() ![]() ![]() | 0..1 | Reference(Location) | Where the dispense occurred | |
![]() ![]() ![]() | S | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ΣI | 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Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() | SΣ | 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. | |
![]() ![]() ![]() | S | 0..1 | SimpleQuantity | Amount dispensed |
![]() ![]() ![]() | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |
![]() ![]() ![]() | Σ | 0..1 | dateTime | When product was packaged and reviewed |
![]() ![]() ![]() | S | 1..1 | dateTime | When product was given out |
![]() ![]() ![]() | 0..1 | Reference(Location) | Where the medication was sent | |
![]() ![]() ![]() | 0..* | Reference(Patient | Practitioner) | Who collected the medication | |
![]() ![]() ![]() | S | 0..* | Annotation | Information about the dispense |
![]() ![]() ![]() | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 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Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
![]() ![]() ![]() ![]() | Σ | 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". |
![]() ![]() ![]() ![]() | SΣ | 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 | |
![]() ![]() ![]() ![]() ![]() | 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) | |||
![]() ![]() ![]() ![]() | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
![]() ![]() ![]() ![]() | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
![]() ![]() ![]() ![]() | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
![]() ![]() ![]() | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 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. | |
![]() ![]() ![]() ![]() | 0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |
![]() ![]() ![]() | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
![]() ![]() ![]() | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | MedicationDispense | The medication dispense entry |
![]() ![]() ![]() | 0..* | Identifier | External identifier Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | External identifier | |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): The drug code. For example CNK code for the medication |
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Medication) | What medication was supplied |
![]() ![]() ![]() | Σ | 1..1 | Reference(BePatient) | Who the dispense is for |
![]() ![]() ![]() | 0..1 | Reference(Encounter | EpisodeOfCare) | The dispense session identifier, for example an identifier of a visit to a pharmacy | |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() | 1..* | BackboneElement | Who performed event | |
![]() ![]() ![]() | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense | |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | 0..1 | SimpleQuantity | Amount dispensed | |
![]() ![]() ![]() | 1..1 | dateTime | When product was given out | |
![]() ![]() ![]() | 0..* | Annotation | Information about the dispense | |
![]() ![]() ![]() | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Patient or consumer oriented instructions |
![]() |
This structure is derived from MedicationDispense
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 17 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | MedicationDispense | The medication dispense entry | |
![]() ![]() ![]() | S | 0..* | Identifier | External identifier Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | External identifier |
![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: dguid | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gfd-dpp.be/fhir/reference/dguid | |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): The drug code. For example CNK code for the medication |
![]() ![]() ![]() | S | 0..1 | Reference(Medication) | What medication was supplied |
![]() ![]() ![]() | S | 1..1 | Reference(BePatient) | Who the dispense is for |
![]() ![]() ![]() | S | 0..1 | Reference(Encounter | EpisodeOfCare) | The dispense session identifier, for example an identifier of a visit to a pharmacy |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Required Pattern: https://www.gfd-dpp.be/fhir/reference/identifier_types | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: sguid | |
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | The namespace for the identifier value Required Pattern: https://www.gfd-dpp.be/fhir/reference/sguid | |
![]() ![]() ![]() | S | 1..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: dispenser | |
![]() ![]() ![]() ![]() | 1..1 | Reference(BeOrganization | BePractitioner) | Individual who was performing | |
![]() ![]() ![]() | S | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() | S | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | S | 0..1 | SimpleQuantity | Amount dispensed |
![]() ![]() ![]() | S | 1..1 | dateTime | When product was given out |
![]() ![]() ![]() | S | 0..* | Annotation | Information about the dispense |
![]() ![]() ![]() | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver |
![]() ![]() ![]() ![]() | S | 0..1 | string | Free text dosage instructions e.g. SIG |
![]() ![]() ![]() ![]() | S | 0..1 | string | Patient or consumer oriented instructions |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | MedicationDispense | The medication dispense entry |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | S | 0..* | Identifier | External identifier Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | External identifier |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: dguid |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gfd-dpp.be/fhir/reference/dguid |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | 0..* | Reference(Procedure) | Event that dispense is part of | |
![]() ![]() ![]() | ?!Σ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. |
![]() ![]() ![]() | 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) | |||
![]() ![]() ![]() | 0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered. | |
![]() ![]() ![]() | Σ | 1..1 | What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |
![]() ![]() ![]() ![]() | CodeableConcept | |||
![]() ![]() ![]() ![]() | Reference(Any) | |||
![]() ![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): The drug code. For example CNK code for the medication |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(Medication) | What medication was supplied |
![]() ![]() ![]() | SΣ | 1..1 | Reference(BePatient) | Who the dispense is for |
![]() ![]() ![]() | S | 0..1 | Reference(Encounter | EpisodeOfCare) | The dispense session identifier, for example an identifier of a visit to a pharmacy |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ΣI | 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Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: https://www.gfd-dpp.be/fhir/reference/identifier_types |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: sguid |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: https://www.gfd-dpp.be/fhir/reference/sguid |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | |
![]() ![]() ![]() | S | 1..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 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. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: dispenser |
![]() ![]() ![]() ![]() | 1..1 | Reference(BeOrganization | BePractitioner) | Individual who was performing | |
![]() ![]() ![]() | 0..1 | Reference(Location) | Where the dispense occurred | |
![]() ![]() ![]() | S | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ΣI | 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Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() | SΣ | 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. | |
![]() ![]() ![]() | S | 0..1 | SimpleQuantity | Amount dispensed |
![]() ![]() ![]() | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |
![]() ![]() ![]() | Σ | 0..1 | dateTime | When product was packaged and reviewed |
![]() ![]() ![]() | S | 1..1 | dateTime | When product was given out |
![]() ![]() ![]() | 0..1 | Reference(Location) | Where the medication was sent | |
![]() ![]() ![]() | 0..* | Reference(Patient | Practitioner) | Who collected the medication | |
![]() ![]() ![]() | S | 0..* | Annotation | Information about the dispense |
![]() ![]() ![]() | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 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Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
![]() ![]() ![]() ![]() | Σ | 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". |
![]() ![]() ![]() ![]() | SΣ | 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 | |
![]() ![]() ![]() ![]() ![]() | 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) | |||
![]() ![]() ![]() ![]() | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
![]() ![]() ![]() ![]() | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
![]() ![]() ![]() ![]() | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
![]() ![]() ![]() | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 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. | |
![]() ![]() ![]() ![]() | 0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |
![]() ![]() ![]() | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
![]() ![]() ![]() | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
MedicationDispense.language | preferred | CommonLanguages Max Binding: AllLanguages |
MedicationDispense.identifier:DGUID.use | required | IdentifierUse |
MedicationDispense.identifier:DGUID.type | extensible | Identifier Type Codes |
MedicationDispense.status | required | MedicationDispense Status Codes |
MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codes |
MedicationDispense.category | preferred | MedicationDispense Category Codes |
MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodes |
MedicationDispense.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes |
MedicationDispense.context.type | extensible | ResourceType |
MedicationDispense.context.identifier.use | required | IdentifierUse |
MedicationDispense.context.identifier.type | extensible | Identifier Type Codes |
MedicationDispense.performer.function | example | MedicationDispense Performer Function Codes |
MedicationDispense.authorizingPrescription.type | extensible | ResourceType |
MedicationDispense.type | example | ActPharmacySupplyType |
MedicationDispense.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructions |
MedicationDispense.dosageInstruction.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes |
MedicationDispense.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes |
MedicationDispense.dosageInstruction.route | example | SNOMEDCTRouteCodes |
MedicationDispense.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodes |
MedicationDispense.dosageInstruction.doseAndRate.type | example | DoseAndRateType |
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCode |
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReason |