FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/backport-subscription-server-r4

Packagehl7.fhir.uv.subscriptions-backport
TypeCapabilityStatement
Idbackport-subscription-server-r4
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/uv/subscriptions-backport/https://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/CapabilityStatement-backport-subscription-server-r4.html
URLhttp://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server-r4
Version1.2.0-ballot
Statusactive
Date2020-11-30
NameBackportSubscriptionCapabilityStatementR4
TitleR4 Topic-Based Subscription Server Capability Statement
Realmuv
Authorityhl7
DescriptionCapabilityStatement describing the required and optional capabilities of a FHIR Server supporting backported R5 Subscriptions in R4.
Kindrequirements

Resources that use this resource

CapabilityStatement
r4-capabilitystatement-example-server

Resources that this resource uses

ImplementationGuide
hl7.fhir.uv.subscriptions-backportSubscriptions R5 Backport
hl7.fhir.uv.subscriptions-backportSubscriptions R5 Backport
OperationDefinition
backport-subscription-eventsSubscription Events Operation
backport-subscription-get-ws-binding-tokenGet WS Binding Token for Subscription Operation
backport-subscription-statusSubscription Status Operation
backport-subscription-eventsR5SubscriptionEvents
backport-subscription-get-ws-binding-tokenR5SubscriptionGetWsBindingToken
backport-subscription-statusR5SubscriptionStatus
StructureDefinition
backport-subscriptionR4/B Topic-Based Subscription
backport-subscriptionR4/B Topic-Based Subscription

Narrative

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

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

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
SubscriptionSupported Profiles
  R4/B Topic-Based Subscription		yyyyurl, status$status, $events, $get-ws-binding-token
Basic yyyycode

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
ConformanceParameterTypeDocumentation
SHALLurluri
SHOULDstatustoken
 
Extended Operations
ConformanceOperationDocumentation
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
ConformanceParameterTypeDocumentation
SHOULDcodetoken
 

Source

{
  "resourceType": "CapabilityStatement",
  "id": "backport-subscription-server-r4",
  "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-r4",
  "version": "1.2.0-ballot",
  "name": "BackportSubscriptionCapabilityStatementR4",
  "title": "R4 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 R4.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "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": "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"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "Basic",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}