Business Context > Business Data

Business Data

The Business Data section of this Implementation Guide defines the core business data entities and relationships among these entities for publish-subscribe (pub-sub) framework.

Subscription Conceptual Data Model

The following diagram outlines relationships among key data entities in the Subscription model. It's definition and suggested attributes are well aligned with proposed Enterprise Pub Sub Physical Design design which specifies the content and structure of data stores, data requirements and message interfaces.

R5 Backport Subscription Data Model

Data Entity Defintion

Entity Name Description FHIR Resource
Subscriber The entity (e.g., a system, application, or user) that wants to receive event notifications. N/A
Subscription Structured set of data that enables a system to track and manage subscriber requests for receiving real-time notifications about changes to specific data, specifying the conditions under which updates will be delivered.
This entity encapsulate key attributes defining Subscription concept. Following attributes are aligned with OH Pub Sub physical data model:
  • subscription ID
  • channelType
  • content
  • contentType
  • endpoint
  • filterCriteria
  • reason
  • resourceType
  • status
  • heartBeat period
  • timeout
  • topic
  • event
    		• Subscription
    Subscription Status Contains information about the event, including timestamps and sequence numbers.
    This entity encapsulate key attributes defining Subscription Status. Following attributes are aligned with OH Pub Sub physical data model
  • status code (requested, active, off)
  • status notification type (handshake, heart beat, event notification
  • notification Event
    		• Subscription Status
    Event A defined category of events (e.g., patient-admission, medication-update).
    This entity encapsulate key attributes defining Event concept. Following attributes are aligned with OH Pub Sub physical data model
  • ID
  • description
  • resource
  • trigger
  • status
  • title
  • url
  • publisher
  • notification Shape
    		• Bundle.event.resource
    Publisher The system or entity that publishes events to a FHIR Topic when a relevant change occurs. N/A
    Notification Infromation sent to a Subscriber when an event is published to a Topic. N/A
    Topic The logical container for the same type of events (e.g., Admissions, Observations) capable of filtering the events by predefined set of filter criteria (e.g., patient, type of reports, etc.). Subscription.Criteria
    Delivery Channel mechanism through which messages (events, notifications, or data) are transmitted from a publisher to subscribers (e.g., rest hooks, websockets). Subscription.Channel