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

FHIR IG Statistics: CapabilityStatement/r4-capabilitystatement-example-server

Packagehl7.fhir.uv.subscriptions-backport
Resource TypeCapabilityStatement
Idr4-capabilitystatement-example-server
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/uv/subscriptions-backport/https://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/CapabilityStatement-r4-capabilitystatement-example-server.html
URLhttp://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/r4-capabilitystatement-example-server
Version1.2.0-ballot
Statusactive
Date2020-11-30
Realmuv
Authorityhl7
DescriptionR4 example of a CapabilityStatement advertising support for topic-based subscriptions and a few topics.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

CapabilityStatement
backport-subscription-server-r4R4 Topic-Based Subscription Server Capability Statement
ImplementationGuide
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
StructureDefinition
backport-subscriptionR4/B Topic-Based Subscription

Narrative

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

  • 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.

This CapabilityStatement instantiates the CapabilityStatementR4 Topic-Based Subscription Server Capability Statement

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
Patient yyyy
Encounter yyyy
Observation yyyy
Basic yyyycode

Resource Conformance: supported Subscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary
  • Supports read, create, update, delete.

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

Resource Conformance: supported Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports read, create, update, delete.

Resource Conformance: supported Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • Supports read, create, update, delete.

Resource Conformance: supported Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • Supports read, create, update, delete.

Resource Conformance: SHOULD Basic

Core FHIR Resource
Basic
Reference Policy
Interaction summary
  • Supports read, create, update, delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDcodetoken
 

Source

{
  "resourceType": "CapabilityStatement",
  "id": "r4-capabilitystatement-example-server",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/r4-capabilitystatement-example-server",
  "version": "1.2.0-ballot",
  "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": "R4 example of a CapabilityStatement advertising support for topic-based subscriptions and a few topics.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "kind": "requirements",
  "instantiates": [
    "http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server-r4"
  ],
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/capabilitystatement-subscriptiontopic-canonical",
              "valueCanonical": "http://example.org/topics/patient-admission"
            },
            {
              "url": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/capabilitystatement-subscriptiontopic-canonical",
              "valueCanonical": "http://example.org/topics/patient-discharge"
            }
          ],
          "type": "Subscription",
          "supportedProfile": [
            "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            }
          ],
          "searchParam": [
            {
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/Subscription-url",
              "type": "uri"
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Subscription-status",
              "type": "token"
            }
          ],
          "operation": [
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"
            },
            {
              "name": "events",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events"
            },
            {
              "name": "get-ws-binding-token",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token"
            }
          ]
        },
        {
          "type": "Patient",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            }
          ]
        },
        {
          "type": "Encounter",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            }
          ]
        },
        {
          "type": "Observation",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            }
          ]
        },
        {
          "type": "Basic",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "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"
            }
          ]
        }
      ]
    }
  ]
}