MedicationRequestDoseDispensing

Introduction

The Medication Request FHIR API is designed to enable the fetching of requested medications for a patient. This profile is based on the FHIR resource MedicationRequest.

Intended Use

This profile is intended to be used for communicating information related to prescribed medication data for a patient that is to be dispensed from a dose dispensing machine. This profile will communicate details of one prescription at a time.

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
COS 4.3.0 1.0.0 COSMIC 3.12.0 July 2024 Initial version.

Statuses

FHIR status "Active" will be sent always.

ValueSet

ValueSet

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

medicationRequest status

ValueSet

medicationRequest intent

Command 'tree' could not render: File was not found for 'https://simplifier.net/packages/hl7.fhir.r4.core/4.0.1/files/82012'

medicationRequest category

ValueSet

Supported Operations

HTTP Methods

Method Description
GET Retrieving MedicationRequestDoseDispensing data by patient ID.

Query Operations

Search Parameters

Parameter Format Mandatory Comment
identifier identifier Yes Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
authoredOn dateTime Yes The date and time when the prescription was initially written or authored on.
subject Reference Yes A link to a resource representing the person or set of individuals to whom the medication will be given.
_profile Reference Yes To use the MedicationRequestDoseDispensing profile one must include the profile parameter in the request as it is not the default implementation.

Supported Queries

  1. GET [baseURL]/MedicationRequest?subject.identifier:urn:oid:[OID]|[id]&category=[]&_profile=[https://fhir.cambio.se/StructureDefinition/MedicationRequestDoseDispensing]
  2. GET [baseURL]/MedicationRequest?subject.identifier:urn:oid:[OID]|[id]&category=[]&_profile=[https://fhir.cambio.se/StructureDefinition/MedicationRequestDoseDispensing]&date=gt&date=lt
  3. GET [baseURL]/MedicationRequest?subject.identifier:urn:oid:[OID]|[id]&category=[]&_profile=[https://fhir.cambio.se/StructureDefinition/MedicationRequestDoseDispensing]&date=gt&date=lt&_include=MedicationRequest:subject
  4. GET [baseURL]/MedicationRequest?subject.identifier:urn:oid:[OID]|[id]&category=[]&_profile=[https://fhir.cambio.se/StructureDefinition/MedicationRequestDoseDispensing]&date=gt&date=lt&_include=MedicationRequest:subject&_include=MedicationRequest:requester

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:

  • subject
  • practitioner

Supported RevInclude Operations

N/A

Error Codes

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