MedicationDispense - FHIR Resource (r4)
This MedicationDispense Resource uses the FHIR API standard for access and structure.
Validate an MedicationDispense FHIR Resource (r4)
MedicationDispense Attributes
AttributeField is listTypeDescription
Description: External identifier
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (MedicationDispense) identifier FHIR attribute
Description: Event that dispense is part of
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": Learn more about the (MedicationDispense) partOf FHIR attribute
Description: preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "completed"Learn more about the (MedicationDispense) status FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"statusReason[x]": Learn more about the (MedicationDispense) statusReason[x] FHIR attribute
Description: Type of medication dispense
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": Learn more about the (MedicationDispense) category FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"medication[x]": Learn more about the (MedicationDispense) medication[x] FHIR attribute
Description: Who the dispense is for
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/pat1",
"display": "Donald Duck"
}Learn more about the (MedicationDispense) subject FHIR attribute
Description: Encounter / Episode associated with event
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": Learn more about the (MedicationDispense) context FHIR attribute
Description: Information that supports the dispensing of the medication
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supportingInformation": Learn more about the (MedicationDispense) supportingInformation FHIR attribute
Description: Who performed event
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": [
{
"actor": {
"reference": "Practitioner/f006"
}
}
]Learn more about the (MedicationDispense) performer FHIR attribute
Description: Where the dispense occurred
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (MedicationDispense) location FHIR attribute
Description: Medication order that authorizes the dispense
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"authorizingPrescription": [
{
"reference": "MedicationRequest/medrx0309"
}
]Learn more about the (MedicationDispense) authorizingPrescription FHIR attribute
Description: Trial fill, partial fill, emergency fill, etc.
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (MedicationDispense) type FHIR attribute
Description: Amount dispensed
FHIR Version: r4
Attribute Type : SimpleQuantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"quantity": Learn more about the (MedicationDispense) quantity FHIR attribute
Description: Amount of medication expressed as a timing amount
FHIR Version: r4
Attribute Type : SimpleQuantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"daysSupply": Learn more about the (MedicationDispense) daysSupply FHIR attribute
Description: When product was packaged and reviewed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"whenPrepared": Learn more about the (MedicationDispense) whenPrepared FHIR attribute
Description: When product was given out
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"whenHandedOver": Learn more about the (MedicationDispense) whenHandedOver FHIR attribute
Description: Where the medication was sent
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"destination": Learn more about the (MedicationDispense) destination FHIR attribute
Description: Who collected the medication
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"receiver": Learn more about the (MedicationDispense) receiver FHIR attribute
Description: Information about the dispense
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (MedicationDispense) note FHIR attribute
Description: How the medication is to be used by the patient or administered by the caregiver
FHIR Version: r4
Attribute Type : Dosage
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dosageInstruction": [
{
"sequence": 1,
"timing": {
"repeat": {
"frequency": 2,
"period": 21,
"periodUnit": "d"
}
},
"route": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "394899003",
"display": "oral administration of treatment"
}
]
},
"doseAndRate": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/dose-rate-type",
"code": "ordered",
"display": "Ordered"
}
]
},
"doseQuantity": {
"value": 500,
"unit": "mg",
"system": "http://unitsofmeasure.org",
"code": "mg"
}
}
]
}
]Learn more about the (MedicationDispense) dosageInstruction FHIR attribute
Description: Whether a substitution was performed on the dispense
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"substitution": Learn more about the (MedicationDispense) substitution FHIR attribute
Description: Clinical issue with action
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"detectedIssue": Learn more about the (MedicationDispense) detectedIssue FHIR attribute
Description: A list of relevant lifecycle events
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"eventHistory": Learn more about the (MedicationDispense) eventHistory FHIR attribute
MedicationDispense Example
{
"resourceType": "MedicationDispense",
"id": "meddisp008",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: meddisp008</p><p><b>contained</b>: </p><p><b>status</b>: completed</p><p><b>medication</b>: id: medexample015; Capecitabine 500mg oral tablet (Xeloda) <span>(Details : {RxNorm code '213293' = 'Xeloda 500 MG Oral Tablet', given as 'Capecitabine 500mg oral tablet (Xeloda)'})</span></p><p><b>subject</b>: <a>Donald Duck</a></p><h3>Performers</h3><table><tr><td>-</td><td><b>Actor</b></td></tr><tr><td>*</td><td><a>Practitioner/f006</a></td></tr></table><p><b>authorizingPrescription</b>: <a>MedicationRequest/medrx0309</a></p><p><b>dosageInstruction</b>: </p></div>"
},
"contained": [
{
"resourceType": "Medication",
"id": "medexample015",
"code": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "213293",
"display": "Capecitabine 500mg oral tablet (Xeloda)"
}
]
}
}
],
"status": "completed",
"medicationReference": {
"reference": "#medexample015"
},
"subject": {
"reference": "Patient/pat1",
"display": "Donald Duck"
},
"performer": [
{
"actor": {
"reference": "Practitioner/f006"
}
}
],
"authorizingPrescription": [
{
"reference": "MedicationRequest/medrx0309"
}
],
"dosageInstruction": [
{
"sequence": 1,
"timing": {
"repeat": {
"frequency": 2,
"period": 21,
"periodUnit": "d"
}
},
"route": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "394899003",
"display": "oral administration of treatment"
}
]
},
"doseAndRate": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/dose-rate-type",
"code": "ordered",
"display": "Ordered"
}
]
},
"doseQuantity": {
"value": 500,
"unit": "mg",
"system": "http://unitsofmeasure.org",
"code": "mg"
}
}
]
}
]
}MedicationDispense Structure
{
"resourceType" : "MedicationDispense",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External identifier
"partOf" : [{ Reference(Procedure) }], // Event that dispense is part of
"status" : "<code>", // R! preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
// statusReason[x]: Why a dispense was not performed. One of these 2:
"statusReasonCodeableConcept" : { CodeableConcept },
"statusReasonReference" : { Reference(DetectedIssue) },
"category" : { CodeableConcept }, // Type of medication dispense
// medication[x]: What medication was supplied. One of these 2:
"medicationCodeableConcept" : { CodeableConcept },
"medicationReference" : { Reference(Medication) },
"subject" : { Reference(Patient|Group) }, // Who the dispense is for
"context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter / Episode associated with event
"supportingInformation" : [{ Reference(Any) }], // Information that supports the dispensing of the medication
"performer" : [{ // Who performed event
"function" : { CodeableConcept }, // Who performed the dispense and what they did
"actor" : { Reference(Practitioner|PractitionerRole|Organization|Patient|
Device|RelatedPerson) } // R! Individual who was performing
}],
"location" : { Reference(Location) }, // Where the dispense occurred
"authorizingPrescription" : [{ Reference(MedicationRequest) }], // Medication order that authorizes the dispense
"type" : { CodeableConcept }, // Trial fill, partial fill, emergency fill, etc.
"quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
"daysSupply" : { Quantity(SimpleQuantity) }, // Amount of medication expressed as a timing amount
"whenPrepared" : "<dateTime>", // When product was packaged and reviewed
"whenHandedOver" : "<dateTime>", // When product was given out
"destination" : { Reference(Location) }, // Where the medication was sent
"receiver" : [{ Reference(Patient|Practitioner) }], // Who collected the medication
"note" : [{ Annotation }], // Information about the dispense
"dosageInstruction" : [{ Dosage }], // How the medication is to be used by the patient or administered by the caregiver
"substitution" : { // Whether a substitution was performed on the dispense
"wasSubstituted" : <boolean>, // R! Whether a substitution was or was not performed on the dispense
"type" : { CodeableConcept }, // Code signifying whether a different drug was dispensed from what was prescribed
"reason" : [{ CodeableConcept }], // Why was substitution made
"responsibleParty" : [{ Reference(Practitioner|PractitionerRole) }] // Who is responsible for the substitution
},
"detectedIssue" : [{ Reference(DetectedIssue) }], // Clinical issue with action
"eventHistory" : [{ Reference(Provenance) }] // A list of relevant lifecycle events
}
MedicationDispense Search Parameters
The following search parameters can be used to query MedicationDispense resources. Just submit them like so:
https://api.1up.health/fhir/r4/MedicationDispense?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
code | text | medication |
context | reference | context |
destination | reference | destination |
identifier | text | identifier |
medication | reference | medication |
patient | reference | subject.where |
performer | reference | performer.actor |
prescription | reference | authorizingPrescription |
receiver | reference | receiver |
responsibleparty | reference | substitution.responsibleParty |
status | text | status |
subject | reference | subject |
type | text | type |
whenhandedover | date | whenHandedOver |
whenprepared | date | whenPrepared |
