Managing Subscriptions

You can register for new subscriptions on the FHIR server. There are different channel types available while registering the subscription for the notifications to be received. The subscribed entity receives a notification whenever the criteria for the subscription is met on the server. You can also view, edit, and delete the subscriptions.

Prerequisites

You must have access to the Foresight Connect with FHIR application.

Procedure

  1. Log in to the Foresight Connect with FHIR application and go to the Subscriptions tab.
  2. Enter the server URL, <fhir-server-url> in the text box and if the FHIR server is not public, click the Basic Authentication button to enter the server credentials.
  3. After you enter a public URL or after you have been authenticated, you can do any of the following tasks:
    • To see your existing subscriptions, click View Subscriptions. You can view, edit, and delete any of the subscriptions by using the options provided in each table row.
    • To register new subscriptions, click Register and enter all appropriate information to register a new subscription.
    • Select the number of subscriptions to be displayed in the table in the Show entries drop-down.
    • In the Search field, search for subscriptions by entering a string or a number.
    Note: When there are a large number of records, you might have to click the More button multiple times until there are no more records to view. After every 15 minutes of inactivity, you are redirected to the login page.

Registering a New Subscription

To register a new subscription, you must provide information about the following fields when creating a new subscription:
Field Description
Criteria Mandatory field. The rules that the server must use to determine when to generate notifications for this subscription.

For example, Observation?code=http://loinc.org|1975-2

Channel Type Mandatory field. The type of channel you want to use.
The following options are available:
  • rest-hook
  • websocket
  • email
  • message
Endpoint The URL that describes the actual endpoint to send a message to.
It depends on the channel type you select.
  • For rest-hook http: URL or https: URL
  • For email: mailto: URL, tel: URL
  • For messages: any form of URL the server understands
Note: This field is not displayed if you select the channel type as websocket.
Payload The MIME type to send.
Header Depends on the channel type you select.

A header can convey additional information to the recipient and meet security requirements.

End Date The date when the subscription must be deleted.
Contact The requester's point of contact.
Reason The reason why you want to create this subscription.