MedicationDispenseDoseDispensing

Introduction

The Medication Dispense Dose Dispensing FHIR API is used to receive Medication Dispence related data from CanS (A middle layer software developed by Canella that enables sharing dose dispensing related information sent from different systems). This profile is based on the FHIR resource MedicationDispense.

Intended Use

This profile is created as the main profile for the communication of information related to dose dispensing data of patients.

Specific Rules and Limitations

Profile Overview

MedicationRequestDoseDispensing

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifier0..*Identifier
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConcept
intentΣ ?!1..1codeBindingFixed Value
category0..*CodeableConcept
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
reportedBooleanboolean
reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
medicationCodeableConceptCodeableConcept
medicationReferenceReference(Medication)
subjectΣ I1..1Reference(Patient)
encounterI0..1Reference(Encounter)
supportingInformationI0..*Reference(Resource)
authoredOnΣ0..1dateTime
requesterΣ I0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)
performerI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)
performerTypeΣ0..1CodeableConcept
recorderI0..1Reference(Practitioner | PractitionerRole)
reasonCode0..*CodeableConcept
reasonReferenceI0..*Reference(Condition | Observation)
instantiatesCanonicalΣ0..0canonical()
instantiatesUriΣ0..0uri
basedOnΣ I0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)
groupIdentifierΣ0..1Identifier
courseOfTherapyType0..0CodeableConcept
insuranceI0..0Reference(Coverage | ClaimResponse)
note0..*Annotation
dosageInstruction0..*Dosage
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
quantityI0..1SimpleQuantity
durationI0..1Duration
dispenseIntervalI0..1Duration
validityPeriodI0..1Period
numberOfRepeatsAllowed0..1unsignedInt
quantityI0..1SimpleQuantity
expectedSupplyDurationI0..1Duration
performerI0..1Reference(Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
allowedBooleanboolean
allowedCodeableConceptCodeableConcept
reason0..1CodeableConcept
priorPrescriptionI0..1Reference(MedicationRequest)
detectedIssueI0..*Reference(DetectedIssue)
eventHistoryI0..0Reference(Provenance)

Versions

COS version Profile version Required COSMIC version Date Description
3.0.0 1.0.0 COSMIC 3.12.0 February 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 set:

Command 'tree' could not render: File was not found for 'https://www.hl7.org/fhir/MedicationDispense.html'

Supported Operations

HTTP Methods

Method Description
POST Support for updating MedicationDispenseDoseDispensing information by patient ID.

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]/medication/occasions/dispense/bulk

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.