Skip to content

Subscription resource (FHIR R4)

Subscription is the FHIR R4 resource for the subscription resource is used to define a push-based subscription from a server to another system.

ResourceSubscription
FHIR versionR4 (4.0.1)
Canonical URLhttp://hl7.org/fhir/StructureDefinition/Subscription
Required elementsstatus (1..1), reason (1..1), criteria (1..1), channel (1..1)
IG profiles in this catalog1

Example

{
  "resourceType": "Subscription",
  "id": "subscription-a98d9cb87f033433bf6bcabe674bfcc8",
  "status": "requested",
  "reason": "Notify care coordination when an encounter begins.",
  "criteria": "Encounter?status=in-progress",
  "channel": {
    "type": "rest-hook",
    "payload": "application/fhir+json"
  }
}

Generated by the Pidgeon engine: pidgeon generate Subscription --seed 20260722.

Validation context

  • strict pidgeon validate grades a Subscription instance against the base R4 structure definition: missing required elements raise REQUIRED_FIELD_MISSING and cardinality violations raise CARDINALITY_MIN or CARDINALITY_MAX.(REQUIRED_FIELD_MISSING)
  • strict Profile validation grades the same instance against an installed IG profile: profile cardinality findings carry FHIR-PROFILE-CARDINALITY and terminology binding findings carry FHIR-PROFILE-BINDING.(FHIR-PROFILE-CARDINALITY)

This answer, in your terminal

pidgeon lookup Subscription

Wire it into your AI agent:

claude mcp add pidgeon -- npx -y @pidgeonhealth/mcp

Download Post free to browse this reference with generation attached.

FHIR® R4 © Health Level Seven International. FHIR R4 specification content is used under its CC0 license; this page is a derivative work and is not endorsed by HL7 International.

HL7® and FHIR® are registered trademarks of Health Level Seven International.

Published by Pattern Engine LLC (Pidgeon Health).

Rendered from the same machine-readable definitions the Pidgeon engine validates against. Exported from the Pidgeon engine's FHIR R4 definitions (CC0); example generated with seed 20260722.