POST api/v1/{EMRSystem}/Observations
Adds a new Observation to a patient's chart.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmObservationCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| 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 |
None. |
| ComponentId |
Gets or sets the component identifier. |
string |
Required |
| ObservationDateTime |
Gets or sets the date/time of the observation. |
datetime |
Required |
| Value |
Gets or sets the value of the observation. |
string |
None. |
| Comment |
Gets or sets the comment on the observation. |
string |
None. |
| ValueCodes |
Gets or sets the coded values of the observation. |
Collection of string |
None. |
| SystemId |
Gets or sets the systemId of the observation. |
string |
None. |
| SourceId |
Gets or sets the sourceId of the observation. |
string |
None. |
| ReferenceNumber |
Gets or sets the reference number of the observation. |
string |
None. |
| OrderId |
Gets or sets the Order Id that is linked to the observation. |
string |
None. |
| EntryModeId |
Gets or sets the Entry Mode the observation is entered on. This is Cerner only parameter. |
string |
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",
"PatientId": "sample string 2",
"EncounterId": "sample string 3",
"TemplateId": "sample string 4",
"ComponentId": "sample string 5",
"ObservationDateTime": "2025-12-12T21:05:10.3882045+00:00",
"Value": "sample string 7",
"Comment": "sample string 8",
"ValueCodes": [
"sample string 1",
"sample string 2"
],
"SystemId": "sample string 9",
"SourceId": "sample string 10",
"ReferenceNumber": "sample string 11",
"OrderId": "sample string 12",
"EntryModeId": "sample string 13",
"LoginId": "sample string 15",
"Password": "sample string 16",
"EmrInstance": "sample string 17",
"ApplicationName": "sample string 18",
"ApplicationKey": null,
"AuthorizationToken": "sample string 20",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmObservationCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ObservationId |
Gets or sets the observation identifier. |
string |
None. |
Response Codes
Http Status Code 201 - Indicates that the requested record was successfully created.
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
{
"ObservationId": "sample string 1"
}