New
Description
A New message can be generated and sent outbound from the EHR when an appointment is booked, indicating that a new appointment has been scheduled. Similarly, an application can generate and post a New message inbound to the EHR to schedule an appointment, indicating that a new appointment request has been received and needs to be processed by the EHR system.
API endpoints for New
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/scheduling/new.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Intraconnects Unified Model
| Event Type | IntraConnects Request | Data Type | Athena Request |
|---|---|---|---|
| New | Meta.DataModel | String | Scheduling |
| New | Meta.EventType | String | New |
| New | Meta.EventDateTime | DateTime | |
| New | Meta.Test | Boolean | |
| New | Meta.Source | String | |
| New | Meta.Source.ID | String | |
| New | Meta.Source.Name | String | |
| New | Patient.Identifiers[] | Array of Objects | |
| New | Patient.Identifiers[].ID | String | patientid |
| New | Patient.Identifiers[].IDType | String | PatientID |
| New | Patient.Identifiers[].ID | String | appointmenttypeid |
| New | Patient.Identifiers[].IDType | String | |
| New | Patient.Demographics.FirstName | String | |
| New | Patient.Demographics.MiddleName | String | |
| New | Patient.Demographics.LastName | String | |
| New | Patient.Demographics.DOB | String | |
| New | Patient.Demographics.SSN | String | |
| New | Patient.Demographics.Sex | String | |
| New | Patient.Demographics.Race | String | |
| New | Patient.Demographics.IsHispanic | Boolean | |
| New | Patient.Demographics.Religion | String | |
| New | Patient.Demographics.MaritalStatus | String | |
| New | Patient.Demographics.IsDeceased | Boolean | |
| New | Patient.Demographics.DeathDateTime | DateTime | |
| New | Patient.Demographics.PhoneNumber.Home | String | |
| New | Patient.Demographics.PhoneNumber.Office | String | |
| New | Patient.Demographics.PhoneNumber.Mobile | String | |
| New | Patient.Demographics.EmailAddresses[] | Array of Strings | |
| New | Patient.Demographics.Language | String | |
| New | Patient.Demographics.Citizenship[] | Array of Strings | |
| New | Patient.Demographics.Address | Object | |
| New | Patient.Demographics.Address.StreetAddress | String | |
| New | Patient.Demographics.Address.City | String | |
| New | Patient.Demographics.Address.State | String | |
| New | Patient.Demographics.Address.ZIP | String | |
| New | Patient.Demographics.Address.County | String | |
| New | Patient.Demographics.Address.Country | String | |
| New | Patient.Notes[] | Array of Strings | |
| New | AppointmentInfo[] | Array of Objects | |
| New | AppointmentInfo[].Code | String | |
| New | AppointmentInfo[].Codeset | String | |
| New | AppointmentInfo[].Description | String | |
| New | AppointmentInfo[].Value | String | |
| New | Visit.VisitNumber | String | appointmentid |
| New | Visit.AccountNumber | String | |
| New | Visit.VisitDateTime | String | |
| New | Visit.PatientClass | String | |
| New | Visit.Status | String | |
| New | Visit.Duration | Numeric | |
| New | Visit.Reason | String | |
| New | Visit.Type | Object | |
| New | Visit.Type.ID | String | |
| New | Visit.Type.Name | String | |
| New | Visit.Instructions[] | Array of Strings | |
| Visit.Instructions[].AppointmentTitle | |||
| Visit.Instructions[].AppointmentHomeText | |||
| New | Visit.AttendingProvider.ID | String | |
| New | Visit.AttendingProvider.IDType | String | |
| New | Visit.AttendingProvider.FirstName | String | |
| New | Visit.AttendingProvider.LastName | String | |
| New | Visit.AttendingProvider.Credentials[] | Array of Strings | |
| New | Visit.AttendingProvider.Address | Object | |
| New | Visit.AttendingProvider.Address.StreetAddress | String | |
| New | Visit.AttendingProvider.Address.City | String | |
| New | Visit.AttendingProvider.Address.State | String | |
| New | Visit.AttendingProvider.Address.ZIP | String | |
| New | Visit.AttendingProvider.Address.County | String | |
| New | Visit.AttendingProvider.Address.Country | String | |
| New | Visit.AttendingProvider.EmailAddresses[] | Array of Strings | |
| New | Visit.AttendingProvider.PhoneNumber.Office | String | |
| New | Visit.AttendingProvider.Location | Object | |
| New | Visit.AttendingProvider.Location.Type | String | |
| New | Visit.AttendingProvider.Location.Facility | String | |
| New | Visit.AttendingProvider.Location.Department | String | |
| New | Visit.AttendingProvider.Location.Room | String | |
| New | Visit.ConsultingProvider.ID | String | |
| New | Visit.ConsultingProvider.IDType | String | |
| New | Visit.ConsultingProvider.FirstName | String | |
| New | Visit.ConsultingProvider.LastName | String | |
| New | Visit.ConsultingProvider.Credentials[] | Array of Strings | |
| New | Visit.ConsultingProvider.Address | Object | |
| New | Visit.ConsultingProvider.Address.StreetAddress | String | |
| New | Visit.ConsultingProvider.Address.City | String | |
| New | Visit.ConsultingProvider.Address.State | String | |
| New | Visit.ConsultingProvider.Address.ZIP | String | |
| New | Visit.ConsultingProvider.Address.County | String | |
| New | Visit.ConsultingProvider.Address.Country | String | |
| New | Visit.ConsultingProvider.EmailAddresses[] | Array of Strings | |
| New | Visit.ConsultingProvider.PhoneNumber.Office | String | |
| New | Visit.ConsultingProvider.Location | Object | |
| New | Visit.ConsultingProvider.Location.Type | String | |
| New | Visit.ConsultingProvider.Location.Facility | String | |
| New | Visit.ConsultingProvider.Location.Department | String | |
| New | Visit.ConsultingProvider.Location.Room | String | |
| New | Visit.ReferringProvider.ID | String | |
| New | Visit.ReferringProvider.IDType | String | |
| New | Visit.ReferringProvider.FirstName | String | |
| New | Visit.ReferringProvider.LastName | String | |
| New | Visit.ReferringProvider.Credentials[] | Array of Strings | |
| New | Visit.ReferringProvider.Address | Object | |
| New | Visit.ReferringProvider.Address.StreetAddress | String | |
| New | Visit.ReferringProvider.Address.City | String | |
| New | Visit.ReferringProvider.Address.State | String | |
| New | Visit.ReferringProvider.Address.ZIP | String | |
| New | Visit.ReferringProvider.Address.County | String | |
| New | Visit.ReferringProvider.Address.Country | String | |
| New | Visit.ReferringProvider.EmailAddresses[] | Array of Strings | |
| New | Visit.ReferringProvider.PhoneNumber.Office | String | |
| New | Visit.ReferringProvider.Location | Object | |
| New | Visit.ReferringProvider.Location.Type | String | |
| New | Visit.ReferringProvider.Location.Facility | String | |
| New | Visit.ReferringProvider.Location.Department | String | |
| New | Visit.ReferringProvider.Location.Room | String | |
| New | Visit.VisitProvider.ID | String | |
| New | Visit.VisitProvider.IDType | String | |
| New | Visit.VisitProvider.FirstName | String | |
| New | Visit.VisitProvider.LastName | String | |
| New | Visit.VisitProvider.Credentials[] | Array of Strings | |
| New | Visit.VisitProvider.Address | Object | |
| New | Visit.VisitProvider.Address.StreetAddress | String | |
| New | Visit.VisitProvider.Address.City | String | |
| New | Visit.VisitProvider.Address.State | String | |
| New | Visit.VisitProvider.Address.ZIP | String | |
| New | Visit.VisitProvider.Address.County | String | |
| New | Visit.VisitProvider.Address.Country | String | |
| New | Visit.VisitProvider.EmailAddresses[] | Array of Strings | |
| New | Visit.VisitProvider.PhoneNumber.Office | String | |
| New | Visit.VisitProvider.Location | Object | |
| New | Visit.VisitProvider.Location.Type | String | |
| New | Visit.VisitProvider.Location.Facility | String | |
| New | Visit.VisitProvider.Location.Department | String | |
| New | Visit.VisitProvider.Location.Room | String | |
| New | Visit.Location | Object | |
| New | Visit.Location.Type | String | |
| New | Visit.Location.Facility | String | |
| New | Visit.Location.Department | String | departmentid |
| New | Visit.Location.Room | String | |
| New | Visit.AdditionalStaff[] | [], | |
| New | Visit.AdditionalStaff[].ID | String | |
| New | Visit.AdditionalStaff[].IDType | String | |
| New | Visit.AdditionalStaff[].FirstName | String | |
| New | Visit.AdditionalStaff[].LastName | String | |
| New | Visit.AdditionalStaff[].Credentials[] | Array of Strings | |
| New | Visit.AdditionalStaff[].Address | Object | |
| New | Visit.AdditionalStaff[].Address.StreetAddress | String | |
| New | Visit.AdditionalStaff[].Address.City | String | |
| New | Visit.AdditionalStaff[].Address.State | String | |
| New | Visit.AdditionalStaff[].Address.ZIP | String | |
| New | Visit.AdditionalStaff[].Address.County | String | |
| New | Visit.AdditionalStaff[].Address.Country | String | |
| New | Visit.AdditionalStaff[].EmailAddresses[] | Array of Strings | |
| New | Visit.AdditionalStaff[].PhoneNumber.Office | String | |
| New | Visit.AdditionalStaff[].Location | Object | |
| New | Visit.AdditionalStaff[].Location.Type | String | |
| New | Visit.AdditionalStaff[].Location.Facility | String | |
| New | Visit.AdditionalStaff[].Location.Department | String | |
| New | Visit.AdditionalStaff[].Location.Room | String | |
| New | Visit.AdditionalStaff[].Role | Object | |
| New | Visit.AdditionalStaff[].Role.Code | String | |
| New | Visit.AdditionalStaff[].Role.Codeset | String | |
| New | Visit.AdditionalStaff[].Role.Description | String | |
| New | Visit.AdditionalStaff[].StartDateTime | DateTime | |
| New | Visit.AdditionalStaff[].Duration | Numeric | |
| New | Visit.Diagnoses[] | Array of Objects | |
| New | Visit.Diagnoses[].Code | String | |
| New | Visit.Diagnoses[].Codeset | String | |
| New | Visit.Diagnoses[].Name | String | |
| New | Visit.Diagnoses[].Type | String | |
| New | Visit.Diagnoses[].DocumentedDateTime | String | |
| New | Visit.Equipment[] | Array of Objects | |
| New | Visit.Equipment[].Code | String | |
| New | Visit.Equipment[].Codeset | String | |
| New | Visit.Equipment[].Description | String | |
| New | Visit.Equipment[].StartDateTime | DateTime | |
| New | Visit.Equipment[].Duration | Numeric | |