Document Subscription for Mobile (DSUBm)
1.0.1-current - ci-build

Document Subscription for Mobile (DSUBm), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.DSUBm/ and changes regularly. See the Directory of published versions

## : DSUBm Resource Notification Subscriber Actor implementing DocumentReference Subscription for Full Events option - JSON Representation

Active as of 2023-10-27

Raw json | Download

    {
      "resourceType" : "CapabilityStatement",
      "id" : "IHE.DSUBm.ResourceNotificationSubscriber.DocRef.FullEvents",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement IHE.DSUBm.ResourceNotificationSubscriber.DocRef.FullEvents</b></p><a name=\"IHE.DSUBm.ResourceNotificationSubscriber.DocRef.FullEvents\"> </a><a name=\"hcIHE.DSUBm.ResourceNotificationSubscriber.DocRef.FullEvents\"> </a><a name=\"IHE.DSUBm.ResourceNotificationSubscriber.DocRef.FullEvents-en-US\"> </a><h2 id=\"title\">IHE DSUBm ResourceNotificationSubscriber DocRef FullEvents</h2><ul><li>Implementation Guide Version: 1.0.1-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-10-27 </li><li>Published by: IHE IT Infrastructure Technical Committee </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><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>DSUBm Resource Notification subscriber provides capability to create/deactivate subscription and optionally to search for Subscription and SubscritptionTopic resources</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html\">ATNA</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> or <a href=\"http://www.hl7.org/fhir/smart-app-launch/\">SMART-app-launch</a></p>\n</div></blockquote><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><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/>\u00a0\u00a0<a href=\"StructureDefinition-DSUBm-DocumentReference-PatientDependent-Subscription.html\">Subscription for DocumentReference Patient-Dependent</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-DSUBm-DocumentReference-MultiPatient-Subscription.html\">Subscription for DocumentReference Multi-Patient</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-DSUBm-SubmissionSet-PatientDependent-Subscription.html\">Subscription for SubmissionSet Patient-Dependent</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-DSUBm-SubmissionSet-MultiPatient-Subscription.html\">Subscription for SubmissionSet Multi-Patient</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-DSUBm-DocumentReference-PatientDependent-Subscription-AllEvents.html\">Subscription for DocumentReference Patient-Dependent with DocumentReference Subscription for Full Events Option</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-DSUBm-DocumentReference-MultiPatient-Subscription-AllEvents.html\">Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Full Events Option</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>_id, status, url, filter-criteria, topic</td><td/><td/><td><code>$$events</code>, <code>$$status</code></td></tr><tr><td><a href=\"#Basic1-2\">Basic</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>code, _id, resource, derived-or-self, status, url</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: supported </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>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-DSUBm-DocumentReference-PatientDependent-Subscription.html\">Subscription for DocumentReference Patient-Dependent</a><br/><a href=\"StructureDefinition-DSUBm-DocumentReference-MultiPatient-Subscription.html\">Subscription for DocumentReference Multi-Patient</a><br/><a href=\"StructureDefinition-DSUBm-SubmissionSet-PatientDependent-Subscription.html\">Subscription for SubmissionSet Patient-Dependent</a><br/><a href=\"StructureDefinition-DSUBm-SubmissionSet-MultiPatient-Subscription.html\">Subscription for SubmissionSet Multi-Patient</a><br/><a href=\"StructureDefinition-DSUBm-DocumentReference-PatientDependent-Subscription-AllEvents.html\">Subscription for DocumentReference Patient-Dependent with DocumentReference Subscription for Full Events Option</a><br/><a href=\"StructureDefinition-DSUBm-DocumentReference-MultiPatient-Subscription-AllEvents.html\">Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Full Events Option</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Resource Subscription [ITI-110] and Resource Subscription Search [ITI-113]</p>\n</div></blockquote></div></div><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>_id</td><td><code>string</code></td><td><div><p>The id of the Subscription</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The current state of the subscription</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>uri</code></td><td><div><p>The URI that will receive the notifications</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/SearchParameter-Subscription-filter-criteria.html\">filter-criteria</a></td><td><code>string</code></td><td><div><p>This SearchParameter enables query of subscriptions by filter criteria</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/SearchParameter-Subscription-topic.html\">topic</a></td><td><code>uri</code></td><td><div><p>This SearchParameter enables query of subscriptions by canonical topic-url</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/OperationDefinition-backport-subscription-events.html\">$$events</a></td><td><div><p>This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/OperationDefinition-backport-subscription-status.html\">$$status</a></td><td><div><p>This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle</p>\n</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: SHALL </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>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Resource SubscriptionTopic Search [ITI-114]</p>\n</div></blockquote></div></div><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>code</td><td><code>token</code></td><td><div><p>Kind of Resource</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td>_id</td><td><code>string</code></td><td><div><p>The id of the SubscriptionTopic</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td>resource</td><td><code>uri</code></td><td><div><p>Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td>derived-or-self</td><td><code>uri</code></td><td><div><p>A server defined search that matches either the url or derivedFrom</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td>status</td><td><code>token</code></td><td><div><p>SHOULD be valued with <code>active</code></p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td>url</td><td><code>uri</code></td><td><div><p>Logical canonical URL to reference this SubscriptionTopic (globally unique)</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
      },
      "url" : "https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.DocRef.FullEvents",
      "version" : "1.0.1-current",
      "name" : "IHE_DSUBm_ResourceNotificationSubscriber_DocRef_FullEvent",
      "title" : "IHE DSUBm ResourceNotificationSubscriber DocRef FullEvents",
      "status" : "active",
      "experimental" : false,
      "date" : "2023-10-27",
      "publisher" : "IHE IT Infrastructure Technical Committee",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
            }
          ]
        },
        {
          "telecom" : [
            {
              "system" : "email",
              "value" : "iti@ihe.net"
            }
          ]
        },
        {
          "name" : "IHE IT Infrastructure Technical Committee",
          "telecom" : [
            {
              "system" : "email",
              "value" : "iti@ihe.net"
            }
          ]
        }
      ],
      "description" : "The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided  when implementing DocumentReference Subscription for Full Events option.\n\n- Using FHIR R4\n- SHALL support both json and xml encoding\n- SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)\n- SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic\n- SHALL be able to support the Subscription defined in Section [2:3.110.4.1.2.1.2 Subscription with DocumentReference Subscription for Full Events option](ITI-110.html#2311041212-subscription-with-documentreference-subscription-for-full-events-option), and the related SubscriptionTopic\n- SHOULD implement the ITI-113 transaction; if implemented: \n  - [Search Parameters that SHOULD be supported](ITI-113.html#23113412-message-semantics)\n    - _id\n    - status\n    - url\n    - filter-criteria\n    - topic\n  - SHOULD support the DSUBm $status operation  \n  - SHOULD support the DSUBm $events operation  \n- SHOULD implement the ITI-114 transaction; if implemented: \n  - [Search Parameters that SHALL be supported](ITI-114.html#23114412-message-semantics)\n    - code\n  - [Search Parameters that SHOULD be supported](ITI-114.html#23114412-message-semantics)\n    - _id\n    - resource\n    - derived-or-self\n    - status\n    - url\n\n",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
              "code" : "001"
            }
          ]
        }
      ],
      "kind" : "requirements",
      "fhirVersion" : "4.0.1",
      "format" : [
        "application/fhir+xml",
        "application/fhir+json"
      ],
      "rest" : [
        {
          "mode" : "client",
          "documentation" : "DSUBm Resource Notification subscriber provides capability to create/deactivate subscription and optionally to search for Subscription and SubscritptionTopic resources",
          "security" : {
            "description" : "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
          },
          "resource" : [
            {
              "type" : "Subscription",
              "supportedProfile" : [
                🔗 "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-PatientDependent-Subscription"🔗 ,
                "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription"🔗 ,
                "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-PatientDependent-Subscription"🔗 ,
                "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-MultiPatient-Subscription"🔗 ,
                "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-PatientDependent-Subscription-AllEvents"🔗 ,
                "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription-AllEvents"
              ],
              "documentation" : "Resource Subscription [ITI-110] and Resource Subscription Search [ITI-113]",
              "interaction" : [
                {
                  "code" : "read"
                },
                {
                  "code" : "create"
                },
                {
                  "code" : "update"
                },
                {
                  "code" : "search-type"
                }
              ],
              "searchParam" : [
                {
                  "name" : "_id",
                  "type" : "string",
                  "documentation" : "The id of the Subscription"
                },
                {
                  "name" : "status",
                  "type" : "token",
                  "documentation" : "The current state of the subscription"
                },
                {
                  "name" : "url",
                  "type" : "uri",
                  "documentation" : "The URI that will receive the notifications"
                },
                {
                  "name" : "filter-criteria",
                  "definition" : "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-filter-criteria",
                  "type" : "string",
                  "documentation" : "This SearchParameter enables query of subscriptions by filter criteria"
                },
                {
                  "name" : "topic",
                  "definition" : "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-topic",
                  "type" : "uri",
                  "documentation" : "This SearchParameter enables query of subscriptions by canonical topic-url"
                }
              ],
              "operation" : [
                {
                  "name" : "$events",
                  "definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events",
                  "documentation" : "This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle "
                },
                {
                  "name" : "$status",
                  "definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status",
                  "documentation" : "This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle "
                }
              ]
            },
            {
              "type" : "Basic",
              "documentation" : "Resource SubscriptionTopic Search [ITI-114]",
              "interaction" : [
                {
                  "code" : "read"
                },
                {
                  "code" : "search-type"
                }
              ],
              "searchParam" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "code",
                  "type" : "token",
                  "documentation" : "Kind of Resource"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ],
                  "name" : "_id",
                  "type" : "string",
                  "documentation" : "The id of the SubscriptionTopic"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ],
                  "name" : "resource",
                  "type" : "uri",
                  "documentation" : "Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches."
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ],
                  "name" : "derived-or-self",
                  "type" : "uri",
                  "documentation" : "A server defined search that matches either the url or derivedFrom"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ],
                  "name" : "status",
                  "type" : "token",
                  "documentation" : "SHOULD be valued with `active`"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ],
                  "name" : "url",
                  "type" : "uri",
                  "documentation" : "Logical canonical URL to reference this SubscriptionTopic (globally unique)"
                }
              ]
            }
          ]
        }
      ]
    }