A request via the Redox Data Model API request comprises a JSON data model and event type. The selected data model and event type define the type of information that's communicated via the Data Model API to your integration. Specifically, a data model represents the category of data while the event type defines the specific kind of interaction. Event types are either asynchronous or synchronous. Learn more general information about each of these:
But there's a few things specific to the Data Model API that we go into below.
The asynchronous event types for the Data Model API include CRUD type of requests like New, Update, Delete, Replace, and Arrival. Check out our video explanation.
The table below has a list of all the data models you can use with asynchronous event types.
The data models with the Response suffix aren't separate requests. When querying for data, you send the data model without the suffix, and you receive back the response data model. Essentially, the Response data models contain the expected return format of data that you receive. These appear in your logs with the type
Synchronous event types
PatientQuery (PatientQueryResponse),VisitQuery (VisitQueryResponse), DocumentQuery (DocumentQueryResponse), DocumentGet (DocumentGetResponse)
CensusQuery (CensusQueryResponse), VisitQuery (VisitQueryResponse)
Query (QueryResponse), LocationQuery (LocationQueryResponse)
AvailableSlots (AvailableSlotsResponse), Booked (BookedSlotsResponse)