Data Models & Event Types

Data Models and Event Types define the type of information that can be communicated between a source and destination via the Redox platform. Specifically:

  • Data Models represent the categories of data that can be transacted
  • Event Types define specific interactions or data structures for a given Data Model

Data Models

Data Models describe the categories of data that can be transacted via Redox. Every workflow implemented via Redox must involve a combination of supported data models.

Data Model Reference

Available Data Models and Event Types can be found on our data model reference documentation here: https://developer.redoxengine.com/data-models/

Event Types

Event Types describe the interactions or data structures that a source and destination system can exchange for a specific data model. As such, each event type is primarily asynchronous (one-way) or synchronous (two-way) in nature.

Asychronous Event Types

Asynchronous event types describe a triggering event or a data action (similar to CRUD actions).

Examples of asynchronous event types are: New, Update, Delete, Replace, Arrival, etc…

These event types are primarily used for one-way, event-based data streams where systems SEND or RECEIVE data.

Check out our video explanation

Synchronous Event Types

Synchronous event types describe a request that expects a response, such as a query for data, and thus are primarily used for REQUEST or RESPOND actions.

Most often these event types contain the words Query or Response. A full list of these event types for each data model is included below for reference:

Data ModelSynchronous Event Types
Clinical SummaryPatientQuery (PatientQueryResponse),
VisitQuery (VisitQueryResponse),
DocumentQuery (DocumentQueryResponse),
DocumentGet (DocumentGetResponse)
Clinical DecisionsRequest (Response)
MediaQuery (QueryResponse)
NotesQuery (QueryResponse)
OrderQuery (QueryResponse)
OrganizationQuery (QueryResponse)
PatientAdminCensusQuery (CensusQueryResponse),
VisitQuery (VisitQueryResponse)
PatientSearchQuery (QueryResponse),
LocationQuery (LocationQueryResponse)
ProviderProviderQuery (ProviderQueryResponse)
ReferralQuery (QueryResponse)
ResultsQuery (QueryResponse)
SchedulingAvailableSlots (AvailableSlotsResponse),
Booked (BookedSlotsResponse)
SSOSign-On
VaccinationPatientQuery (PatientQueryResponse)
(-Response) Types

All types mentioned in parentheses above with a “Response” suffix are used to document the expected return format of data from a destination response (log type RESPOND). They are not separate event types.

The Redox platform (via API or Dashboard) will only ever accept or display the event types without a “Response” suffix.