Healthcare / FHIR API

FHIR Subscriptions

FHIR R4

Receive real-time notifications when subscribed FHIR resources change.

Open in API Explorer

Authentication

OAuth 2.0

Bearer token

Scope

healthcare.read

Required

Standard

HL7 FHIR R4

FHIR R4

Rate limit

600 requests / min

Default

Response

Bundle / JSON

application/fhir+json

Subscription lifecycle

Step	Description
Create	Register criteria and channel
Active	Receive matching notifications
Update	Change criteria or endpoint
Delete	Stop future notifications

Create subscription

Subscription

POST https://api.mediloop.com/fhir/r4/Subscription
{
 "resourceType":"Subscription",
 "status":"requested",
 "criteria":"Observation?patient=pat_123",
 "channel":{"type":"rest-hook","endpoint":"https://example.com/fhir-events"}
}

Filtering

Criteria use supported FHIR search semantics. Keep subscriptions narrow enough to avoid unnecessary event traffic.

Delivery behavior

FHIR subscription events use reliable webhook delivery with retries; consumers must process events idempotently.

Security

Webhook signature verification →

Event example

Notification

{
 "event":"fhir.resource.updated",
 "resourceType":"Observation",
 "resourceId":"obs_123",
 "versionId":"4"
}