PatientQuery

Description

The query mentioned is typically used to find a patient's vaccinations based on demographic data, such as patient identifiers (e.g., name, date of birth), address, phone number, or other relevant patient information. The purpose of this query is to search for vaccination records for a specific patient based on their demographics.

API endpoints for Patient Query

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

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

Data Model JSON for PatientQuery

PatientQuery - Sample Payload

{
   "Meta": {
      "DataModel": "Vaccination",
      "EventType": "PatientQuery",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "9b71f2a7-8a8e-443d-b9bd-b31d015d337a",
            "Name": "Vaccination Endpoint"
         }
      ],
      "Logs": [
         {
            "ID": "1a5f90b5-a3a4-41dc-81df-c672c4c79201",
            "AttemptID": "5ff2d5bd-f7c9-464b-828c-46bbea687b65"
         }
      ],
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "2f6e8339-ab93-41af-bc4b-b8638b534df6 ",
            "IDType": "EHRID"
         },
         {
            "ID": "f81655e1-f381-4329-a523-cdec01f286c7",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "James",
         "MiddleName": "Alex",
         "LastName": "Smith",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Hill Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   }
}