PUT api/v1/{EMRSystem}/Documents/{DocumentId}
Updates a Document in a patient's chart. FHIR connectors use the following resources for R4: DocumentReference.Update.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId |
The document identifier. |
string |
Required |
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmDocumentUpdateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| 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 |
| AuthorUserId |
User identifier of the author of the document if different than the UserId |
string |
None. |
| CosignerUserId |
User identifier of the requested cosigner of the document |
string |
None. |
| ServiceDepartmentId |
Identifier of the service (Epic) or department (Meditech) of the document. |
string |
None. |
| DictationDateTime |
Date/time the document was dictated |
datetime |
None. |
| TranscriptionDateTime |
Date/time the document was transcribed |
datetime |
None. |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| 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 Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, 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 |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Request Formats
application/json
{
"UserId": "sample string 1",
"DocumentId": "sample string 2",
"Status": "sample string 3",
"Description": "sample string 4",
"Format": "sample string 5",
"Body": "sample string 6",
"AuthorUserId": "sample string 7",
"CosignerUserId": "sample string 8",
"ServiceDepartmentId": "sample string 9",
"DictationDateTime": "2025-12-12T21:05:26.0094389+00:00",
"TranscriptionDateTime": "2025-12-12T21:05:26.0095131+00:00",
"LoginId": "sample string 11",
"Password": "sample string 12",
"EmrInstance": "sample string 13",
"ApplicationName": "sample string 14",
"ApplicationKey": null,
"AuthorizationToken": "sample string 16",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
None.
Response Codes
Http Status Code 204 - Indicates that the request was processed successfully.
Http Status Code 404 - Indicates that the resource to update could not be found.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
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
application/json
null