GET Population Encounters

Developer Tools

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

Returns all Patient Encounters activity for all patients for a given date range and filtered, optionally, by a list of locations (facilities).

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

In Dev

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

LocationList

Gets or sets the location list.

string

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 Encounters.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EncounterId

Gets or sets the encounter identifier.

string

None.

EncounterType

Gets or sets the type of the encounter.

CodedObjectViewModel

None.

PatientClass

Gets or sets the patient class.

CodedObjectViewModel

None.

EncounterDateTime

Gets or sets the encounter date time.

date

None.

DischargeDateTime

Gets or sets the discharge date time.

date

None.

CreatedUpdatedDateTime

Gets or sets the created updated date time.

date

None.

FinancialNumber

Gets or sets the financial number.

string

None.

EncounterAlias

Gets or sets the encounter alias.

string

None.

EncounterStatus

Gets or sets the encounter status.

string

None.

AttendingProvider

Gets or sets the attending provider.

ProviderViewModel

None.

MedicalService

Gets or sets the medical service.

string

None.

ReasonForVisit

Gets or sets the reason for visit.

string

None.

AdmissionSource

Gets or sets the admission source.

string

None.

DischargeDisposition

Gets or sets the reason for discharge disposition.

string

None.

Location

Gets or sets the location.

LocationViewModel

None.

Patient

Gets the patient.

BasePatientViewModel

None.

 
Response Codes

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

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
[
  {
    "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:42:27.1287704Z",
    "DischargeDateTime": "2018-02-14T21:42:27.1287704Z",
    "CreatedUpdatedDateTime": "2018-02-14T21:42:27.1287704Z",
    "FinancialNumber": "sample string 2",
    "EncounterAlias": "sample string 3",
    "EncounterStatus": "sample string 4",
    "AttendingProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "MedicalService": "sample string 5",
    "ReasonForVisit": "sample string 6",
    "AdmissionSource": "sample string 7",
    "DischargeDisposition": "sample string 8",
    "Location": {
      "Bed": "sample string 1",
      "Unit": "sample string 2",
      "Hospital": "sample string 3",
      "Room": "sample string 4"
    },
    "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"
      }
    }
  },
  {
    "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:42:27.1287704Z",
    "DischargeDateTime": "2018-02-14T21:42:27.1287704Z",
    "CreatedUpdatedDateTime": "2018-02-14T21:42:27.1287704Z",
    "FinancialNumber": "sample string 2",
    "EncounterAlias": "sample string 3",
    "EncounterStatus": "sample string 4",
    "AttendingProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "MedicalService": "sample string 5",
    "ReasonForVisit": "sample string 6",
    "AdmissionSource": "sample string 7",
    "DischargeDisposition": "sample string 8",
    "Location": {
      "Bed": "sample string 1",
      "Unit": "sample string 2",
      "Hospital": "sample string 3",
      "Room": "sample string 4"
    },
    "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"
      }
    }
  }
]
Sample Message
<ArrayOfPopulationEncounterResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <PopulationEncounterResponseViewModel>
    <AdmissionSource>sample string 7</AdmissionSource>
    <AttendingProvider xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
      <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
    </AttendingProvider>
    <CreatedUpdatedDateTime>2018-02-14T15:42:27.1287704-06:00</CreatedUpdatedDateTime>
    <DischargeDateTime>2018-02-14T15:42:27.1287704-06:00</DischargeDateTime>
    <DischargeDisposition>sample string 8</DischargeDisposition>
    <EncounterAlias>sample string 3</EncounterAlias>
    <EncounterDateTime>2018-02-14T15:42:27.1287704-06:00</EncounterDateTime>
    <EncounterId>sample string 1</EncounterId>
    <EncounterStatus>sample string 4</EncounterStatus>
    <EncounterType xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </EncounterType>
    <FinancialNumber>sample string 2</FinancialNumber>
    <Location xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <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>
    </Location>
    <MedicalService>sample string 5</MedicalService>
    <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>
    <PatientClass xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </PatientClass>
    <ReasonForVisit>sample string 6</ReasonForVisit>
  </PopulationEncounterResponseViewModel>
  <PopulationEncounterResponseViewModel>
    <AdmissionSource>sample string 7</AdmissionSource>
    <AttendingProvider xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
      <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
    </AttendingProvider>
    <CreatedUpdatedDateTime>2018-02-14T15:42:27.1287704-06:00</CreatedUpdatedDateTime>
    <DischargeDateTime>2018-02-14T15:42:27.1287704-06:00</DischargeDateTime>
    <DischargeDisposition>sample string 8</DischargeDisposition>
    <EncounterAlias>sample string 3</EncounterAlias>
    <EncounterDateTime>2018-02-14T15:42:27.1287704-06:00</EncounterDateTime>
    <EncounterId>sample string 1</EncounterId>
    <EncounterStatus>sample string 4</EncounterStatus>
    <EncounterType xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </EncounterType>
    <FinancialNumber>sample string 2</FinancialNumber>
    <Location xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <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>
    </Location>
    <MedicalService>sample string 5</MedicalService>
    <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>
    <PatientClass xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </PatientClass>
    <ReasonForVisit>sample string 6</ReasonForVisit>
  </PopulationEncounterResponseViewModel>
</ArrayOfPopulationEncounterResponseViewModel>

Submit a Comment

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

 

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