MedicationDispenseDoseDispensing

Introduction

The Medication Dispense Dose Dispensing FHIR API is used to receive Medication Dispense related data. This profile is based on the FHIR resource MedicationDispense.

Intended Use

This profile is intended to be used for posting information related to the dispensing of medications for a patient by a dose dispensing machine.

Specific Rules and Limitations

Profile Overview

MedicationDispenseDoseDispensing

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifier0..*Identifier
partOfI0..0Reference(Procedure)
statusΣ ?!1..1codeBinding
statusReasonCodeableConceptCodeableConcept
statusReasonReferenceReference(DetectedIssue)
category0..1CodeableConceptBinding
medicationCodeableConceptCodeableConcept
medicationReferenceReference(Medication)
subjectΣ I0..1Reference(Patient | Group)
contextI0..1Reference(Encounter | EpisodeOfCare)
supportingInformationI0..*Reference(Resource)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
function0..1CodeableConcept
actorI1..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)
locationI0..1Reference(Location)
authorizingPrescriptionI0..*Reference(MedicationRequest)
type0..0CodeableConcept
quantityI0..1SimpleQuantity
daysSupplyI0..1SimpleQuantity
whenPreparedΣ0..1dateTime
whenHandedOver0..1dateTime
destinationI0..1Reference(Location)
receiverI0..*Reference(Patient | Practitioner)
note0..*Annotation
dosageInstruction0..*Dosage
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
wasSubstituted1..1boolean
type0..1CodeableConcept
reason0..*CodeableConcept
responsiblePartyI0..*Reference(Practitioner | PractitionerRole)
detectedIssueI0..0Reference(DetectedIssue)
eventHistoryI0..0Reference(Provenance)

Versions

COS version Profile version Required COSMIC version Date Description
COS 4.3.0 1.0.0 COSMIC 3.12.0 July 2024 Initial version

Statuses

FHIR status Status Description
Active FHIR status "Active" will be sent when it is a valid medication dispense.
Cancel FHIR status "Cancel" will be sent when it is a invalid medication dispense.

ValueSet

The profile includes bindings to the following FHIR defined value sets:

medicationDispense status

ValueSet

medication dispense category

ValueSet

Supported Operations

HTTP Methods

Method Description
POST Update MedicationDispenseDoseDispensing information for a patient.

Query Operations

Query Parameters

Parameter Format Mandatory Comment
code token Yes Returns dispenses of this medicine code
medication reference Yes Returns dispenses of this medicine resource
prescription reference Yes The identity of a prescription to list dispenses from

Supported Queries

  1. POST [baseURL]/Bundle

Supported Operations

Supported SearchInclude Operations

The _include search parameter enables a FHIR client to fetch a particular clinical resource as well as any other resources that it references. The following searchInclude parameters are supported:

  1. encounter
  2. location
  3. subject
  4. performer

Supported RevInclude Operations

The _reveinclude search parameter enables a FHIR client to fetch a particular clinical resource as well as any resources that references it. N/A

Error Codes

No specific error codes for MedicationDispenseDoseDispensing. For common codes, refer to Error handling section.