Cancel
Description
A Medication Order Cancel event is used to indicate that a previously requested medication order for a specific patient has been cancelled by the ordering system. This event type is typically triggered when the prescribing or ordering provider determines that the medication order is no longer needed or should not be administered to the patient.
API endpoints for Medication Cancel
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/medications/cancel.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Data Model JSON for Cancel
Cancel - Sample Payload
{
"Meta": {
"DataModel": "Medications",
"EventType": "Cancel",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "a29950c5-ea5e-4b7f-9340-bb006f3c7220",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "1923a180-2a39-4e72-8c87-c41f2a813030",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "7cce3ad5-ded8-4e6d-9c20-78e84a30eb48",
"AttemptID": "7aea5204-0377-4415-b27c-e904e1e8b38c"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "10f3bb95-aa7b-4bc8-a790-9619fdbc0d9c ",
"IDType": "EHRID"
},
{
"ID": "a88bf9c9-d7ea-41d0-b5e2-04379a6cbc7e",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Ronnie",
"MiddleName": "Patricks",
"LastName": "Oliver",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+19876675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Wallgate Avenue",
"City": "San Jose",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": [],
"Allergies": [
{
"Code": "5674",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Penicillin",
"AltCodes": [],
"Substance": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Rash",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
},
{
"Code": "247472004",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Hives",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
}
],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Criticality": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Status": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"StartDate": null,
"EndDate": null,
"Comment": null
}
]
},
"Visit": {
"VisitDateTime": "2022-08-16T14:21:21.381Z",
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": null,
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null,
"Bed": null
},
"AttendingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Insurances": []
},
"Order": {
"ID": "c646ec5b-37a9-4949-a619-337ce507d44b",
"Notes": [],
"Medication": {
"Dose": {
"Quantity": 4,
"Units": "mg"
},
"Rate": {
"Quantity": null,
"Units": null
},
"Route": {
"Code": "C38288",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "Oral",
"AltCodes": []
},
"Components": [],
"Product": {
"Code": "104894",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Onda 4 Mg Po Tbdp",
"AltCodes": []
},
"FreeTextSig": null,
"StartDate": "2022-08-16T14:21:20.731Z",
"EndDate": null,
"Frequency": {
"Period": 8,
"Unit": "h"
},
"IsPRN": null,
"Dispense": {
"Amount": null,
"Units": null
},
"NumberOfRefillsRemaining": null
},
"Indications": [],
"Provider": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Alex",
"LastName": "Moon",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "San Jose",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+160850951234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"EnteredBy": {
"ID": "4356709876",
"IDType": "NPI",
"FirstName": "James",
"LastName": "Smith",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "136523 Main St.",
"City": "San Jose"",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085651234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"VerifiedBy": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Priority": null,
"Pharmacy": {
"Code": "1234567",
"Codeset": "NCPDP",
"Description": "Fake Pharmacy",
"Address": {
"StreetAddress": "123 Fake Street",
"City": "San Jose",
"State": "CA",
"ZIP": 53703,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
}
}
}
}