Query Response

Description

This is the format of the response you will receive for a Order:Query.

API endpoints for Order Query Response

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

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

Data Model JSON for Query Response

Query Response - Sample Payload

{
   "Meta": {
      "DataModel": "Order",
      "EventType": "QueryResponse",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "985b23c1-45bc-43a4-8ee8-5598c9e91e80",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "2fca1ee7-8582-4192-bc91-5a20fcf19d60",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "5016388a-856a-4657-844e-8ab98c217268",
            "AttemptID": "44fa157d-a48c-47cc-b309-ae042d146999"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Orders": [
      {
         "Patient": {
            "Identifiers": [
               {
                  "ID": "0000000001",
                  "IDType": "MR"
               },
               {
                 "ID": "3570592f-f859-496b-b1b1-b03bb7172d18",
               "IDType": "EHRID"
            },
            {
               "ID": "02698f4b-5187-4fc7-8b91-a7a86d931ff4",
               "IDType": "NIST"
               }
            ]
         },
         "Visit": {
            "VisitNumber": 1234
         },
         "ID": "1578300",
         "ApplicationOrderID": null,
         "Status": "New",
         "TransactionDateTime": "2015-05-06T06:00:58.872Z",
         "CollectionDateTime": "2015-05-06T06:00:58.872Z",
         "Specimen": {
            "Source": null,
            "BodySite": null,
            "ID": null
         },
         "Procedure": {
            "Code": "49086-2",
            "Codeset": null,
            "Description": "Second trimester maternal screen translucency panel"
         },
         "Provider": {
            "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
            }
         },
         "ResultCopyProviders": [],
         "OrderingFacility": {
            "Name": null,
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "PhoneNumber": null
         },
         "Priority": "Stat",
         "Comments": null,
         "Notes": [],
         "Diagnoses": [
            {
               "Code": "Z31.41",
               "Codeset": "ICD-10",
               "Name": "Fertility testing Encounter",
               "Type": null,
               "DocumentedDateTime": null
            }
         ],
         "ClinicalInfo": [
            {
               "Code": "QUESTION001",
               "Codeset": null,
               "Description": "Estimated Due Date",
               "Value": "2015-10-05",
               "Units": null,
               "Abbreviation": null,
               "Notes": []
            },
            {
               "Code": "QUESTION002",
               "Codeset": null,
               "Description": "Ethnicity",
               "Value": "White",
               "Units": null,
               "Abbreviation": "W",
               "Notes": []
            },
            {
               "Code": "QUESTION010",
               "Codeset": null,
               "Description": "Is this a twin pregnancy?",
               "Value": "Singleton",
               "Units": null,
               "Abbreviation": "sng",
               "Notes": []
            },
            {
               "Code": "QUESTION011",
               "Codeset": null,
               "Description": "Dating Method",
               "Value": "LMP",
               "Units": null,
               "Abbreviation": "lmp",
               "Notes": []
            }
         ]
      }
   ]
}