GET Patient Registries Discovery

Developer Tools

GET api/v1/{EMRSystem}/PatientRegistries/Discovery

Returns the active patient registries configured in the EMR.

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
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

UserId

The identifier of the user requesting the registries

string

Required

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

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a collection of Patient Registries Discovery Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

RegistryId

The registry identifier

string

None.

RegistryName

The registry name

string

None.

RegistryType

The type of registry

CodedObjectViewModel

None.

RegistryCategory

The category of the registry

CodedObjectViewModel

None.

ValidFromDate

The date the registry became valid

date

None.

ValidToDate

The date the registy stopped/will stop being valid

date

None.

 
Response Codes

Http Status Code 200 – Returns a collection of Sansoro.Shared.SansoroServiceBus.Models.PatientRegistriesDiscoveryResponseViewModel

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
[
  {
    "RegistryId": "sample string 1",
    "RegistryName": "sample string 2",
    "RegistryType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "RegistryCategory": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ValidFromDate": "2018-02-14T20:32:30.667302Z",
    "ValidToDate": "2018-02-14T20:32:30.667302Z"
  },
  {
    "RegistryId": "sample string 1",
    "RegistryName": "sample string 2",
    "RegistryType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "RegistryCategory": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ValidFromDate": "2018-02-14T20:32:30.667302Z",
    "ValidToDate": "2018-02-14T20:32:30.667302Z"
  }
]
Sample Message
<ArrayOfPatientRegistriesDiscoveryResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <PatientRegistriesDiscoveryResponseViewModel>
    <RegistryCategory 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>
    </RegistryCategory>
    <RegistryId>sample string 1</RegistryId>
    <RegistryName>sample string 2</RegistryName>
    <RegistryType 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>
    </RegistryType>
    <ValidFromDate>2018-02-14T14:32:30.667302-06:00</ValidFromDate>
    <ValidToDate>2018-02-14T14:32:30.667302-06:00</ValidToDate>
  </PatientRegistriesDiscoveryResponseViewModel>
  <PatientRegistriesDiscoveryResponseViewModel>
    <RegistryCategory 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>
    </RegistryCategory>
    <RegistryId>sample string 1</RegistryId>
    <RegistryName>sample string 2</RegistryName>
    <RegistryType 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>
    </RegistryType>
    <ValidFromDate>2018-02-14T14:32:30.667302-06:00</ValidFromDate>
    <ValidToDate>2018-02-14T14:32:30.667302-06:00</ValidToDate>
  </PatientRegistriesDiscoveryResponseViewModel>
</ArrayOfPatientRegistriesDiscoveryResponseViewModel>

Submit a Comment

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

 

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