Subscriptions R5 Backport
1.1.0 - Standard for Trial Use International flag

This page is part of the Subscriptions R5 Backport (v1.1.0: STU 1.1) based on FHIR v4.3.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: R4B Topic-Based Subscription Server Capability Statement

Official URL: http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server Version: 1.1.0
Active as of 2020-11-30 Computable Name: BackportSubscriptionCapabilityStatement

CapabilityStatement describing the required and optional capabilities of a FHIR Server supporting backported R5 Subscriptions in R4B.

This CapabilityStatement describes the expected capabilities of a FHIR R4B server supporting this Implementation Guide.

Raw OpenAPI-Swagger Definition file | Download

FHIR RESTful Capabilities by Resource/Profile:

Summary

Resource TypeSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
SubscriptionTopic-url, derived-or-self, resource, title, trigger-description---
SubscriptionBackported R5 Subscriptionurl, status--$status, $events, $get-ws-binding-token

SubscriptionTopic

Conformance Expectation: SHALL

Interactions:

  • A Server SHALL be capable of returning a SubscriptionTopic resource using: GET [base]/SubscriptionTopic/[id]
  • A Server SHALL be capable of searching for SubscriptionTopic resources using: GET [base]/SubscriptionTopic/?[parameters]

Search Parameter Summary:

ConformanceParameterType
SHALLurluri
SHALLderived-or-selfuri
SHOULDresourceuri
SHOULDtitlestring
SHOULDtrigger-descriptionstring

Subscription

Conformance Expectation: SHALL

Supported Profiles:

Operation Summary:

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Subscription resource using: GET [base]/Subscription/[id]
  • A Server SHOULD be capable of creating a Subscription resource using either: POST [base]/Subscription or PUT [base]/Subscription/[id]
  • A Server SHOULD be capable of modifying a Subscription resource using either: PUT [base]/Subscription/[id] or PATCH [base]/Subscription/[id]
  • A Server SHOULD be capable of deleting a Subscription resource using: DELETE [base]/Subscription/[id]
  • A Server SHOULD be capable of searching for Subscription resources using: GET [base]/Subscription/?[parameters]

Search Parameter Summary:

ConformanceParameterType
SHOULDurluri
SHOULDstatustoken