POST Observations

Developer Tools

POST api/v1/{EMRSystem}/Observations

Adds new Observations and Observation details to a patient’s chart.

HTTP Method

POST

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

 
Body Parameters
The observation create request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

Gets or sets the user identifier.

string

Required

PatientId

Gets or sets the patient identifier.

string

Required

EncounterId

Gets or sets the encounter identifier.

string

Required

TemplateId

Gets or sets the template identifier.

string

Required

ComponentId

Gets or sets the component identifier.

string

Required

ObservationDateTime

Gets or sets the date/time of the observation.

date

Required

Value

Gets or sets the value of the observation.

string

Required

Comment

Gets or sets the comment on the observation.

string

None.

 

Response Information

 
Resource Description
Http response containing newly created Observation Id.

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

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",
  "PatientId": "sample string 2",
  "EncounterId": "sample string 3",
  "TemplateId": "sample string 4",
  "ComponentId": "sample string 5",
  "ObservationDateTime": "2018-02-14T17:17:18.8812914Z",
  "Value": "sample string 7",
  "Comment": "sample string 8",
  "Domain": "sample string 9",
  "LoginId": "sample string 10",
  "Password": "sample string 11",
  "EmrInstance": "sample string 12",
  "ApplicationName": "sample string 13",
  "ApplicationKey": "sample string 14"
}
Sample Message
<ObservationCreateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 14</ApplicationKey>
  <ApplicationName>sample string 13</ApplicationName>
  <Domain>sample string 9</Domain>
  <EmrInstance>sample string 12</EmrInstance>
  <LoginId>sample string 10</LoginId>
  <Password>sample string 11</Password>
  <Comment>sample string 8</Comment>
  <ComponentId>sample string 5</ComponentId>
  <EncounterId>sample string 3</EncounterId>
  <ObservationDateTime>2018-02-14T11:17:18.8812914-06:00</ObservationDateTime>
  <PatientId>sample string 2</PatientId>
  <TemplateId>sample string 4</TemplateId>
  <UserId>sample string 1</UserId>
  <Value>sample string 7</Value>
</ObservationCreateRequestViewModel>

Submit a Comment

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

 

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