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

## : R4 Topic-Based Subscription Server Capability Statement - TTL Representation

Page standards status: Trial-use

Raw ttl | Download

    @prefix fhir: <http://hl7.org/fhir/> .
    @prefix owl: <http://www.w3.org/2002/07/owl#> .
    @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
    @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

    # - resource -------------------------------------------------------------------

     a fhir:CapabilityStatement ;
      fhir:nodeRole fhir:treeRoot ;
      fhir:id [ fhir:v "backport-subscription-server-r4"] ; #
      fhir:text [
    fhir:status [ fhir:v "extensions" ] ;
    fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">R4 Topic-Based Subscription Server Capability Statement</h2><ul><li>Implementation Guide Version: 1.2.0-ballot </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2020-11-30 </li><li>Published by: HL7 International / FHIR Infrastructure </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li><a href=\"index.html\">http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th class=\"text-center\"><b title=\"DELETE a resource (delete interaction)\">D</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Subscription1-1\">Subscription</a></td><td>Supported Profiles<br/>  <a href=\"StructureDefinition-backport-subscription.html\">R4/B Topic-Based Subscription</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>url, status</td><td/><td/><td><code>$status</code>, <code>$events</code>, <code>$get-ws-binding-token</code></td></tr><tr><td><a href=\"#Basic1-2\">Basic</a></td><td> </td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>code</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Subscription1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Subscription</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong>support <code>read</code>.</li><li><strong>SHOULD</strong>support <code>create</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-backport-subscription.html\">http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/subscription.html#search\">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/subscription.html#search\">status</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\"> </div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-backport-subscription-status.html\">$status</a></td><td><div/></td></tr><tr><td><b>MAY</b></td><td><a href=\"OperationDefinition-backport-subscription-events.html\">$events</a></td><td><div/></td></tr><tr><td><b>MAY</b></td><td><a href=\"OperationDefinition-backport-subscription-get-ws-binding-token.html\">$get-ws-binding-token</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Basic1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Basic</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/basic.html\">Basic</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong>support <code>read</code>.</li><li><strong>MAY</strong>support <code>create</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/basic.html#search\">code</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\"> </div></div></div></div></div></div>"
      ] ; #
      fhir:extension ( [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "fhir" ]
      ] [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ;
    fhir:value [
    fhir:v "trial-use" ;
          ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ;
    fhir:value [
    fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport>         ]       ] )     ]
      ] ) ; #
      fhir:url [ fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server-r4"^^xsd:anyURI] ; #
      fhir:version [ fhir:v "1.2.0-ballot"] ; #
      fhir:name [ fhir:v "BackportSubscriptionCapabilityStatementR4"] ; #
      fhir:title [ fhir:v "R4 Topic-Based Subscription Server Capability Statement"] ; #
      fhir:status [ fhir:v "active"] ; #
      fhir:date [ fhir:v "2020-11-30"^^xsd:date] ; #
      fhir:publisher [ fhir:v "HL7 International / FHIR Infrastructure"] ; #
      fhir:contact ( [
    fhir:name [ fhir:v "HL7 International / FHIR Infrastructure" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "url" ] ;
    fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg" ]     ] )
      ] [
    fhir:name [ fhir:v "Gino Canessa" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "email" ] ;
    fhir:value [ fhir:v "mailto:gino.canessa@microsoft.com" ]     ] )
      ] ) ; #
      fhir:description [ fhir:v "CapabilityStatement describing the required and optional capabilities of a FHIR Server supporting backported R5 Subscriptions in R4."] ; #
      fhir:jurisdiction ( [
        ( fhir:coding [
    fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
    fhir:code [ fhir:v "001" ] ;
    fhir:display [ fhir:v "World" ]     ] )
      ] ) ; #
      fhir:kind [ fhir:v "requirements"] ; #
      fhir:fhirVersion [ fhir:v "4.0.1"] ; #
      fhir:format ( [ fhir:v "xml"] [ fhir:v "json"] ) ; #
      fhir:implementationGuide ( [
    fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport>
      ] ) ; #
      fhir:rest ( [
    fhir:mode [
    fhir:v "server" ;
          ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]       ] )     ] ;
        ( fhir:resource [
          ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]       ] ) ;
    fhir:type [ fhir:v "Subscription" ] ;
          ( fhir:supportedProfile [
    fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription> ;
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHOULD" ]         ] )       ] ) ;
          ( fhir:interaction [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]         ] ) ;
    fhir:code [ fhir:v "read" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHOULD" ]         ] ) ;
    fhir:code [ fhir:v "create" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHOULD" ]         ] ) ;
    fhir:code [ fhir:v "update" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHOULD" ]         ] ) ;
    fhir:code [ fhir:v "delete" ]       ] ) ;
          ( fhir:searchParam [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]         ] ) ;
    fhir:name [ fhir:v "url" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/SearchParameter/Subscription-url"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/SearchParameter/Subscription-url>         ] ;
    fhir:type [ fhir:v "uri" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHOULD" ]         ] ) ;
    fhir:name [ fhir:v "status" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/SearchParameter/Subscription-status"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/SearchParameter/Subscription-status>         ] ;
    fhir:type [ fhir:v "token" ]       ] ) ;
          ( fhir:operation [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]         ] ) ;
    fhir:name [ fhir:v "status" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status>         ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "MAY" ]         ] ) ;
    fhir:name [ fhir:v "events" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events>         ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "MAY" ]         ] ) ;
    fhir:name [ fhir:v "get-ws-binding-token" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token>         ]       ] )     ] [
          ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHOULD" ]       ] ) ;
    fhir:type [ fhir:v "Basic" ] ;
          ( fhir:interaction [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHOULD" ]         ] ) ;
    fhir:code [ fhir:v "read" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "MAY" ]         ] ) ;
    fhir:code [ fhir:v "create" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "MAY" ]         ] ) ;
    fhir:code [ fhir:v "update" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "MAY" ]         ] ) ;
    fhir:code [ fhir:v "delete" ]       ] ) ;
          ( fhir:searchParam [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHOULD" ]         ] ) ;
    fhir:name [ fhir:v "code" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/SearchParameter/clinical-code"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/SearchParameter/clinical-code>         ] ;
    fhir:type [ fhir:v "token" ]       ] )     ] )
      ] ) . #