POST Documents

Developer Tools

POST api/v1/{EMRSystem}/Documents

Add a new document for a given patient.

HTTP Method

POST

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Meditech

Released

Sandbox

Released

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 document 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

PatientTypeId

Sets patient Id Type Id such as MRN, FIN, etc. This is a reference Id.

string

None.

EncounterId

Gets or sets the encounter identifier.

string

Required

EncounterAlias

Gets or sets the encounter alias.

string

None.

DocumentType

Gets or sets the document type.

string

Required

DocumentDateTime

Gets or sets the document date/time.

string

Required

Status

Gets or sets the document staus.

string

Required

Description

Gets or sets the document description.

string

None.

Format

Gets or sets the document format.

string

Required

Body

Gets or sets the document body.R

string

Required

CosignerUserId

User identifier of the requested cosigner of the document

string

None.

DictationDateTime

Date/time the document was dictated

date

None.

TranscriptionDateTime

Date/time the document was transcribed

date

None.

ServiceDepartmentId

Identifier of the service or department (Meditech) of the document.

string

None.

ExternalDocumentId

Sets the external document id

string

None.

 

Response Information

 
Resource Description
Http response containing newly created Document 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.DocumentCreateResponseViewModel

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",
  "EncounterAlias": "sample string 4",
  "DocumentType": "sample string 5",
  "DocumentDateTime": "2018-02-13T21:23:20.8673272Z",
  "Status": "sample string 7",
  "Description": "sample string 8",
  "Format": "sample string 9",
  "Body": "sample string 10",
  "CosignerUserId": "sample string 11",
  "Domain": "sample string 12",
  "LoginId": "sample string 13",
  "Password": "sample string 14",
  "EmrInstance": "sample string 15",
  "ApplicationName": "sample string 16",
  "ApplicationKey": "sample string 17"
}
Sample Message
<DocumentCreateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 17</ApplicationKey>
  <ApplicationName>sample string 16</ApplicationName>
  <Domain>sample string 12</Domain>
  <EmrInstance>sample string 15</EmrInstance>
  <LoginId>sample string 13</LoginId>
  <Password>sample string 14</Password>
  <Body>sample string 10</Body>
  <CosignerUserId>sample string 11</CosignerUserId>
  <Description>sample string 8</Description>
  <DocumentDateTime>2018-02-13T15:23:20.8673272-06:00</DocumentDateTime>
  <DocumentType>sample string 5</DocumentType>
  <EncounterAlias>sample string 4</EncounterAlias>
  <EncounterId>sample string 3</EncounterId>
  <Format>sample string 9</Format>
  <PatientId>sample string 2</PatientId>
  <Status>sample string 7</Status>
  <UserId>sample string 1</UserId>
</DocumentCreateRequestViewModel>

Submit a Comment

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

 

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