Visit Query

Description

The VisitQuery is used to retrieve and return visit summaries for a specific patient within a specified health system, for a particular time period.

API endpoints for Visit Query

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/clinical-summary/visit-query.

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

Data Model JSON for Visit Query

Visit Query - Sample Payload

{
   "Meta": {
      "DataModel": "Clinical Summary",
      "EventType": "VisitQuery",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "949b9ae4-5362-493c-994d-9b2b63f61ead",
            "Name": "Visit Query Endpoint"
         }
      ],
      "Logs": [
         {
            "ID": "ec441177-f83c-4a4d-a57a-935e44474ff6",
            "AttemptID": "c632ad71-6d8a-4704-8442-cb5bf0a61d9f"
         }
      ],
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "a1d4ee8aba494ca",
            "IDType": "NIST"
         }
      ]
   },
   "Visit": {
      "VisitNumber": "4325235",
      "StartDateTime": "2005-02-21T00:00:00.000Z",
      "EndDateTime": null
   }
}