HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm CI Build

This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

XML Format: CapabilityStatement-capabilitystatement-ersd-client

Raw xml


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="capabilitystatement-ersd-client"/>
  <meta>
    <versionId value="22"/>
    <lastUpdated value="2019-10-19T11:39:25.000-04:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
         <table xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
            <tr>
               <td style="font-weight: bold">id</td>
               <td>
                  <div title="id">capabilitystatement-ersd-client</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">meta</td>
               <td>
                  <table>
                     <tr>
                        <td style="font-weight: bold">versionId</td>
                        <td>
                           <div title="versionId">22</div> 
                        </td>
                     </tr>
                     <tr>
                        <td style="font-weight: bold">lastUpdated</td>
                        <td>
                           <div title="lastUpdated">2019-10-19T11:39:25.000-04:00</div> 
                        </td>
                     </tr>
                  </table>
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">url</td>
               <td>
                  <div title="url">http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">version</td>
               <td>
                  <div title="version">1.0.0</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">name</td>
               <td>
                  <div title="name">CapabilityStatement_eRSD_Client</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">title</td>
               <td>
                  <div title="title">Capability Statement eRSD Client</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">status</td>
               <td>
                  <div title="status">draft</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">experimental</td>
               <td>
                  <div title="experimental">false</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">date</td>
               <td>
                  <div title="date">2019-08-23</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">publisher</td>
               <td>
                  <div title="publisher">HL7 Public Health Work Group</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">description</td>
               <td>
                  <div title="description">
                     <p>This section describes the expected capabilities of a client consuming eRSD resources including the Reportable Conditions Trigger Codes (RCTC).</p>
                     <p>#### Conformance requirements for an eRSD Client</p>
                     <p>The eRSD Client <b>SHALL</b>:</p>
                     <p>- Support fetching the eRSD Bundle using the supported RESTful interactions.</p>
                     <p>- Support processing PlanDefinition and ValueSet resources that are included in the Bundle.</p>
                     <p>The eRSD Client <b>MAY</b>:</p>
                     <p>- Support fetching and reading a Person resource.</p>
                     <p>- Support fetching and reading Subscription resources associated with a Person.</p>
                  </div>
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">kind</td>
               <td>
                  <div title="kind">requirements</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">fhirVersion</td>
               <td>
                  <div title="fhirVersion">4.0.0</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">format</td>
               <td>
                  <div title="format">xml</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">format</td>
               <td>
                  <div title="format">json</div> 
               </td>
            </tr>
            <tr>
               <td style="font-weight: bold">rest</td>
               <td>
                  <table>
                     <tr>
                        <td style="font-weight: bold">mode</td>
                        <td>
                           <div title="mode">client</div> 
                        </td>
                     </tr>
                     <tr>
                        <td style="font-weight: bold">resource</td>
                        <td>
                           <table>
                              <tr>
                                 <td style="font-weight: bold">type</td>
                                 <td>
                                    <div title="type">Bundle</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">supportedProfile</td>
                                 <td>
                                    <div title="supportedProfile">http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">supportedProfile</td>
                                 <td>
                                    <div title="supportedProfile">http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-message-bundle</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">documentation</td>
                                 <td>
                                    <div title="documentation">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.</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">interaction</td>
                                 <td>
                                    <table>
                                       <tr>
                                          <td style="font-weight: bold">code</td>
                                          <td>
                                             <div title="code">read</div> 
                                          </td>
                                       </tr>
                                    </table>
                                 </td>
                              </tr>
                           </table>
                        </td>
                     </tr>
                     <tr>
                        <td style="font-weight: bold">resource</td>
                        <td>
                           <table>
                              <tr>
                                 <td style="font-weight: bold">type</td>
                                 <td>
                                    <div title="type">ValueSet</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">profile</td>
                                 <td>
                                    <div title="profile">http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-valueset</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">interaction</td>
                                 <td>
                                    <table>
                                       <tr>
                                          <td style="font-weight: bold">code</td>
                                          <td>
                                             <div title="code">read</div> 
                                          </td>
                                       </tr>
                                    </table>
                                 </td>
                              </tr>
                           </table>
                        </td>
                     </tr>
                     <tr>
                        <td style="font-weight: bold">resource</td>
                        <td>
                           <table>
                              <tr>
                                 <td style="font-weight: bold">type</td>
                                 <td>
                                    <div title="type">PlanDefinition</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">profile</td>
                                 <td>
                                    <div title="profile">http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">interaction</td>
                                 <td>
                                    <table>
                                       <tr>
                                          <td style="font-weight: bold">code</td>
                                          <td>
                                             <div title="code">read</div> 
                                          </td>
                                       </tr>
                                    </table>
                                 </td>
                              </tr>
                           </table>
                        </td>
                     </tr>
                     <tr>
                        <td style="font-weight: bold">resource</td>
                        <td>
                           <table>
                              <tr>
                                 <td style="font-weight: bold">type</td>
                                 <td>
                                    <div title="type">Person</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">documentation</td>
                                 <td>
                                    <div title="documentation">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.</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">interaction</td>
                                 <td>
                                    <table>
                                       <tr>
                                          <td style="font-weight: bold">code</td>
                                          <td>
                                             <div title="code">read</div> 
                                          </td>
                                       </tr>
                                    </table>
                                 </td>
                              </tr>
                           </table>
                        </td>
                     </tr>
                     <tr>
                        <td style="font-weight: bold">resource</td>
                        <td>
                           <table>
                              <tr>
                                 <td style="font-weight: bold">type</td>
                                 <td>
                                    <div title="type">Subscription</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">documentation</td>
                                 <td>
                                    <div title="documentation">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.</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">interaction</td>
                                 <td>
                                    <table>
                                       <tr>
                                          <td style="font-weight: bold">code</td>
                                          <td>
                                             <div title="code">read</div> 
                                          </td>
                                       </tr>
                                    </table>
                                 </td>
                              </tr>
                           </table>
                        </td>
                     </tr>
                     <tr>
                        <td style="font-weight: bold">resource</td>
                        <td>
                           <table>
                              <tr>
                                 <td style="font-weight: bold">type</td>
                                 <td>
                                    <div title="type">Library</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">profile</td>
                                 <td>
                                    <div title="profile">http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-valueset-library</div> 
                                 </td>
                              </tr>
                              <tr>
                                 <td style="font-weight: bold">interaction</td>
                                 <td>
                                    <table>
                                       <tr>
                                          <td style="font-weight: bold">code</td>
                                          <td>
                                             <div title="code">read</div> 
                                          </td>
                                       </tr>
                                    </table>
                                 </td>
                              </tr>
                           </table>
                        </td>
                     </tr>
                  </table>
               </td>
            </tr>
         </table>
      </div>
  </text>
  <url
       value="http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client"/>
  <version value="1.0.0"/>
  <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 Public Health Work Group"/>
  <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."/>
  <kind value="requirements"/>
  <fhirVersion value="4.0.0"/>
  <format value="xml"/>
  <format value="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/ecr-message-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/ersd-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/ersd-valueset-library"/>
      <interaction>
        <code value="read"/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>