PUT api/v1/{EMRSystem}/Appointments/{AppointmentId}
Updates an existing Appointment.
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| AppointmentId |
Appointment Identifier |
string |
Required |
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmAppointmentUpdateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
The identifier of the user creating the Appointment. |
string |
Required |
| AppointmentDetails |
Appointment Details |
Collection of AppointmentDetail |
None. |
| Comments |
Appointment Comments |
string |
None. |
| EncounterId |
Encounter Identifier |
string |
None. |
| EncounterIdType |
Encounter Identifier Type |
string |
None. |
| ReasonComments |
Reason Comments for appointment modification |
string |
None. |
| ReasonId |
Reason for appointment modification |
string |
Required if EMRSystem = Cerner |
| Slots |
Sets the Slot details |
Collection of Slot |
None. |
| StatusId |
Appointment Status Identifier |
string |
None. |
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. |
Request Formats
application/json
{
"UserId": "sample string 1",
"AppointmentDetails": [
{
"FieldId": "sample string 1",
"Response": "sample string 2"
},
{
"FieldId": "sample string 1",
"Response": "sample string 2"
}
],
"AppointmentId": "sample string 2",
"Comments": "sample string 3",
"EncounterId": "sample string 4",
"EncounterIdType": "sample string 5",
"ReasonComments": "sample string 6",
"ReasonId": "sample string 7",
"Slots": [
{
"AppointmentSlotId": "sample string 1",
"DateTime": "2025-12-12",
"Duration": "sample string 2",
"LocationId": "sample string 3",
"ResourceId": "sample string 4"
},
{
"AppointmentSlotId": "sample string 1",
"DateTime": "2025-12-12",
"Duration": "sample string 2",
"LocationId": "sample string 3",
"ResourceId": "sample string 4"
}
],
"StatusId": "sample string 8",
"LoginId": "sample string 10",
"Password": "sample string 11",
"EmrInstance": "sample string 12",
"ApplicationName": "sample string 13",
"ApplicationKey": null,
"AuthorizationToken": "sample string 15",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
None.
Response Codes
Http Status Code 204 - Indicates that the request was processed successfully.
Http Status Code 404 - Indicates that the resource to update could not be found.
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
null