GET api/v1/{EMRSystem}/Appointments
Returns a list of past and future scheduled Appointments for a given patient.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
Gets or sets the patient identifier. |
string |
Required |
| UserType |
Gets or sets the type of the user. |
UserType |
None. |
| Statuses |
Gets or sets the statuses. |
string |
None. |
| PastOrFuture |
Gets or sets the past or future. |
PastOrFuture |
None. |
| FromDateTime |
Gets or sets from date. |
datetime |
Required if EMRSystem = Athena |
| ToDateTime |
Gets or sets to date. |
datetime |
Required if EMRSystem = Athena |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Response Information
Collection of Appointment| Name | Description | Type | Additional information |
|---|---|---|---|
| EncounterId |
Gets or sets the encounter identifier. |
string |
None. |
| FinancialNumber |
Gets or sets the financial number. |
string |
None. |
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
| AppointmentId |
Gets or sets the appointment identifier. |
string |
None. |
| Status |
Gets or sets the status. |
CodedObject |
None. |
| AppointmentDateTime |
Gets or sets the date time. |
datetime |
None. |
| Duration |
Gets or sets the duration. |
string |
None. |
| VisitType |
Gets or sets the type of the visit. |
VisitType |
None. |
| PatientInstructions |
Gets or sets the patient instructions. |
string |
None. |
| AppointmentComments |
Gets or sets the appointment comments. |
string |
None. |
| ResourceDepartments |
Gets or sets the resource departments. |
Collection of ResourceDepartment |
None. |
| ConfirmedDateTime |
Gets or sets the confirmed date time. |
datetime |
None. |
| PatientCanCancel |
Gets or sets a value indicating whether [patient can cancel]. |
boolean |
None. |
| PatientCanRequestCancel |
Gets or sets a value indicating whether [patient can request cancel]. |
boolean |
None. |
| PatientCancelRequestSent |
Gets or sets a value indicating whether [patient cancel request sent]. |
boolean |
None. |
| Copay |
Gets or sets the copay. |
string |
None. |
| ECheckIn |
Gets or sets the e check in. |
ECheckIn |
None. |
| AppointmentDetails |
Gets or sets appointment details. |
Collection of FormValues |
None. |
Response Codes
Http Status Code 200 - Indicates that the request was processed successfully.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
[
{
"EncounterId": "sample string 1",
"FinancialNumber": "sample string 2",
"PatientId": "sample string 3",
"AppointmentId": "sample string 4",
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"AppointmentDateTime": "2025-12-12T20:50:10.6572321+00:00",
"Duration": "sample string 5",
"VisitType": {
"ExternalName": "sample string 1",
"VisitTypeId": "sample string 2",
"VisitTypeName": "sample string 3"
},
"PatientInstructions": "sample string 6",
"AppointmentComments": "sample string 7",
"ResourceDepartments": [
{
"Department": {
"ExternalName": "sample string 1",
"Specialty": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"Type": "sample string 8",
"TypeId": "sample string 9",
"SequenceNumber": "sample string 10",
"Country": "sample string 11",
"County": "sample string 12",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6588594+00:00"
},
"PhoneNumbers": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6601524+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6601524+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DrivingDirections": [
"sample string 1",
"sample string 2"
],
"DepartmentId": "sample string 2",
"DepartmentName": "sample string 3"
},
"Resource": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2",
"URLs": [
{
"Type": "sample string 1",
"URL": "sample string 2"
},
{
"Type": "sample string 1",
"URL": "sample string 2"
}
]
}
},
{
"Department": {
"ExternalName": "sample string 1",
"Specialty": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"Type": "sample string 8",
"TypeId": "sample string 9",
"SequenceNumber": "sample string 10",
"Country": "sample string 11",
"County": "sample string 12",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6588594+00:00"
},
"PhoneNumbers": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6601524+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6601524+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DrivingDirections": [
"sample string 1",
"sample string 2"
],
"DepartmentId": "sample string 2",
"DepartmentName": "sample string 3"
},
"Resource": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2",
"URLs": [
{
"Type": "sample string 1",
"URL": "sample string 2"
},
{
"Type": "sample string 1",
"URL": "sample string 2"
}
]
}
}
],
"ConfirmedDateTime": "2025-12-12T20:50:10.661534+00:00",
"PatientCanCancel": true,
"PatientCanRequestCancel": true,
"PatientCancelRequestSent": true,
"Copay": "sample string 8",
"ECheckIn": {
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"AvailableDate": "2025-12-12T20:50:10.6620468+00:00",
"Barcode": "sample string 1",
"ECheckInSteps": [
{
"Step": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CompletedDateTime": "2025-12-12T20:50:10.6622823+00:00"
},
{
"Step": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CompletedDateTime": "2025-12-12T20:50:10.6622823+00:00"
}
]
},
"AppointmentDetails": [
{
"Section": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"Sequence": "sample string 1",
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedValues": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
{
"Section": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"Sequence": "sample string 1",
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedValues": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextValues": [
"sample string 1",
"sample string 2"
]
}
]
},
{
"EncounterId": "sample string 1",
"FinancialNumber": "sample string 2",
"PatientId": "sample string 3",
"AppointmentId": "sample string 4",
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"AppointmentDateTime": "2025-12-12T20:50:10.6572321+00:00",
"Duration": "sample string 5",
"VisitType": {
"ExternalName": "sample string 1",
"VisitTypeId": "sample string 2",
"VisitTypeName": "sample string 3"
},
"PatientInstructions": "sample string 6",
"AppointmentComments": "sample string 7",
"ResourceDepartments": [
{
"Department": {
"ExternalName": "sample string 1",
"Specialty": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"Type": "sample string 8",
"TypeId": "sample string 9",
"SequenceNumber": "sample string 10",
"Country": "sample string 11",
"County": "sample string 12",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6588594+00:00"
},
"PhoneNumbers": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6601524+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6601524+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DrivingDirections": [
"sample string 1",
"sample string 2"
],
"DepartmentId": "sample string 2",
"DepartmentName": "sample string 3"
},
"Resource": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2",
"URLs": [
{
"Type": "sample string 1",
"URL": "sample string 2"
},
{
"Type": "sample string 1",
"URL": "sample string 2"
}
]
}
},
{
"Department": {
"ExternalName": "sample string 1",
"Specialty": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"Type": "sample string 8",
"TypeId": "sample string 9",
"SequenceNumber": "sample string 10",
"Country": "sample string 11",
"County": "sample string 12",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6588594+00:00"
},
"PhoneNumbers": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6601524+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T20:50:10.6601524+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DrivingDirections": [
"sample string 1",
"sample string 2"
],
"DepartmentId": "sample string 2",
"DepartmentName": "sample string 3"
},
"Resource": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2",
"URLs": [
{
"Type": "sample string 1",
"URL": "sample string 2"
},
{
"Type": "sample string 1",
"URL": "sample string 2"
}
]
}
}
],
"ConfirmedDateTime": "2025-12-12T20:50:10.661534+00:00",
"PatientCanCancel": true,
"PatientCanRequestCancel": true,
"PatientCancelRequestSent": true,
"Copay": "sample string 8",
"ECheckIn": {
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"AvailableDate": "2025-12-12T20:50:10.6620468+00:00",
"Barcode": "sample string 1",
"ECheckInSteps": [
{
"Step": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CompletedDateTime": "2025-12-12T20:50:10.6622823+00:00"
},
{
"Step": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CompletedDateTime": "2025-12-12T20:50:10.6622823+00:00"
}
]
},
"AppointmentDetails": [
{
"Section": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"Sequence": "sample string 1",
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedValues": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
{
"Section": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"Sequence": "sample string 1",
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedValues": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextValues": [
"sample string 1",
"sample string 2"
]
}
]
}
]