OpenMRS FHIR2 Implementation Guide
0.1.0 - ci-build

OpenMRS FHIR2 Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: OMRS Medication Dispense

Official URL: http://fhir.openmrs.org/fhir/StructureDefinition/omrsmedication-dispense Version: 0.1.0
Active as of 2023-03-20 Computable Name: OMRSMedicationDispense

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

Usage:

Formal Views of Profile Content

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

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*MedicationDispenseDispensing a medication to a named patient
... id 0..1idLogical id of this artifact
... identifier 0..0
... partOf 0..0
... statusReasonCodeableConcept 0..1CodeableConceptWhy a dispense was not performed
... category 0..0
... medication[x] 1..1CodeableConcept, Reference(Medication)What medication was supplied
... subject 0..1Reference(Patient | Group)Who the dispense is for
... context 0..1Reference(Openmrs Encounter)Encounter / Episode associated with event
... supportingInformation 0..0
... performer
.... actor 1..1Reference(Openmrs Practitioner)Individual who was performing
... location 0..1Reference(OpenMRS Location)Where the dispense occurred
... authorizingPrescription 0..*Reference(OpenMRS Medication Request)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..0
... whenPrepared 0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..0
... receiver 0..0
... note 0..0
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver
... substitution
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
.... reason 0..1CodeableConceptWhy was substitution made
.... responsibleParty 0..0
... detectedIssue 0..0
... eventHistory 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*MedicationDispenseDispensing a medication to a named patient
... id Σ0..1idLogical id of this artifact
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for statusReason[x] 0..1Why a dispense was not performed
Slice: Unordered, Open by type:$this
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
.... statusReason[x]:statusReasonCodeableConcept 0..1CodeableConceptWhy a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

... medication[x] Σ1..1What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject Σ0..1Reference(Patient | Group)Who the dispense is for
... context 0..1Reference(Openmrs Encounter)Encounter / Episode associated with event
... location 0..1Reference(OpenMRS Location)Where the dispense occurred
... authorizingPrescription 0..*Reference(OpenMRS Medication Request)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1SimpleQuantityAmount dispensed
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationDispense.statusrequiredMedicationDispense Status Codes
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
MedicationDispense.statusReason[x]:statusReasonCodeableConceptexampleMedicationDispense Status Reason Codes
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
MedicationDispense.typeexampleActPharmacySupplyType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*MedicationDispenseDispensing a medication to a named patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codepreparation | 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.

... Slices for statusReason[x] 0..1Why a dispense was not performed
Slice: Unordered, Open by type:$this
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
.... statusReason[x]:statusReasonCodeableConcept 0..1CodeableConceptWhy a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

... medication[x] Σ1..1What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject Σ0..1Reference(Patient | Group)Who the dispense is for
... context 0..1Reference(Openmrs Encounter)Encounter / Episode associated with event
... performer 0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptWho performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.

.... actor 1..1Reference(Openmrs Practitioner)Individual who was performing
... location 0..1Reference(OpenMRS Location)Where the dispense occurred
... authorizingPrescription 0..*Reference(OpenMRS Medication Request)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1SimpleQuantityAmount dispensed
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver
... substitution 0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason 0..1CodeableConceptWhy 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.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationDispense.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationDispense.statusrequiredMedicationDispense Status Codes
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
MedicationDispense.statusReason[x]:statusReasonCodeableConceptexampleMedicationDispense Status Reason Codes
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
MedicationDispense.typeexampleActPharmacySupplyType
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*MedicationDispenseDispensing a medication to a named patient
... id 0..1idLogical id of this artifact
... identifier 0..0
... partOf 0..0
... statusReasonCodeableConcept 0..1CodeableConceptWhy a dispense was not performed
... category 0..0
... medication[x] 1..1CodeableConcept, Reference(Medication)What medication was supplied
... subject 0..1Reference(Patient | Group)Who the dispense is for
... context 0..1Reference(Openmrs Encounter)Encounter / Episode associated with event
... supportingInformation 0..0
... performer
.... actor 1..1Reference(Openmrs Practitioner)Individual who was performing
... location 0..1Reference(OpenMRS Location)Where the dispense occurred
... authorizingPrescription 0..*Reference(OpenMRS Medication Request)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..0
... whenPrepared 0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..0
... receiver 0..0
... note 0..0
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver
... substitution
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
.... reason 0..1CodeableConceptWhy was substitution made
.... responsibleParty 0..0
... detectedIssue 0..0
... eventHistory 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*MedicationDispenseDispensing a medication to a named patient
... id Σ0..1idLogical id of this artifact
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for statusReason[x] 0..1Why a dispense was not performed
Slice: Unordered, Open by type:$this
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
.... statusReason[x]:statusReasonCodeableConcept 0..1CodeableConceptWhy a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

... medication[x] Σ1..1What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject Σ0..1Reference(Patient | Group)Who the dispense is for
... context 0..1Reference(Openmrs Encounter)Encounter / Episode associated with event
... location 0..1Reference(OpenMRS Location)Where the dispense occurred
... authorizingPrescription 0..*Reference(OpenMRS Medication Request)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1SimpleQuantityAmount dispensed
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationDispense.statusrequiredMedicationDispense Status Codes
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
MedicationDispense.statusReason[x]:statusReasonCodeableConceptexampleMedicationDispense Status Reason Codes
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
MedicationDispense.typeexampleActPharmacySupplyType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*MedicationDispenseDispensing a medication to a named patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codepreparation | 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.

... Slices for statusReason[x] 0..1Why a dispense was not performed
Slice: Unordered, Open by type:$this
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
.... statusReason[x]:statusReasonCodeableConcept 0..1CodeableConceptWhy a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

... medication[x] Σ1..1What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject Σ0..1Reference(Patient | Group)Who the dispense is for
... context 0..1Reference(Openmrs Encounter)Encounter / Episode associated with event
... performer 0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptWho performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.

.... actor 1..1Reference(Openmrs Practitioner)Individual who was performing
... location 0..1Reference(OpenMRS Location)Where the dispense occurred
... authorizingPrescription 0..*Reference(OpenMRS Medication Request)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1SimpleQuantityAmount dispensed
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver
... substitution 0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason 0..1CodeableConceptWhy 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.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationDispense.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationDispense.statusrequiredMedicationDispense Status Codes
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
MedicationDispense.statusReason[x]:statusReasonCodeableConceptexampleMedicationDispense Status Reason Codes
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
MedicationDispense.typeexampleActPharmacySupplyType
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron