Create a subscription

A subscription links a source, destination, and data model to define how and what data is exchanged between two organizations. Learn about subscriptions. We support creating a one-party subscription, which means your organization needs to own both the source and destination.

Specifically, this article is for cloud connectivity users who want to hydrate a cloud environment. For non-cloud users, learn how to request a connection instead to expand your integration with a new or existing partner.

• A user must be assigned to an engineer role to create a subscription. Learn about user roles.
• Create a source that sends and normalizes your HL7v2 feed to FHIR®. Learn how to set up sources.
• Create and verify your cloud destination. Learn how to set up destinations. Your source and cloud destination must be fully configured (i.e., not “in progress” status) before you can create a subscription.

Follow these steps to create a new subscription to hydrate your cloud environment.

1. Log in to the Redox dashboard.
2. From the navigation menu, click the Connections page.
3. Click either the Connected orgs or All subscriptions tab. From either tab, click the New subscription button in the top-right corner.

   

   
4. A modal opens. Fill out these fields:
   1. Subscription name: Enter a human-readable name for the subscription.
   2. Source: From the drop-down options, select the source that will initiate the data exchange.
   3. Destination: From the drop-down options, select the destination where the data will be delivered.
   4. Data models: From the list, select Redox FHIR® data model(s). Or, you can type in names to filter the list. A new subscription is created for each data model you select. In other words, if you select 2 data models, 2 subscriptions are created. You can create up to 6 subscriptions at a time.

      What’s a Redox data model?

      As a reminder, a Redox data model is the schema that will be used to normalize data during the exchange. FHIR® data models start are prepended with FHIR®.

      Unique combinations for subscriptions

      A subscription must have a unique combination of source, destination, and data model. In other words, you can’t have two subscriptions with the same source, destination, and data model.

      You could use the same source and destination in multiple subscriptions, but then the data model must be unique.

      See these API specs to see a full list of available FHIR® data models.
      1. Redox FHIR® API resources
      2. Redox FHIR® notifications
5. Click the Create button.

   
6. The new subscription appears in the table. You can edit the subscription name or review any subscription details (including asset links) by clicking the subscription name.