FHIRsmith: CapabilityStatement/CapabilityStatement-backport-subscription-server.json

FHIR IG analytics

Package	hl7.fhir.uv.subscriptions-backport.r4
Resource Type	CapabilityStatement
Id	CapabilityStatement-backport-subscription-server.json
FHIR Version	R4

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

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

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
SubscriptionTopic		y		y	y	y	url, derived-or-self, resource, title, trigger-description
Subscription	Supported profiles: R4/B Topic-Based Subscription	y		y	y	y	url, 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

Conformance	Parameter	Type	Documentation
SHALL	url	`uri`
SHALL	derived-or-self	`uri`
SHOULD	resource	`uri`
SHOULD	title	`string`
SHOULD	trigger-description	`string`

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

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

Extended Operations

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

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "backport-subscription-server",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server",
  "version": "1.2.0-ballot",
  "name": "BackportSubscriptionCapabilityStatement",
  "title": "R4B Topic-Based Subscription Server Capability Statement",
  "status": "active",
  "date": "2020-11-30",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "name": "HL7 International / FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "name": "Gino Canessa",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:gino.canessa@microsoft.com"
        }
      ]
    }
  ],
  "description": "CapabilityStatement describing the required and optional capabilities of a FHIR Server supporting backported R5 Subscriptions in R4B.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.0",
  "format": [
    "xml",
    "json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"
  ],
  "rest": [
    {
      "mode": "server",
      "_mode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
            "valueCode": "SHALL"
          }
        ]
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "SubscriptionTopic",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "update"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "delete"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/SubscriptionTopic-url",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "derived-or-self",
              "definition": "http://hl7.org/fhir/SearchParameter/SubscriptionTopic-derived-or-self",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "resource",
              "definition": "http://hl7.org/fhir/SearchParameter/SubscriptionTopic-resource",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "title",
              "definition": "http://hl7.org/fhir/SearchParameter/SubscriptionTopic-title",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "trigger-description",
              "definition": "http://hl7.org/fhir/SearchParameter/SubscriptionTopic-trigger-description",
              "type": "string"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Subscription",
          "supportedProfile": [
            "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
          ],
          "_supportedProfile": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ]
            }
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "delete"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/Subscription-url",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Subscription-status",
              "type": "token"
            }
          ],
          "operation": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "events",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "get-ws-binding-token",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token"
            }
          ]
        }
      ]
    }
  ]
}