Document Metadata Subscription

From IHE Wiki
Jump to: navigation, search

Summary

This profile describes the use of subscription and notification mechanism for use within an XDS Affinity Domain and across communities. The subscription allows for the matching of metadata during the publication of a new document for a given patient, and results in the delivery of a notification. This profile is based on the OASIS WS-BaseNotification standard and, in accordance to that, defines two methods of subscription and notification:

a) In the “Push-style”method, a Document Metadata Subscriber may subscribe on behalf of the Document Metadata Notification Recipient to receive notifications about the availability of documents based on specific criteria. A Document Metadata Notification Broker keeps track of the subscriptions and sends the appropriate notifications based on the registration of objects in an XDS Document Registry. Subscriptions exist for a certain period of time and can be cancelled.

b) In the “Pull-style” method, a Notification Puller actor creates a Pull Point resource able to store notification generated by the Document Metadata Notification Broker actor. This Pull Point resource is a resource managed by the Pull Point actor that allows the storing of notification targeted to a specific recipient.Notifications stored in the Pull Point actor can be retrieved by the Notification Puller actor using a specific transaction

Benefits

This profile creates a framework for the creation and the delivery of notifications for a published document or for an update occurred to a specified folder. A Notification is created if the content published fit into specific criteria selected by the Recipient of notifications itself. The DSUB environment should involve, as recipients of notifications, systems that are behind a firewall, systems unable or unwilling to provide endpoints to which the notification creator can send notifications and systems that do not want to be notified at unpredictable times but rather at a time of their own choosing.

Details

a) Push-style: In the “Push-style” method, a Document Metadata Subscriber may subscribe on behalf of the Document Metadata Notification Recipient to receive notifications about the availability of documents based on specific criteria. A Document Metadata Notification Broker keeps track of the subscriptions and sends the appropriate notifications based on the registration of objects in an XDS Document Registry. Subscriptions exist for a certain period of time and can be cancelled. The Document Metadata Subscriber actor initiates and terminates subscriptions on behalf of a Document Metadata Notification Recipient. The Document Metadata Publisher actor sends a Document Metadata Publish transaction to the Document Metadata Notification Broker for any event for which a subscription exists. The Document Metadata Notification Broker is the receiver of the Document Metadata Subscribe transaction containing a subscription request, or a subscription cancellation. It keeps track of all subscriptions it receives, including the time limits of subscriptions. Based on the metadata associated with document registrations, this actor sends notifications to interested subscribers. This actor may optionally receive Document Metadata Publish transactions representing the stream of events against which the existing subscriptions are matched. The Document Metadata Notification Recipient actor receives the notification about an event, when the subscription filters specified for this Document Metadata Notification Recipient are satisfied.


b) Pull-style: A Notification Pull Point actor creates a Pull Point resource in response to each CreatePullPoint Request and collects all notifications destined for the requesting Notification Puller actor. Within the Notification Pull Point actor, each Pull Point resource allows the storing and managing of notifications. A Pull Point resource is associated with a Notification Puller actor. A Pull Point resource is an abstract concept that creates a relationship between a Notification Puller actor and notifications stored for that actor in the Pull Point actor. The Notification Pull Point actor serves as a Pull Point resource “factory” in processing CreatePullPoint Request messages. It can be asked to create Pull Point resources by many Notification Puller actors. The Notification Pull Point actor can manage many Pull Point resources for each Notification Puller actor. The creation of a Pull Point resource requires grouping the Notification Pull Point actor with a Document Metadata Notification Recipient for receiving notifications sent by the Document Metadata Notification Broker. If many Notification Puller actors are involved in the notification system, the Notification Pull Point actor is grouped with many Document Metadata Notification Recipient actors (see figure below). When a Notification Puller actor sends a CreatePullPoint Request message, the Notification Pull Point actor returns an endpoint in the CreatePullPoint Response message. This endpoint is associated with a Document Metadata Notification Recipient actor. The Document Metadata Notification Recipient SHALL store in the Pull Point resource the notifications received. This is an additional requirement for a Document Metadata Notification Recipient that is grouped with a Notification Pull Point actor. The Notification Puller actor uses this endpoint for subsequent transactions (subscription requests, pulling of notifications and destroying of the Pull Point resource itself).

DSUBpullstyle.png

Systems Affected

Systems involved in this profile are:

• Enterprise-wide information systems that manage a patient’s Electronic Health Record, such as a Hospital Information System;

• Laboratory Information Systems;

• Local Health Authorities application;

• GP’s EHR.


Actors & Transactions:

DSUB Actor transaction2013.png


Specification

Profile Status: Trial Implementation

Documents:

  • Vol. 1 - Section 26
  • Vol. 2b - Sections 3.52, 3.53, 3.54
  • Vol. 2c - Sections 3.69, 3.70

Underlying Standards:

  • OASIS Web Services Notification Family of Standards
  • WS-BaseNotification 1.3 OASIS Standard
  • WS-BrokeredNotification 1.3 OASIS Standard
  • WS-Topics 1.3 OASIS Standard
  • WS-BaseFault 1.2 Standard

See Also

This page is based on the Profile Template

Current: IT Infrastructure Technical Framework.