MedicationDispense
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.
https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationdispense.html
MedicationDispense read
Read a MedicationDispense resource.
Path Parameters
Response Payload Attributes
The FHIR Resource name.
The identifier of the MedicationDispense.
A code specifying the state of the dispense event.
Identifies the medication that was dispensed. This is simply an attribute carrying a code that identifies the medication from a known list of medications.
Code defined by a terminology system.
The system url of the coding.
The code of the medication.
The display name of the coding.
Who the dispense is for.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Indicates who performed the dispense.
The individual who performed the dispense.
The reference string of the performer in the format of "Practitioner/ed1e304acdb847148338c6b0596d93fd".
Type the reference refers to (e.g. “Practitioner”).
Indicates the medication order that is being dispensed against.
The reference string of the MedicationRequest in the format of "MedicationRequest/3423a69c-618d-4cbe-861a-54c60f48744e".
Type the reference refers to (e.g. “MedicationRequest”).
Indicates the type of dispensing event that is being performed.
Plain text representation of the concept
The amount of medication that has been dispensed.
Numerical value of the quantity.
When the medication was handed over to the patient.
Indicates how the medication is to be used by the patient.
Free text dosage instructions. In Canvas this text comes from the SIG or DIRECTIONS field on the associated command.
When medication should be administered.
Identifies the specific times when the medication should be administered.
Amount of medication administered.
Amount of medication per dose.
Numerical value
Unit representation.
Responses
Errors
MedicationDispense search
Search for MedicationDispense resources.
Query Parameters
The identifier of the MedicationDispense.
The patient reference associated with the MedicationDispense in the format Patient/a39cafb9d1b445be95a2e2548e12a787.
Response Payload Attributes
The FHIR Resource name.
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
The number of resources that match the search parameter.
Attributes relevant to pagination, see our Pagination page for more detail.
The relation of the page search
The search url for the specific relation
The results bundle that lists out each object returned in the search
The attributes specific to the resource type, see the Attributes section below
Attributes
The FHIR Resource name.
The identifier of the MedicationDispense.
A code specifying the state of the dispense event.
Identifies the medication that was dispensed. This is simply an attribute carrying a code that identifies the medication from a known list of medications.
Code defined by a terminology system.
The system url of the coding.
The code of the medication.
The display name of the coding.
Who the dispense is for.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Indicates who performed the dispense.
The individual who performed the dispense.
The reference string of the performer in the format of "Practitioner/ed1e304acdb847148338c6b0596d93fd".
Type the reference refers to (e.g. “Practitioner”).
Indicates the medication order that is being dispensed against.
The reference string of the MedicationRequest in the format of "MedicationRequest/3423a69c-618d-4cbe-861a-54c60f48744e".
Type the reference refers to (e.g. “MedicationRequest”).
Indicates the type of dispensing event that is being performed.
Plain text representation of the concept
The amount of medication that has been dispensed.
Numerical value of the quantity.
When the medication was handed over to the patient.
Indicates how the medication is to be used by the patient.
Free text dosage instructions. In Canvas this text comes from the SIG or DIRECTIONS field on the associated command.
When medication should be administered.
Identifies the specific times when the medication should be administered.
Amount of medication administered.
Amount of medication per dose.
Numerical value
Unit representation.
Responses
Errors
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/MedicationDispense/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/MedicationDispense/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "MedicationDispense", "id": "a47c7b0e-bbb4-42cd-bc4a-df259d148ea1", "status": "completed", "medicationCodeableConcept": { "coding": [ { "system": "http://www.fdbhealth.com/", "code": "244899", "display": "lisinopril 10 mg tablet" }, { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "314076", "display": "lisinopril 10 mg tablet" } ] }, "subject": { "reference": "Patient/6cb2a409334943c2b48f1686dc739f11", "type": "Patient" }, "performer": [ { "actor": { "reference": "Practitioner/6c20b7152cf7421791c5ab4113060b3f", "type": "Practitioner" } } ], "authorizingPrescription": [ { "reference": "MedicationRequest/3423a69c-618d-4cbe-861a-54c60f48744e", "type": "MedicationRequest" } ], "type": { "text": "Office-supplied" }, "quantity": { "value": 30 }, "whenHandedOver": "2023-09-21T18:35:00.000+00:00", "dosageInstruction": [ { "text": "take 1 daily", "timing": { "event": [ "2023-09-21T18:35:00.000+00:00" ] }, "doseAndRate": [ { "doseQuantity": { "value": 5, "unit": "Tablet" } } ] } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-found", "details": { "text": "Unknown MedicationDispense resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'" } } ] }
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/MedicationDispense?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/MedicationDispense?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Bundle", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "/MedicationDispense?patient=Patient%2F6cb2a409334943c2b48f1686dc739f11&_count=10&_offset=0" }, { "relation": "first", "url": "/MedicationDispense?patient=Patient%2F6cb2a409334943c2b48f1686dc739f11&_count=10&_offset=0" }, { "relation": "last", "url": "/MedicationDispense?patient=Patient%2F6cb2a409334943c2b48f1686dc739f11&_count=10&_offset=0" } ], "entry": [ { "resource": { "resourceType": "MedicationDispense", "id": "a47c7b0e-bbb4-42cd-bc4a-df259d148ea1", "status": "completed", "medicationCodeableConcept": { "coding": [ { "system": "http://www.fdbhealth.com/", "code": "244899", "display": "lisinopril 10 mg tablet" }, { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "314076", "display": "lisinopril 10 mg tablet" } ] }, "subject": { "reference": "Patient/6cb2a409334943c2b48f1686dc739f11", "type": "Patient" }, "performer": [ { "actor": { "reference": "Practitioner/6c20b7152cf7421791c5ab4113060b3f", "type": "Practitioner" } } ], "authorizingPrescription": [ { "reference": "MedicationRequest/3423a69c-618d-4cbe-861a-54c60f48744e", "type": "MedicationRequest" } ], "type": { "text": "Office-supplied" }, "quantity": { "value": 30 }, "whenHandedOver": "2023-09-21T18:35:00.000+00:00", "dosageInstruction": [ { "text": "take 1 daily", "timing": { "event": [ "2023-09-21T18:35:00.000+00:00" ] }, "doseAndRate": [ { "doseQuantity": { "value": 5, "unit": "Tablet" } } ] } ] } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "text": "Bad request" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }