GET Population Documents

Developer Tools

GET api/v1/{EMRSystem}/Population/Documents

Returns the Documents of all statuses for all patients for a given date range and filtered, optionally, by Locations (facilities) or DocumentTypes.

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

Released

Athena

In Dev

Cerner

Released

Meditech

Released

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

DocumentCategories

Gets or sets the document categories.

string

None

DocumentTypes

Gets or sets the document types.

string

None

LocationList

Gets or sets the location list.

string

None

IncludeBody

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

boolean

None

UserId

Gets or sets the user identifier.

string

Required

FromDateTime

Gets or sets from date time.

date

Required if EMRSystem = Cerner, or Epic, or Meditech

ToDateTime

Gets or sets to date time.

date

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a List of population based Documents.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

DocumentId

Gets or sets the document identifier.

string

None.

DocumentDateTime

Gets or sets the document date time.

date

None.

DocumentTitle

Gets or sets the document title.

string

None.

DocumentType

Gets or sets the document type.

string

None.

DocumentStatus

Gets or sets the document status.

string

None.

OrderId

Gets or sets the order identifier.

string

None.

ActiveInd

Gets or sets a value indicating whether [active ind].

boolean

None.

AuthorId

Gets or sets the identifier of the author.

string

None.

AuthorName

Gets or sets the name of the author.

string

None.

DocumentFormat

Gets or sets the document format.

string

None.

Documents

Gets or sets the children document.

Collection of ChildDocumentViewModel

None.

CreatedUpdatedDateTime

Gets or sets the created updated date time.

date

None.

Patient

Gets or sets the patient.

BasePatientViewModel

None.

Encounter

Gets or sets the encounter.

EncounterViewModel

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.PopulationDocumentResponseViewModel

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
[
  {
    "DocumentId": "sample string 1",
    "DocumentDateTime": "2018-02-14T21:35:06.4485369Z",
    "DocumentTitle": "sample string 2",
    "DocumentType": "sample string 3",
    "DocumentStatus": "sample string 4",
    "OrderId": "sample string 5",
    "ActiveInd": true,
    "AuthorId": "sample string 6",
    "AuthorName": "sample string 7",
    "DocumentFormat": "sample string 8",
    "Documents": [
      {
        "DocumentId": "sample string 1",
        "DocumentDateTime": "2018-02-14T21:35:06.4485369Z",
        "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-14T21:35:06.4485369Z",
        "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"
      }
    ],
    "CreatedUpdatedDateTime": "2018-02-14T21:35:06.4485369Z",
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "sample string 7",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2018-02-14T21:35:06.4485369Z",
      "DischargeDateTime": "2018-02-14T21:35:06.4485369Z",
      "FinancialNumber": "sample string 2",
      "Location": {
        "Bed": "sample string 1",
        "Unit": "sample string 2",
        "Hospital": "sample string 3",
        "Room": "sample string 4"
      }
    }
  },
  {
    "DocumentId": "sample string 1",
    "DocumentDateTime": "2018-02-14T21:35:06.4485369Z",
    "DocumentTitle": "sample string 2",
    "DocumentType": "sample string 3",
    "DocumentStatus": "sample string 4",
    "OrderId": "sample string 5",
    "ActiveInd": true,
    "AuthorId": "sample string 6",
    "AuthorName": "sample string 7",
    "DocumentFormat": "sample string 8",
    "Documents": [
      {
        "DocumentId": "sample string 1",
        "DocumentDateTime": "2018-02-14T21:35:06.4485369Z",
        "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-14T21:35:06.4485369Z",
        "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"
      }
    ],
    "CreatedUpdatedDateTime": "2018-02-14T21:35:06.4485369Z",
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "sample string 7",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2018-02-14T21:35:06.4485369Z",
      "DischargeDateTime": "2018-02-14T21:35:06.4485369Z",
      "FinancialNumber": "sample string 2",
      "Location": {
        "Bed": "sample string 1",
        "Unit": "sample string 2",
        "Hospital": "sample string 3",
        "Room": "sample string 4"
      }
    }
  }
]
Sample Message
<ArrayOfPopulationDocumentResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <PopulationDocumentResponseViewModel>
    <ActiveInd>true</ActiveInd>
    <AuthorId>sample string 6</AuthorId>
    <AuthorName>sample string 7</AuthorName>
    <CreatedUpdatedDateTime>2018-02-14T15:35:06.4485369-06:00</CreatedUpdatedDateTime>
    <DocumentDateTime>2018-02-14T15:35:06.4485369-06:00</DocumentDateTime>
    <DocumentFormat>sample string 8</DocumentFormat>
    <DocumentId>sample string 1</DocumentId>
    <DocumentStatus>sample string 4</DocumentStatus>
    <DocumentTitle>sample string 2</DocumentTitle>
    <DocumentType>sample string 3</DocumentType>
    <Documents xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ChildDocumentViewModel>
        <d3p1:ActiveInd>true</d3p1:ActiveInd>
        <d3p1:Body>sample string 8</d3p1:Body>
        <d3p1:BodyLength>sample string 9</d3p1:BodyLength>
        <d3p1:DocumentDateTime>2018-02-14T15:35:06.4485369-06:00</d3p1:DocumentDateTime>
        <d3p1:DocumentId>sample string 1</d3p1:DocumentId>
        <d3p1:DocumentPointer>sample string 5</d3p1:DocumentPointer>
        <d3p1:DocumentStatus>sample string 4</d3p1:DocumentStatus>
        <d3p1:DocumentTitle>sample string 2</d3p1:DocumentTitle>
        <d3p1:DocumentType>sample string 3</d3p1:DocumentType>
        <d3p1:Format>sample string 7</d3p1:Format>
        <d3p1:Storage>sample string 6</d3p1:Storage>
      </d3p1:ChildDocumentViewModel>
      <d3p1:ChildDocumentViewModel>
        <d3p1:ActiveInd>true</d3p1:ActiveInd>
        <d3p1:Body>sample string 8</d3p1:Body>
        <d3p1:BodyLength>sample string 9</d3p1:BodyLength>
        <d3p1:DocumentDateTime>2018-02-14T15:35:06.4485369-06:00</d3p1:DocumentDateTime>
        <d3p1:DocumentId>sample string 1</d3p1:DocumentId>
        <d3p1:DocumentPointer>sample string 5</d3p1:DocumentPointer>
        <d3p1:DocumentStatus>sample string 4</d3p1:DocumentStatus>
        <d3p1:DocumentTitle>sample string 2</d3p1:DocumentTitle>
        <d3p1:DocumentType>sample string 3</d3p1:DocumentType>
        <d3p1:Format>sample string 7</d3p1:Format>
        <d3p1:Storage>sample string 6</d3p1:Storage>
      </d3p1:ChildDocumentViewModel>
    </Documents>
    <Encounter xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:DischargeDateTime>2018-02-14T15:35:06.4485369-06:00</d3p1:DischargeDateTime>
      <d3p1:EncounterDateTime>2018-02-14T15:35:06.4485369-06:00</d3p1:EncounterDateTime>
      <d3p1:EncounterId>sample string 1</d3p1:EncounterId>
      <d3p1:EncounterType>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:EncounterType>
      <d3p1:FinancialNumber>sample string 2</d3p1:FinancialNumber>
      <d3p1:Location>
        <d3p1:Bed>sample string 1</d3p1:Bed>
        <d3p1:Hospital>sample string 3</d3p1:Hospital>
        <d3p1:Room>sample string 4</d3p1:Room>
        <d3p1:Unit>sample string 2</d3p1:Unit>
      </d3p1:Location>
      <d3p1:PatientClass>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:PatientClass>
    </Encounter>
    <OrderId>sample string 5</OrderId>
    <Patient xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:BirthDateTime>sample string 7</d3p1:BirthDateTime>
      <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:Gender>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Gender>
      <d3p1:LastName>sample string 3</d3p1:LastName>
      <d3p1:MRN>sample string 6</d3p1:MRN>
      <d3p1:MiddleName>sample string 5</d3p1:MiddleName>
      <d3p1:PatientId>sample string 1</d3p1:PatientId>
    </Patient>
  </PopulationDocumentResponseViewModel>
  <PopulationDocumentResponseViewModel>
    <ActiveInd>true</ActiveInd>
    <AuthorId>sample string 6</AuthorId>
    <AuthorName>sample string 7</AuthorName>
    <CreatedUpdatedDateTime>2018-02-14T15:35:06.4485369-06:00</CreatedUpdatedDateTime>
    <DocumentDateTime>2018-02-14T15:35:06.4485369-06:00</DocumentDateTime>
    <DocumentFormat>sample string 8</DocumentFormat>
    <DocumentId>sample string 1</DocumentId>
    <DocumentStatus>sample string 4</DocumentStatus>
    <DocumentTitle>sample string 2</DocumentTitle>
    <DocumentType>sample string 3</DocumentType>
    <Documents xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ChildDocumentViewModel>
        <d3p1:ActiveInd>true</d3p1:ActiveInd>
        <d3p1:Body>sample string 8</d3p1:Body>
        <d3p1:BodyLength>sample string 9</d3p1:BodyLength>
        <d3p1:DocumentDateTime>2018-02-14T15:35:06.4485369-06:00</d3p1:DocumentDateTime>
        <d3p1:DocumentId>sample string 1</d3p1:DocumentId>
        <d3p1:DocumentPointer>sample string 5</d3p1:DocumentPointer>
        <d3p1:DocumentStatus>sample string 4</d3p1:DocumentStatus>
        <d3p1:DocumentTitle>sample string 2</d3p1:DocumentTitle>
        <d3p1:DocumentType>sample string 3</d3p1:DocumentType>
        <d3p1:Format>sample string 7</d3p1:Format>
        <d3p1:Storage>sample string 6</d3p1:Storage>
      </d3p1:ChildDocumentViewModel>
      <d3p1:ChildDocumentViewModel>
        <d3p1:ActiveInd>true</d3p1:ActiveInd>
        <d3p1:Body>sample string 8</d3p1:Body>
        <d3p1:BodyLength>sample string 9</d3p1:BodyLength>
        <d3p1:DocumentDateTime>2018-02-14T15:35:06.4485369-06:00</d3p1:DocumentDateTime>
        <d3p1:DocumentId>sample string 1</d3p1:DocumentId>
        <d3p1:DocumentPointer>sample string 5</d3p1:DocumentPointer>
        <d3p1:DocumentStatus>sample string 4</d3p1:DocumentStatus>
        <d3p1:DocumentTitle>sample string 2</d3p1:DocumentTitle>
        <d3p1:DocumentType>sample string 3</d3p1:DocumentType>
        <d3p1:Format>sample string 7</d3p1:Format>
        <d3p1:Storage>sample string 6</d3p1:Storage>
      </d3p1:ChildDocumentViewModel>
    </Documents>
    <Encounter xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:DischargeDateTime>2018-02-14T15:35:06.4485369-06:00</d3p1:DischargeDateTime>
      <d3p1:EncounterDateTime>2018-02-14T15:35:06.4485369-06:00</d3p1:EncounterDateTime>
      <d3p1:EncounterId>sample string 1</d3p1:EncounterId>
      <d3p1:EncounterType>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:EncounterType>
      <d3p1:FinancialNumber>sample string 2</d3p1:FinancialNumber>
      <d3p1:Location>
        <d3p1:Bed>sample string 1</d3p1:Bed>
        <d3p1:Hospital>sample string 3</d3p1:Hospital>
        <d3p1:Room>sample string 4</d3p1:Room>
        <d3p1:Unit>sample string 2</d3p1:Unit>
      </d3p1:Location>
      <d3p1:PatientClass>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:PatientClass>
    </Encounter>
    <OrderId>sample string 5</OrderId>
    <Patient xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:BirthDateTime>sample string 7</d3p1:BirthDateTime>
      <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:Gender>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Gender>
      <d3p1:LastName>sample string 3</d3p1:LastName>
      <d3p1:MRN>sample string 6</d3p1:MRN>
      <d3p1:MiddleName>sample string 5</d3p1:MiddleName>
      <d3p1:PatientId>sample string 1</d3p1:PatientId>
    </Patient>
  </PopulationDocumentResponseViewModel>
</ArrayOfPopulationDocumentResponseViewModel>

Submit a Comment

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

 

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