POST Patient Care Teams

POST api/v1/{EMRSystem}/PatientCareTeams

Adds a new Patient Care Team relationship between a given user and a given patient and relationship type.

HTTP Method

POST

Applicable Emissary Products

Interactive

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Epic

In Dev

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

 
Body Parameters
The patient care team request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

Gets or sets the user identifier.

string

Required

PersonRelationshipId

Gets or sets the person relationship identifier.

string

None.

EncounterRelationshipId

Gets or sets the encounter relationship identifier.

string

None.

EncounterId

Gets or sets the type of the encounter identifier.

string

None.

BeginDateTime

Gets or sets the begin date time. If not specified, defaults to today.

date

None.

EndDateTime

Gets or sets the end date time. If not specified, defaults to the end of time.

date

None.

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

EmrInstance

Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.

string

None.

ApplicationName

Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if using application keys

ApplicationKey

Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if using application keys

 

Response Information

 
Resource Description
Http response containing PatientCareTeam Response View Model.

NAME

DESCRIPTION

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 201 – Returns Sansoro.Shared.SansoroServiceBus.Models.PatientCareTeamResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

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
{
  "UserId": "sample string 1",
  "PersonRelationshipId": "sample string 2",
  "EncounterRelationshipId": "sample string 3",
  "EncounterId": "sample string 4",
  "BeginDateTime": "2018-02-14T18:29:00.0720616Z",
  "EndDateTime": "2018-02-14T18:29:00.0720616Z",
  "Domain": "sample string 5",
  "LoginId": "sample string 6",
  "Password": "sample string 7",
  "EmrInstance": "sample string 8",
  "ApplicationName": "sample string 9",
  "ApplicationKey": "sample string 10"
}
Sample Message
<PatientCareTeamRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 10</ApplicationKey>
  <ApplicationName>sample string 9</ApplicationName>
  <Domain>sample string 5</Domain>
  <EmrInstance>sample string 8</EmrInstance>
  <LoginId>sample string 6</LoginId>
  <Password>sample string 7</Password>
  <BeginDateTime>2018-02-14T12:29:00.0720616-06:00</BeginDateTime>
  <EncounterId>sample string 4</EncounterId>
  <EncounterRelationshipId>sample string 3</EncounterRelationshipId>
  <EndDateTime>2018-02-14T12:29:00.0720616-06:00</EndDateTime>
  <PersonRelationshipId>sample string 2</PersonRelationshipId>
  <UserId>sample string 1</UserId>
</PatientCareTeamRequestViewModel>

Submit a Comment

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

 

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