A request via the Redox Data Model API consists of 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 about responding to:
Asynchronous event types for the Data Model API include CRUD 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 synchronous event types (i.e., queries).
So when you query for data, you send a data model, then receive back the corresponding data model with a Response suffix. Essentially, the response data models contain the expected return format of the data you receive. These appear in your logs with the type RESPOND.
Data model | Synchronous event types |
|---|---|
ClinicalSummary | PatientQuery (PatientQueryResponse),VisitQuery (VisitQueryResponse), DocumentQuery (DocumentQueryResponse), DocumentGet (DocumentGetResponse) |
ClinicalDecisions | Request (Response) |
Media | Query (QueryResponse) |
Notes | Query (QueryResponse) |
Order | Query (QueryResponse) |
Organization | Query (QueryResponse) |
PatientAdmin | CensusQuery (CensusQueryResponse), VisitQuery (VisitQueryResponse) |
PatientSearch | Query (QueryResponse), LocationQuery (LocationQueryResponse) |
Provider | ProviderQuery (ProviderQueryResponse) |
Referral | Query (QueryResponse) |
Results | Query (QueryResponse) |
Scheduling | AvailableSlots (AvailableSlotsResponse), Booked (BookedSlotsResponse) |
SSO | Sign-on |
Vaccination | PatientQuery (PatientQueryResponse) |