HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2 United States of America flag

This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: eRSD Client CapabilityStatement - XML Representation

Draft as of 2019-08-23

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="capabilitystatement-ersd-client"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement capabilitystatement-ersd-client</b></p><a name="capabilitystatement-ersd-client"> </a><a name="hccapabilitystatement-ersd-client"> </a><a name="capabilitystatement-ersd-client-en-US"> </a><h2 id="title">Capability Statement eRSD Client</h2><ul><li>Implementation Guide Version: 2.1.2 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/xml</code>, <code>application/json</code></li><li>Supported Patch Formats: </li><li>Published on: 2019-08-23 </li><li>Published by: HL7 International / Public Health </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 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="#Bundle1-1">Bundle</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-eicr-document-bundle.html">eICR Document Bundle</a><br/>  <a href="StructureDefinition-rr-document-bundle.html">RR Document Bundle</a><br/>  <a href="StructureDefinition-us-ph-reporting-bundle.html">US Public Health Reporting Bundle</a></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#ValueSet1-2">ValueSet</a></td><td><a href="StructureDefinition-us-ph-valueset.html">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset</a></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#PlanDefinition1-3">PlanDefinition</a></td><td><a href="StructureDefinition-ersd-plandefinition.html">http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition</a></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Person1-4">Person</a></td><td> </td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Subscription1-5">Subscription</a></td><td> </td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Library1-6">Library</a></td><td><a href="StructureDefinition-us-ph-valueset-library.html">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library</a></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Bundle1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Bundle</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/bundle.html">Bundle</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>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-eicr-document-bundle.html">eICR Document Bundle</a><br/><a href="StructureDefinition-rr-document-bundle.html">RR Document Bundle</a><br/><a href="StructureDefinition-us-ph-reporting-bundle.html">US Public Health Reporting Bundle</a></p></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>The Bundle represents the artifacts that are to be distributed to subscribers. The Bundle contains the information necessary for implementers to update their systems. The Bundle typically includes PlanDefinition and ValueSet resources. The Bundle may also contain a message from the administrator that indicates the severity of the update.</p>
</div></blockquote></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="ValueSet1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>ValueSet</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-us-ph-valueset.html">US Public Health ValueSet</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="PlanDefinition1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>PlanDefinition</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ersd-plandefinition.html">eRSD PlanDefinition</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Person1-4" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Person</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/person.html">Person</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>.</li></ul></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>The Person resource is used by the eRSD server to associate one or more Subscriptions to an individual. The Person contains references to the Subscriptions associated with the Person.</p>
</div></blockquote></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Subscription1-5" 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>.</li></ul></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>A Subscription is used to notify a Person using the specified channel (email, rest-hook or email-based SMS) that a Bundle has been updated on the FHIR Server.</p>
</div></blockquote></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Library1-6" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Library</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-us-ph-valueset-library.html">US Public Health ValueSet Library</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/></div></div></div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pher"/>
  </extension>
  <url
       value="http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client"/>
  <version value="2.1.2"/>
  <name value="CapabilityStatement_eRSD_Client"/>
  <title value="Capability Statement eRSD Client"/>
  <status value="draft"/>
  <experimental value="false"/>
  <date value="2019-08-23"/>
  <publisher value="HL7 International / Public Health"/>
  <contact>
    <name value="HL7 International / Public Health"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/pher"/>
    </telecom>
  </contact>
  <description
               value="This section describes the expected capabilities of a client consuming eRSD resources including the Reportable Conditions Trigger Codes (RCTC).

#### Conformance requirements for an eRSD Client

The eRSD Client **SHALL**:

- Support fetching the eRSD Bundle using the supported RESTful interactions.
- Support processing PlanDefinition and ValueSet resources that are included in the Bundle.

The eRSD Client **MAY**:

- Support fetching and reading a Person resource.
- Support fetching and reading Subscription resources associated with a Person."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
    <text value="United States of America"/>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/xml"/>
  <format value="application/json"/>
  <rest>
    <mode value="client"/>
    <resource>
      <type value="Bundle"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle"/>
      <documentation
                     value="The Bundle represents the artifacts that are to be distributed to subscribers. The Bundle contains the information necessary for implementers to update their systems. The Bundle typically includes PlanDefinition and ValueSet resources. The Bundle may also contain a message from the administrator that indicates the severity of the update."/>
      <interaction>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="ValueSet"/>
      <profile
               value="http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset"/>
      <interaction>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="PlanDefinition"/>
      <profile
               value="http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition"/>
      <interaction>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="Person"/>
      <documentation
                     value="The Person resource is used by the eRSD server to associate one or more Subscriptions to an individual. The Person contains references to the Subscriptions associated with the Person."/>
      <interaction>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="Subscription"/>
      <documentation
                     value="A Subscription is used to notify a Person using the specified channel (email, rest-hook or email-based SMS) that a Bundle has been updated on the FHIR Server."/>
      <interaction>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="Library"/>
      <profile
               value="http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library"/>
      <interaction>
        <code value="read"/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>