CensusQueryResponse

description

The response to a Census Query is an array of patients, demographics, and visits.

API endpoints for Census Query Response

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

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

Data Model JSON for CensusQueryResponse

CensusQueryResponse - Sample Payload

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "CensusQueryResponse",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "76d19f5f-92dd-4363-a61d-31061f4fcf0d",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
            {
            "ID": "0bb4e81f-790f-455c-a060-1724661fed43",
            "Name": "667503b9-df25-419d-99dc-d62cbe451c53"
         }
      ],
      "Logs": [
         {
            "ID": "bc382848-48fd-4dda-8945-eb42f0550ef1",
            "AttemptID": "bcb60392-d9aa-466e-801e-9700eedbc621"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patients": [
      {
         "Identifiers": [
            {
               "ID": "0000000001",
               "IDType": "MR"
            },
            {
               "ID": "a01eab77-4a96-436a-a78f-c5743fde95cf",
               "IDType": "EHRID"
            },
            {
               "ID": "22339415-3ec0-4ebb-9ea0-dd0a36f9239e",
               "IDType": "NIST"
            }
         ],
         "Demographics": {
            "FirstName": "Mark",
            "MiddleName": "Calvin",
            "LastName": "Brown",
            "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 WestEnd  Street",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53566",
               "County": "Santa Clara",
               "Country": "USA"
            }
         },
         "Visits": [
            {
               "VisitNumber": "1234",
               "VisitDateTime": "2022-08-16T14:21:21.524Z",
               "PatientClass": "Inpatient",
               "Location": {
                  "Type": "Inpatient",
                  "Facility": "MGM General Hospital",
                  "Department": "3N",
                  "Room": "136",
                  "Bed": "B"
               }
            }
         ]
      }
   ]
}