PUT Documents

Developer Tools

PUT api/v1/{EMRSystem}/Documents/{DocumentId}

Updates a Document in a patient’s chart.

HTTP Method

PUT

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

DocumentId

The document identifier.

string

Required

 
Body Parameters
The document update request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

Gets or sets the user identifier.

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.

string

Required Matching regular expression pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)$

CosignerUserId

User identifier of the requested cosigner of the document

string

None.

 

Response Information

 
Resource Description
Http response containing http status code indicating success or failure.
None
 
Response Codes

Http Status Code 204 – Indicates that the request was processed successfully.

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",
  "Status": "sample string 2",
  "Description": "sample string 3",
  "Format": "sample string 4",
  "Body": "sample string 5",
  "CosignerUserId": "sample string 6",
  "Domain": "sample string 7",
  "LoginId": "sample string 8",
  "Password": "sample string 9",
  "EmrInstance": "sample string 10",
  "ApplicationName": "sample string 11",
  "ApplicationKey": "sample string 12"
}
Sample Message
<DocumentUpdateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 12</ApplicationKey>
  <ApplicationName>sample string 11</ApplicationName>
  <Domain>sample string 7</Domain>
  <EmrInstance>sample string 10</EmrInstance>
  <LoginId>sample string 8</LoginId>
  <Password>sample string 9</Password>
  <Body>sample string 5</Body>
  <CosignerUserId>sample string 6</CosignerUserId>
  <Description>sample string 3</Description>
  <Format>sample string 4</Format>
  <Status>sample string 2</Status>
  <UserId>sample string 1</UserId>
</DocumentUpdateRequestViewModel>

Submit a Comment

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

 

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