Query

Description

The ReferralQuery allows searching for matching referral records using a subset of patient demographic and insurance information.

API endpoints for Query

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

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

Data Model JSON for Query

Query - Sample Payload

{
   "Meta": {
      "DataModel": "Referral",
      "EventType": "Query",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "e458dbaa-607f-4d16-a38f-96efbf2c73ac",
            "Name": "Destintions EMR"
         }
      ],
      "Logs": [
         {
            "ID": "e55e3620-9e6d-4c84-9ac6-19e4484cb611",
            "AttemptID": "dfc63222-9275-434a-a31b-95c6bf4e5a57"
         }
      ],
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "73322559-f7f0-4cf7-8dd6-8f23b5316b74",
            "IDType": "EHRID"
         },
         {
            "ID": "47c6879a-133f-413a-8ddf-659d5f7a0543",
            "IDType": "NIST"
         }
      ],
      "Insurances": [
         {
            "Plan": {
               "ID": "31572",
               "IDType": "Payor ID",
               "Name": "HMO Plan",
               "Type": null
            },
            "MemberNumber": null,
            "Company": {
               "ID": "60054",
               "IDType": null,
               "Name": "aetna (60054 0131)",
               "Address": {
                  "StreetAddress": "PO Box 14080",
                  "City": "San Jose"",
                  "State": "CA",
                  "ZIP": "40512-4079",
                  "County": "Santa Clara",
                  "Country": "USA"
               },
               "PhoneNumber": "+18089541123"
            },
            "GroupNumber": "847025-024-0009",
            "GroupName": "Digitech Labs",
            "EffectiveDate": "2015-01-01",
            "ExpirationDate": "2020-12-31",
            "PolicyNumber": "9140860055",
            "Priority": null,
            "AgreementType": null,
            "CoverageType": null,
            "Insured": {
               "Identifiers": [],
               "LastName": null,
               "MiddleName": null,
               "FirstName": null,
               "SSN": null,
               "Relationship": null,
               "DOB": null,
               "Sex": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}