Cancel
Description
A Cancel event type can be used when an existing order needs to be canceled. This event type typically includes information about the order that is being canceled, such as the order ID or other relevant identifiers, and may also include additional details about the reason for the cancellation.
API endpoints for Order Cancel
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/order/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": "Order",
"EventType": "Cancel",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "642956d0-6e2f-40ea-8c96-ec1ae2ffa743",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "26a54f86-73b5-4941-acce-2cadb4903e17",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "7b4ae265-0ca4-44db-af23-cc3e33b04022",
"AttemptID": "79c29253-c161-48ce-b36f-268080d2fa25"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "c29ca312-2312-4495-bfed-d9631374f97c",
"IDType": "EHRID"
},
{
"ID": "1f0ef6a5-3eab-4421-a9f8-49c158b80819",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Albert",
"MiddleName": "Dawson",
"LastName": "Harrison",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088445301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "999 Truman Park St.",
"City": "San Jose",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": []
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": null,
"VisitDateTime": "2015-04-21T13:54:49.863Z",
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "William",
"LastName": "Grant",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "234 Main St.",
"City": "San Jose"",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16123551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ConsultingProvider": {
"ID": "2434534987",
"IDType": "NPI",
"FirstName": "Clive",
"LastName": "Traven",
"Credentials": [
"MD",
"PhD"
],
"Address": {
"StreetAddress": "312 Park Street",
"City": "San Jose"s",
"State": "CA",
"ZIP": "53593",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085559999"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"ID": "4236464757",
"IDType": "NPI",
"FirstName": "Calvin",
"LastName": "James",
"Credentials": [
"DO"
],
"Address": {
"StreetAddress": "500 First St.",
"City": "San Jose"",
"State": "CA",
"ZIP": "63105",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16545554321"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Harry",
"MiddleName": null,
"LastName": "Ford",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Jenna",
"LastName": "Ford"
},
"Address": {
"StreetAddress": "4762 Queens Park",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Digitech Labs",
"Address": {
"StreetAddress": " 123 Palms Road",
"City": "San Jose",
"State": "CA",
"ZIP": "98722",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "San Jose"",
"State": "CA",
"ZIP": "40512-4079",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Digitech Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"Priority": null,
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
],
"Location": {
"Type": "Inpatient",
"Facility": "MGM General Clinic",
"Department": "3N",
"Room": "136",
"Bed": "B"
}
},
"Order": {
"ID": "157968300",
"ApplicationOrderID": null,
"Status": "New",
"TransactionDateTime": "2015-05-06T06:00:58.872Z",
"CollectionDateTime": "2015-05-06T06:00:58.872Z",
"Specimen": {
"Source": null,
"BodySite": null,
"ID": null
},
"Procedure": {
"Code": "49086-2",
"Codeset": null,
"Description": "Maternal screen -translucency panel"
},
"Provider": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Clive ",
"LastName": "Traven",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "San Jose"",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ResultCopyProviders": [],
"OrderingFacility": {
"Name": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"PhoneNumber": null
},
"Priority": "Stat",
"Expiration": null,
"Comments": null,
"Notes": [],
"Diagnoses": [
{
"Code": "Z31.41",
"Codeset": "ICD-10",
"Name": "Fertility testing Encounter",
"Type": null,
"DocumentedDateTime": null
}
],
"ClinicalInfo": [
{
"Code": "QUESTION001",
"Codeset": null,
"Description": "Estimated Due Date",
"Value": "2015-10-05",
"Units": null,
"Abbreviation": null,
"Notes": []
},
{
"Code": "QUESTION002",
"Codeset": null,
"Description": "Ethnicity",
"Value": "White",
"Units": null,
"Abbreviation": "W",
"Notes": []
},
{
"Code": "QUESTION010",
"Codeset": null,
"Description": "Is this a twin pregnancy?",
"Value": "Singleton",
"Units": null,
"Abbreviation": "sng",
"Notes": []
},
{
"Code": "QUESTION011",
"Codeset": null,
"Description": "Dating Method",
"Value": "LMP",
"Units": null,
"Abbreviation": "lmp",
"Notes": []
}
]
}
}