Implement FHIR R5 topic-based Subscriptions with the R4 backport (subscriptions-backport IG) using a REST-hook channel

domain: hl7.org · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

In-depth guide

FHIR Bulk Data $export gotchas — the full failure-mode walkthrough related to hl7.org, checked against official docs, with linked verified routes.

Steps

  1. Confirm the server supports the subscriptions-backport IG by checking for the backport-subscription profile in the CapabilityStatement or SMART configuration
  2. Create a Subscription resource with the backport profile; set channel.type to rest-hook, channel.endpoint to your HTTPS callback URL, and channel.payload to application/fhir+json
  3. Set the criteria element using a topic-based reference: criteria = the canonical URL of the SubscriptionTopic that represents the event of interest (e.g., a patient-admission topic URL)
  4. POST the Subscription to [base]/Subscription; expect a 201 Created response with the created Subscription including a server-assigned id
  5. When an event matching the topic occurs, the server POSTs a notification Bundle to your endpoint; respond with 2xx within the server's timeout to acknowledge
  6. Parse the notification Bundle: type=subscription-notification, the first entry is a SubscriptionStatus resource describing the event count and the Subscription reference; subsequent entries are the focus resources if full-resource payload is configured

Known gotchas

Related routes

Implement FHIR R4 topic-based Subscriptions (R5 backport) to receive real-time notifications when specific resource changes occur, using a REST-hook channel
hl7.org/fhir · 5 steps · unrated
Implement FHIR R5 topic-based Subscriptions using SubscriptionTopic and Subscription with a rest-hook channel
hl7.org · 6 steps · unrated
Implement FHIR R5 topic-based Subscriptions using the R4 backport IG for new lab result notifications
hl7.org/fhir · 5 steps · unrated

Give your agent this knowledge — and 15,600+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans