DELETE Appointments

Developer Tools

DELETE api/v1/{EMRSystem}/Appointments/{AppointmentId}

Deletes the appointment for the appointment identifier specified.

HTTP Method

DELETE

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Meditech

In Dev

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

AppointmentId

The Id of the appointment.

string

Required

UserId

Gets or sets the user identifier.

string

Required

UserType

Gets or sets the type of the user.

UserType

None

Reason

Gets or sets the reason.

string

None

Comment

Gets or sets the comment.

string

None

Domain

Gets or sets the domain (***required for Cerner only***). This Domain will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if EMRSystem = Cerner

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 Sandbox

Password

Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if EMRSystem = Allscripts, or Athena, or Cerner, 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

Required if using application keys

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing status code denoting if the Delete request was successful or not.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

 
Response Codes

Http Status Code 205 – Reset Content

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

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
Sample Message
Download Json Schema
Not Applicable
Sample Message
Not Applicable

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?