Events for Pub/Sub
The following are business events for CIE Generation 2 processing of service requests and discovery of social services
Introduction
The following are events that will be published for the community of information exchange. This events will be able to be subscribed to based on the authorization level. Please note that this will be our generation two events that will have a more structured record keeping in our analytics data.
Every object will have metadata associated with it the following will be the meta data
Attribute | Description | Example |
|---|---|---|
event | This will be the short text identifier of what the business event happened. | ServiceRequest_v2 |
title | This will a short description of the business event. | Service Request Created |
description | This will be a longer description of the business event. This may also have other information that | The creation of a service request within the system. A Service Request represents a request from a client of the CIE to retrieve a service from a provider. |
dateTimeOccured | This will be the time and date of the event. |
|
The following will be break down the events by category. Those categories are the following
Events based on the creation of FHIR objects within the system
The following are events based on the creation and delation of FHIR objects within the system
Event | Title | Description |
|---|---|---|
ServiceRequest_v2 | Service Request Created | The creation of a service request within the system. A Service Request represents a request from a client of the CIE to retrieve a service from a provider. |
Observation_v2 | Observation Created | A observation has been created in the CIE. A observation represents |
Consent_v2 | Consent Created | The creation of a Consent object within the system |
Patient_v2 | Patient Created | This will be when a Patient was created in the system |
HealthcareService_v2 | HealthCare Service Created | When a HealthCareService has been added to the system. These will be based off the Open Referral database of social services. |
Organization_v2 | Organization Created | When a Organization has been added to the system. A organization can be a organization that is in the Open Referral System, a client and integrator of the CIE Hub, or one of the Michigan 211 Regions. |
Procedure_v2 | Intervention Created | A procedure is when a service has been given to a Patient within the system. This is the same as a Gravity Project term intervention. |
Task_v2 | Task Created | This will be a task that was generated |
CarePlan_v2 | Care Plan Created |
|
Events that are based on patient record maintenance
The following are events based on the modification and processing of patient records.
Event | Description |
|---|---|
DeDuplicationSystemCheck_v2 | The following will be raised when a check has been made to our de duplication processing engine |
DeDuplicationResolved_v2 | This occurs when a manual process has resolved a the deduplication of two or more records |
PatientModified_v2 | When a patient record has been modified by a outside system. |
Events that are based on tasks or actions that are being performed for Service Request
The following are events that are raised based on the processing of a service request and the
Event | Title | Description |
|---|---|---|
PerformerNotficationTask_v2 | Creation of Task for Notifing Performer | This will be when a task has been created for the system to send a notification to a performer of the service. |
SubjectNotficationTask_v2 | Creation of Task for Notifing Subject | This will be when a task has been created for the system to send a notification to a subject (Patient, Person) of the service. |
PerformerNotified_v2 | Performer Has Been Notified | This will be when a performer has been notified about a ServiceRequest |
SubjectNotified_v2 | Subject has been notified | This will be when the subject has been notified |
TaskModified_v2 | Task has been Modified | This is when the status of the task has changed |
ServiceRequestStatusChanged_v1 | Service Request Status Changed | A status change has been detected in the |
TaskStatusChanged_v2 | Task (Member Ticket status has changed) | The status on the member ticket has changed. |
Events that are based on the discovery of social services in the directory
The following describes the events that will be raised based on clients and users looking for and searching the social services directory and discovering services.
Event | Description |
|---|---|
Recommendation_v2 | This is when a recommendation has been given to the client of the API. Please note that this is a array of two objects. The observations that where passed in the zero to many services. |
RecommendationLinkedPatient_v2 | When a recommendation has been linked to a patient record when in the system. |