GET Documents by Id

Developer Tools

HTTP Method

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

Released

Athena

Released

Cerner

Released

Meditech

Released

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

Unique Id associated with a specific document.

string

Required

UserId

Unique user identification.

string

Required

IncludeBody

Gets or sets a value indicating whether [include body].

boolean

None

 
Body Parameters
None
 

Response Information

 
Resource Description
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
Sample Message
Download Json Schema
{
  "DocumentAudits": [
    {
      "ActionType": "sample string 1",
      "ActionDateTime": "2018-02-13T21:04:10.0992993Z",
      "ActionStatus": "sample string 2",
      "ActionPractitioner": "sample string 3",
      "ActionPractitionerId": "sample string 4"
    },
    {
      "ActionType": "sample string 1",
      "ActionDateTime": "2018-02-13T21:04:10.0992993Z",
      "ActionStatus": "sample string 2",
      "ActionPractitioner": "sample string 3",
      "ActionPractitionerId": "sample string 4"
    }
  ],
  "Documents": [
    {
      "DocumentId": "sample string 1",
      "DocumentDateTime": "2018-02-13T21:04:10.1149248Z",
      "DocumentTitle": "sample string 2",
      "DocumentType": "sample string 3",
      "DocumentStatus": "sample string 4",
      "DocumentPointer": "sample string 5",
      "ActiveInd": true,
      "Storage": "sample string 6",
      "Format": "sample string 7",
      "Body": "sample string 8",
      "BodyLength": "sample string 9"
    },
    {
      "DocumentId": "sample string 1",
      "DocumentDateTime": "2018-02-13T21:04:10.1149248Z",
      "DocumentTitle": "sample string 2",
      "DocumentType": "sample string 3",
      "DocumentStatus": "sample string 4",
      "DocumentPointer": "sample string 5",
      "ActiveInd": true,
      "Storage": "sample string 6",
      "Format": "sample string 7",
      "Body": "sample string 8",
      "BodyLength": "sample string 9"
    }
  ],
  "DocumentId": "sample string 1",
  "DocumentDateTime": "2018-02-13T21:04:10.1149248Z",
  "DocumentTitle": "sample string 2",
  "DocumentType": "sample string 3",
  "DocumentStatus": "sample string 4",
  "PatientId": "sample string 5",
  "EncounterId": "sample string 6",
  "EncounterType": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "PatientClass": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "OrderId": "sample string 7",
  "ActiveInd": true,
  "AuthorName": "sample string 8",
  "DocumentFormat": "sample string 9"
}
Sample Message
<DocumentResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ActiveInd xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">true</ActiveInd>
  <AuthorName xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 8</AuthorName>
  <DocumentDateTime xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">2018-02-13T15:04:10.1149248-06:00</DocumentDateTime>
  <DocumentFormat xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 9</DocumentFormat>
  <DocumentId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 1</DocumentId>
  <DocumentStatus xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 4</DocumentStatus>
  <DocumentTitle xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 2</DocumentTitle>
  <DocumentType xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 3</DocumentType>
  <EncounterId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 6</EncounterId>
  <EncounterType xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </EncounterType>
  <OrderId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 7</OrderId>
  <PatientClass xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </PatientClass>
  <PatientId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 5</PatientId>
  <DocumentAudits xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:DocumentAuditViewModel>
      <d2p1:ActionDateTime>2018-02-13T15:04:10.0992993-06:00</d2p1:ActionDateTime>
      <d2p1:ActionPractitioner>sample string 3</d2p1:ActionPractitioner>
      <d2p1:ActionPractitionerId>sample string 4</d2p1:ActionPractitionerId>
      <d2p1:ActionStatus>sample string 2</d2p1:ActionStatus>
      <d2p1:ActionType>sample string 1</d2p1:ActionType>
    </d2p1:DocumentAuditViewModel>
    <d2p1:DocumentAuditViewModel>
      <d2p1:ActionDateTime>2018-02-13T15:04:10.0992993-06:00</d2p1:ActionDateTime>
      <d2p1:ActionPractitioner>sample string 3</d2p1:ActionPractitioner>
      <d2p1:ActionPractitionerId>sample string 4</d2p1:ActionPractitionerId>
      <d2p1:ActionStatus>sample string 2</d2p1:ActionStatus>
      <d2p1:ActionType>sample string 1</d2p1:ActionType>
    </d2p1:DocumentAuditViewModel>
  </DocumentAudits>
  <Documents xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:ChildDocumentViewModel>
      <d2p1:ActiveInd>true</d2p1:ActiveInd>
      <d2p1:Body>sample string 8</d2p1:Body>
      <d2p1:BodyLength>sample string 9</d2p1:BodyLength>
      <d2p1:DocumentDateTime>2018-02-13T15:04:10.1149248-06:00</d2p1:DocumentDateTime>
      <d2p1:DocumentId>sample string 1</d2p1:DocumentId>
      <d2p1:DocumentPointer>sample string 5</d2p1:DocumentPointer>
      <d2p1:DocumentStatus>sample string 4</d2p1:DocumentStatus>
      <d2p1:DocumentTitle>sample string 2</d2p1:DocumentTitle>
      <d2p1:DocumentType>sample string 3</d2p1:DocumentType>
      <d2p1:Format>sample string 7</d2p1:Format>
      <d2p1:Storage>sample string 6</d2p1:Storage>
    </d2p1:ChildDocumentViewModel>
    <d2p1:ChildDocumentViewModel>
      <d2p1:ActiveInd>true</d2p1:ActiveInd>
      <d2p1:Body>sample string 8</d2p1:Body>
      <d2p1:BodyLength>sample string 9</d2p1:BodyLength>
      <d2p1:DocumentDateTime>2018-02-13T15:04:10.1149248-06:00</d2p1:DocumentDateTime>
      <d2p1:DocumentId>sample string 1</d2p1:DocumentId>
      <d2p1:DocumentPointer>sample string 5</d2p1:DocumentPointer>
      <d2p1:DocumentStatus>sample string 4</d2p1:DocumentStatus>
      <d2p1:DocumentTitle>sample string 2</d2p1:DocumentTitle>
      <d2p1:DocumentType>sample string 3</d2p1:DocumentType>
      <d2p1:Format>sample string 7</d2p1:Format>
      <d2p1:Storage>sample string 6</d2p1:Storage>
    </d2p1:ChildDocumentViewModel>
  </Documents>
</DocumentResponseViewModel>

Submit a Comment

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

 

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