POST api/v1/{EMRSystem}/LabResults
Creates new Lab Result
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmLabResultsCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
Gets or sets the patient identifier. |
string |
Required |
| PatientIdTypeId |
Gets or sets the patient type identifier. |
string |
None. |
| OrderId |
Gets or sets the order identifier. |
string |
None. |
| OrderStatusId |
Gets or sets the order status identifier. |
string |
None. |
| ReferenceNumber |
Gets or sets the reference number. |
string |
None. |
| ResultGroupStatusId |
Gets or sets the result group status id. |
string |
None. |
| ResultGroupComponentId |
Gets or sets the result group component id. |
string |
None. |
| ResultGroupDateTime |
Gets or sets the result group date time. |
datetime |
None. |
| AccessionNumber |
Gets or sets the accession number. |
string |
None. |
| SystemId |
Gets or sets the system identifier. |
string |
None. |
| SourceId |
Gets or sets the source identifier. |
string |
None. |
| Identifiers |
Gets or sets the identifiers. |
Collection of Identifier |
None. |
| Specimen |
Gets or sets the specimen details. |
SpecimenCreate |
None. |
| ResultGroups |
Gets or sets the result group details |
Collection of ResultGroupCreate |
Required |
| UnsolicitedResultOrderInformation |
Gets or sets the unsolicited result order information. |
UnsolicitedResultOrderInformation |
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",
"PatientIdTypeId": "sample string 3",
"OrderId": "sample string 4",
"OrderStatusId": "sample string 5",
"ReferenceNumber": "sample string 6",
"ResultGroupStatusId": "sample string 7",
"ResultGroupComponentId": "sample string 8",
"ResultGroupDateTime": "2025-12-12T21:04:05.0303539+00:00",
"AccessionNumber": "sample string 9",
"SystemId": "sample string 10",
"SourceId": "sample string 11",
"Identifiers": [
{
"CodeId": "sample string 1",
"TypeId": "sample string 2"
},
{
"CodeId": "sample string 1",
"TypeId": "sample string 2"
}
],
"Specimen": {
"ReceivedDateTime": "2025-12-12T21:04:05.0311435+00:00",
"CollectedDateTime": "2025-12-12T21:04:05.0311934+00:00",
"SourceTypeId": "sample string 1",
"ContainerTypeId": "sample string 2",
"BodySiteId": "sample string 3",
"CollectedByProviderId": "sample string 4"
},
"ResultGroups": [
{
"Comments": "sample string 1",
"ComponentId": "sample string 2",
"Flag": "sample string 3",
"Identifiers": [
{
"CodeId": "sample string 1",
"TypeId": "sample string 2"
},
{
"CodeId": "sample string 1",
"TypeId": "sample string 2"
}
],
"NormalHigh": "sample string 4",
"NormalLow": "sample string 5",
"Normalcy": "sample string 6",
"PerformingLabId": "sample string 7",
"ResultDateTime": "2025-12-12T21:04:05.0317175+00:00",
"ResultValue": "sample string 8",
"StatusId": "sample string 9",
"UnitId": "sample string 10"
},
{
"Comments": "sample string 1",
"ComponentId": "sample string 2",
"Flag": "sample string 3",
"Identifiers": [
{
"CodeId": "sample string 1",
"TypeId": "sample string 2"
},
{
"CodeId": "sample string 1",
"TypeId": "sample string 2"
}
],
"NormalHigh": "sample string 4",
"NormalLow": "sample string 5",
"Normalcy": "sample string 6",
"PerformingLabId": "sample string 7",
"ResultDateTime": "2025-12-12T21:04:05.0317175+00:00",
"ResultValue": "sample string 8",
"StatusId": "sample string 9",
"UnitId": "sample string 10"
}
],
"UnsolicitedResultOrderInformation": {
"EncounterId": "sample string 1",
"EncounterIdTypeId": "sample string 2",
"OrderableId": "sample string 3",
"OrderDateTime": "2025-12-12T21:04:05.0322499+00:00",
"OrderingProviderId": "sample string 4",
"OrderingProviderTypeId": "sample string 5"
},
"LoginId": "sample string 13",
"Password": "sample string 14",
"EmrInstance": "sample string 15",
"ApplicationName": "sample string 16",
"ApplicationKey": null,
"AuthorizationToken": "sample string 18",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmLabResultsCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ResultIds |
Gets or sets the result ids. |
Collection of 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
{
"ResultIds": [
"sample string 1",
"sample string 2"
]
}