Subscriptions R5 Backport
1.2.0-ballot - ballot International flag

This page is part of the Subscriptions R5 Backport (v1.2.0-ballot: STU 1.2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v4.3.0. The current version which supersedes this version is 1.1.0. 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.2.0-ballot
Standards status: Trial-use 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

R4B Topic-Based Subscription Server Capability Statement

  • Implementation Guide Version: 1.2.0-ballot
  • FHIR Version: 4.3.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: Mon Nov 30 00:00:00 UTC 2020
  • Published by: HL7 International / FHIR Infrastructure

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCDSearches_include_revincludeOperations
SubscriptionTopic yyyyurl, derived-or-self, resource, title, trigger-description
SubscriptionSupported profiles:
  R4/B Topic-Based Subscription		yyyyurl, status$status, $events, $get-ws-binding-token

Resource Conformance: SHALLSubscriptionTopic

Core FHIR Resource
SubscriptionTopic
Reference Policy
Interaction summary
  • SHALL support read.
  • MAY support create, update, delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLderived-or-selfuri
SHOULDresourceuri
SHOULDtitlestring
SHOULDtrigger-descriptionstring
 

Resource Conformance: SHALLSubscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary
  • SHALL support read.
  • SHOULD support create, update, delete.

Supported Profiles

http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHOULDstatustoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$status
MAY$events
MAY$get-ws-binding-token