QueryResponse

Description

The format of the response for a Results Query will depend on the specific system you are integrating with. However, generally, the response may include the following elements or components: Results data: This may include the actual results that match the query criteria, such as laboratory test results, imaging reports, or other types of results.

API endpoints for Result Query Response

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/results/query-response.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for QueryResponse

QueryResponse - Sample Payload

{
   "Meta": {
      "DataModel": "Results",
      "EventType": "QueryResponse",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
             "ID": "f00ea13d-7d64-4974-919b-169abeaca8e1",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "947e5c3f-b955-4988-9a49-701edd4e6421",
            "AttemptID": "e6e3bbaf-94df-430a-b9d1-10b5f009e4cf"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Orders": [
      {
         "Patient": {
            "Identifiers": [
               {
                  "ID": "000000001",
                  "IDType": "MRN"
               }
            ]
         },
         "Visit": {
            "VisitNumber": 1234567
         },
         "LastUpdated": null,
         "ID": "157968300",
         "ApplicationOrderID": null,
         "TransactionDateTime": "2015-05-06T06:00:58.872Z",
         "CollectionDateTime": "2015-05-06T06:00:58.872Z",
         "CompletionDateTime": "2015-05-06T06:00:58.872Z",
         "Notes": [],
         "ResultsStatus": "Final",
         "Procedure": {
            "Code": "49086-2",
            "Codeset": null,
            "Description": "Maternal screen"
         },
         "Provider": {
            "NPI": "4356789876",
            "ID": null,
            "IDType": null,
            "FirstName": "James",
            "LastName": "Frank",
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         "ResultCopyProviders": [],
         "Status": "Resulted",
         "ResponseFlag": "Associated Segments",
         "Priority": "Stat",
         "Results": [
            {
               "Code": "TEST0001",
               "Codeset": null,
               "Description": "Cystic Fibrosis",
               "RelatedGroupID": null,
               "Specimen": {
                  "Source": null,
                  "BodySite": null,
                  "ID": null
               },
               "Value": "Positive Result",
               "ValueType": "String",
               "CompletionDateTime": null,
               "FileType": null,
               "Units": null,
               "Notes": [
                  "This individual is a carrier for Cystic Fibrosis."
               ],
               "AbnormalFlag": "Very Abnormal",
               "Status": "Final",
               "PrimaryResultsInterpreter": {
                  "NPI": null,
                  "ID": null,
                  "IDType": null,
                  "FirstName": null,
                  "LastName": null,
                  "Credentials": [],
                  "Address": {
                     "StreetAddress": null,
                     "City": null,
                     "State": null,
                     "ZIP": null,
                     "County": null,
                     "Country": null
                  },
                  "EmailAddresses": [],
                  "PhoneNumber": {
                     "Office": null
                  },
                  "Location": {
                     "Type": null,
                     "Facility": null,
                     "Department": null,
                     "Room": null
                  }
               },
               "Producer": {
                  "ID": "RL001",
                  "Name": "City Lab WI",
                  "IDType": null,
                  "Address": {
                     "StreetAddress": "222 W. Goodrich Way",
                     "City": "San Jose"",
                     "State": "CA",
                     "ZIP": "53703",
                     "County": "Santa Clara",
                     "Country": "USA"
                  }
               },
               "Performer": {
                  "ID": null,
                  "IDType": null,
                  "FirstName": "Bobby",
                  "LastName": "Grant",
                  "Credentials": [
                     "MD"
                  ],
                  "Address": {
                     "StreetAddress": null,
                     "City": null,
                     "State": null,
                     "ZIP": null,
                     "County": null,
                     "Country": null
                  },
                  "EmailAddresses": [],
                  "PhoneNumber": {
                     "Office": null
                  },
                  "Location": {
                     "Type": null,
                     "Facility": null,
                     "Department": null,
                     "Room": null
                  }
               },
               "ReferenceRange": {
                  "Low": null,
                  "High": null,
                  "Text": null
               },
               "ObservationMethod": {
                  "Code": null,
                  "Codeset": null,
                  "Description": null
               }
            },
            {
               "Code": "TEST0004",
               "Codeset": null,
               "Description": "Carnitine Deficiency",
               "RelatedGroupID": null,
               "Specimen": {
                  "Source": null,
                  "BodySite": null,
                  "ID": null
               },
               "Value": "Negative Result",
               "ValueType": "String",
               "CompletionDateTime": null,
               "FileType": null,
               "Units": null,
               "Notes": [],
               "AbnormalFlag": "Normal",
               "Status": "Final",
               "PrimaryResultsInterpreter": {
                  "NPI": null,
                  "ID": null,
                  "IDType": null,
                  "FirstName": null,
                  "LastName": null,
                  "Credentials": [],
                  "Address": {
                     "StreetAddress": null,
                     "City": null,
                     "State": null,
                     "ZIP": null,
                     "County": null,
                     "Country": null
                  },
                  "EmailAddresses": [],
                  "PhoneNumber": {
                     "Office": null
                  },
                  "Location": {
                     "Type": null,
                     "Facility": null,
                     "Department": null,
                     "Room": null
                  }
               },
               "Producer": {
                  "ID": "RL001",
                  "Name": "City Lab WI",
                  "IDType": null,
                  "Address": {
                     "StreetAddress": "222 W. FairchilGoodrich Way",
                     "City": "San Jose"",
                     "State": "CA",
                     "ZIP": "53703",
                     "County": "Santa Clara",
                     "Country": "USA"
                  }
               },
               "Performer": {
                  "ID": null,
                  "IDType": null,
                  "FirstName": "Bobby",
                  "LastName": "Grant",
                  "Credentials": [
                     "MD"
                  ],
                  "Address": {
                     "StreetAddress": null,
                     "City": null,
                     "State": null,
                     "ZIP": null,
                     "County": null,
                     "Country": null
                  },
                  "EmailAddresses": [],
                  "PhoneNumber": {
                     "Office": null
                  },
                  "Location": {
                     "Type": null,
                     "Facility": null,
                     "Department": null,
                     "Room": null
                  }
               },
               "ReferenceRange": {
                  "Low": null,
                  "High": null,
                  "Text": null
               },
               "ObservationMethod": {
                  "Code": null,
                  "Codeset": null,
                  "Description": null
               }
            }
         ]
      }
   ]
}