Skip to main content

CensusQuery

Description

The CensusQuery event type enables searching for all currently admitted patients within a facility. The response includes patient demographics and visit identifying information, providing a snapshot of the patients who are currently admitted to the facility. Additional information about the patients or visits can be retrieved by following up with a PatientSearch Query or a VisitQuery event type, which allows for further querying and retrieval of specific patient or visit details from the facility's electronic health record (EHR) or other healthcare systems.

API endpoints for Census Query

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

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

Data Model JSON for CensusQuery

CensusQuery - Sample Payload
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "CensusQuery",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"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"
}
],
"FacilityCode": null
},
"PatientClasses": [
"Inpatient"
],
"Departments": [
"3N"
],
"Facilities": [
"MGM General Hospital"
]
}