A Redox Data Model API request consists of a JSON data model and an event type. The selected data model and event type define the type of information that’s communicated to your connection. Specifically, a data model represents the category of data, while the event type defines the specific kind of interaction.
An event type is either asynchronous or synchronous.
Asynchronous event types with the Data Model API include CRUD requests like these:
- New
- Update
- Delete
- Replace
- Arrival
Check out our video explanation and learn more about handling event notifications.
When you query for data, you send a Redox data model with a query event type (e.g., PatientQuery). You then receive back the same data model with a corresponding response event type, which usually has a Response suffix (e.g., PatientQueryResponse). These response types contain the expected return format of the data you receive. These appear in your logs with the type RESPOND.
Learn more about handling synchronous queries.
The table below has a list of all the data model specs for synchronous event types (i.e., queries).
Data model | Synchronous event types |
|---|---|
ClinicalDecisions | |
ClinicalSummary | |
Media | |
Notes | |
Order | |
Organization | |
PatientAdmin | |
PatientSearch | |
Provider | |
Referral | |
Results | |
Scheduling | |
SSO* | |
Vaccination |
*This is a special synchronous event type that doesn't follow the standard query/response suffix pattern.