Subscriptions R5 Backport
1.2.0-ballot - ballot

Subscriptions R5 Backport, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-subscription-backport-ig/ and changes regularly. See the Directory of published versions

## CapabilityStatement: R4 Topic-Based Subscription Server Capability Statement

Official URL: http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server-r4 | Version: 1.2.0-ballot
Standards status: Trial-use | Computable Name: BackportSubscriptionCapabilityStatementR4

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

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

Raw OpenAPI-Swagger Definition file | Download

## R4 Topic-Based Subscription Server Capability Statement

- Implementation Guide Version: 1.2.0-ballot
- FHIR Version: 4.0.1
- Supported Formats: `xml`, `json`
- Supported Patch Formats:
- Published on: 2020-11-30
- 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

- http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport

## 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 Type | Profile | R | S | U | C | D | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Subscription | Supported Profiles R4/B Topic-Based Subscription | y |  | y | y | y | url, status |  |  | `$status`, `$events`, `$get-ws-binding-token`
Basic |  | y |  | y | y | y | code |  |  |

#### Resource Conformance: SHALL Subscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary

- SHALLsupport `read`.
- SHOULDsupport `create`, `update`, `delete`.

Supported Profiles

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | url | `uri` |
SHOULD | status | `token` |

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $status |
MAY | $events |
MAY | $get-ws-binding-token |

#### Resource Conformance: SHOULD Basic

Core FHIR Resource
Basic
Reference Policy
Interaction summary

- SHOULDsupport `read`.
- MAYsupport `create`, `update`, `delete`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHOULD | code | `token` |