XIG: CapabilityStatement/backport-subscription-server

FHIR IG Statistics: CapabilityStatement/backport-subscription-server

Package	hl7.fhir.uv.subscriptions-backport.r4
Type	CapabilityStatement
Id	backport-subscription-server
FHIR Version	R4
Source	http://hl7.org/fhir/uv/subscriptions-backport/http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/CapabilityStatement-backport-subscription-server.html
URL	http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server
Version	1.1.0
Status	active
Date	2020-11-30
Name	BackportSubscriptionCapabilityStatement
Realm	uv
Authority	hl7
Description	CapabilityStatement describing the required and optional capabilities of a FHIR Server supporting backported R5 Subscriptions in R4B.
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
hl7.fhir.uv.subscriptions-backport	Subscriptions R5 Backport
hl7.fhir.uv.subscriptions-backport	Subscriptions R5 Backport

OperationDefinition
backport-subscription-events	Subscription Events Operation
backport-subscription-get-ws-binding-token	Get WS Binding Token for Subscription Operation
backport-subscription-status	Subscription Status Operation
backport-subscription-events	R5SubscriptionEvents
backport-subscription-get-ws-binding-token	R5SubscriptionGetWsBindingToken
backport-subscription-status	R5SubscriptionStatus

StructureDefinition
backport-subscription	R4/B Topic-Based Subscription
backport-subscription	R4/B Topic-Based Subscription

Narrative

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

FHIR RESTful Capabilities by Resource/Profile:

Summary

Resource Type Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations

SubscriptionTopic - url, derived-or-self, resource, title, trigger-description - - -

Subscription Backported R5 Subscription url, status - - $status, $events, $get-ws-binding-token

Resource Type	Supported Profiles	Supported Searches	Supported `_includes`	Supported `_revincludes`	Supported Operations
SubscriptionTopic	-	url, derived-or-self, resource, title, trigger-description	-	-	-
Subscription	Backported R5 Subscription	url, 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:

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

Conformance

Parameter

Type

SHALL

url

uri

SHALL

derived-or-self

uri

SHOULD

resource

uri

SHOULD

title

string

SHOULD

trigger-description

string

Subscription

Conformance Expectation: SHALL

Supported Profiles:

SHALL support: Backported R5 Subscription

Operation Summary:

SHALL support the $status operation
MAY support the $events operation , $get-ws-binding-token operation

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:

Conformance	Parameter	Type
SHOULD	url	uri
SHOULD	status	token

Conformance

Parameter

Type

SHOULD

url

uri

SHOULD

status

token

Source

{
  "resourceType": "CapabilityStatement",
  "id": "backport-subscription-server",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server",
  "version": "1.1.0",
  "name": "BackportSubscriptionCapabilityStatement",
  "status": "active",
  "date": "2020-11-30",
  "publisher": "HL7 FHIR Infrastructure WG",
  "contact": [
    {
      "name": "HL7 FHIR Infrastructure WG",
      "telecom": [
        {
          "system": "url",
          "value": "https://hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "name": "Gino Canessa",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:gino.canessa@microsoft.com"
        }
      ]
    },
    {
      "name": "Eric Haas",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:ehaas@healthedatainc.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"
            }
          ]
        }
      ]
    }
  ]
}