GET Document Contents

Developer Tools

GET api/v1/{EMRSystem}/Documents/{DocumentId}/Content/

Returns contents of a document or clinical note in html, jpeg, pdf, or rtf format.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval

Clinical Analytics

Interactive Workflow

Allscripts

Released

Athena

In Dev

Cerner

Released

Meditech

In Dev

Sandbox

Released

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
DocumentId	The document identifier	string	Required
UserId	Gets or sets the user identifier.	string	Required
testImages	Gets or sets a value indicating whether [test images].	boolean	None
imageWidth	Gets or sets the desired width of the image in pixels.	integer	None
ContentFormat	Gets or sets the content format.	ContentFormatType	None

Body Parameters

None

Response Information

Resource Description

Http response containing Document Response View Model.

NAME	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 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.DocumentResponseViewModel

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

application/json, text/json
application/xml, text/xml

Sample Message

Download Json Schema

Not Applicable

Sample Message

Not Applicable