BookedResponse
Description
This is the format of the response you will receive for a Booked query.
API endpoints for
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/scheduling/booked-response.
Async REST API Endpoint to call the API: **https://{base_url}/api/v1/endpoint**.
Data Model JSON for BookedResponse
BookedResponse - Sample Payload
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "BookedResponse",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "aeced692-dc42-4718-8db3-608e3049557d",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "4e7e048e-29d3-403e-a34e-e344cb392180 ",
"AttemptID": "d265e840-a20b-479b-8767-063d0fd0f58d "
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null,
"IsIncomplete": false
},
"Visits": [
{
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": "2016-08-01T10:00:00Z",
"PatientClass": null,
"Status": null,
"Duration": "15",
"Reason": "Follow Up",
"CancelReason": "Conflicting appointment",
"LastUpdated": null,
"ScheduledDateTime": null,
"CancelDateTime": null,
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Bobby",
"LastName": "Grant",
"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
}
},
"ConsultingProvider": {
"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
}
},
"VisitProvider": {
"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
}
},
"Location": {
"Type": null,
"Facility": null,
"Department": "Clinic A",
"Room": null
},
"AdditionalStaff": [],
"Diagnoses": [],
"Equipment": [],
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "c3ae8712-5bc2-481e-a150-75f9f83ddd8f ",
"IDType": "EHRID"
},
{
"ID": "ebe8bd26-d59c-4dec-9c63-d5bc70cf2c2e",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "James",
"MiddleName": "Alex",
"LastName": "Smith",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hill Street",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": []
},
"AppointmentInfo": []
},
{
"VisitNumber": "1235",
"AccountNumber": null,
"VisitDateTime": "2016-08-01T11:00:00Z",
"PatientClass": null,
"Status": null,
"Duration": "15",
"Reason": "Follow Up",
"CancelReason": null,
"LastUpdated": null,
"ScheduledDateTime": null,
"CancelDateTime": null,
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "4236464757",
"IDType": "NPI",
"FirstName": "Mark",
"LastName": "Roger",
"Credentials": [
"DO"
],
"Address": {
"StreetAddress": "200 Mall St.",
"City": "San Jose"",
"State": "CA",
"ZIP": "63105",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+13145554321"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ConsultingProvider": {
"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
}
},
"VisitProvider": {
"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
}
},
"Location": {
"Type": null,
"Facility": null,
"Department": "Clinic A",
"Room": null
},
"AdditionalStaff": [],
"Diagnoses": [],
"Equipment": [],
"Patient": {
"Identifiers": [
{
"ID": "0000000002",
"IDType": "MR"
},
{
"ID": "0eb8ad45-46ed-4f6e-9f92-024a8a65c94d ",
"IDType": "EHRID"
},
{
"ID": "86b6297d-5157-4056-bf51-cc5665097abd ",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Alen",
"MiddleName": null,
"LastName": "Smith",
"DOB": "1982-07-24",
"SSN": "202-02-0002",
"Sex": "Female",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"EmailAddresses": [
"alen.Smith@test.net"
],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hill Street",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": []
},
"AppointmentInfo": []
},
{
"VisitNumber": "1236",
"AccountNumber": null,
"VisitDateTime": "2016-08-01T12:00:00Z",
"PatientClass": null,
"Status": null,
"Duration": "15",
"Reason": "Follow Up",
"CancelReason": null,
"LastUpdated": null,
"ScheduledDateTime": null,
"CancelDateTime": null,
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "2434534567",
"IDType": "NPI",
"FirstName": "Mathew",
"LastName": "Daniels",
"Credentials": [
"MD",
"PhD"
],
"Address": {
"StreetAddress": "45 NeoStar Suite 10",
"City": "San Jose",
"State": "CA",
"ZIP": "53593",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085559999"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ConsultingProvider": {
"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
}
},
"VisitProvider": {
"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
}
},
"Location": {
"Type": null,
"Facility": null,
"Department": "Clinic A",
"Room": null
},
"AdditionalStaff": [],
"Diagnoses": [],
"Equipment": [],
"Patient": {
"Identifiers": [
{
"ID": "0000000003",
"IDType": "MR"
},
{
"ID": "b10e9d73-401e-423a-9a00-9f476760d5e5",
"IDType": "EHRID"
},
{
"ID": "d5db12eb-4ed8-45cf-953e-8d3655a87f92",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Neil",
"MiddleName": null,
"LastName": "Steward",
"DOB": "1945-03-04",
"SSN": "303-03-0003",
"Sex": "Male",
"Race": "Black",
"IsHispanic": true,
"Religion": null,
"MaritalStatus": "Widowed",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675310",
"Office": null,
"Mobile": null
},
"EmailAddresses": [
"neil@test.net"
],
"Language": "es",
"Citizenship": [],
"Address": {
"StreetAddress": "0987 Sun Trance",
"City": "San Jose",
"State": "CA",
"ZIP": "91301",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": []
},
"AppointmentInfo": []
}
]
}