HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.0 - STU 2 US

This page is part of the electronic Case Reporting (eCR) (v2.1.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). 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"/>
  <meta>
    <versionId value="13"/>
    <lastUpdated value="2021-08-19T08:19:41.534+00:00"/>
    <source value="#udNCEai5UlqF43SD"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>CapabilityStatement_eRSD_Client</h2><div><p>This section describes the expected capabilities of a client consuming eRSD resources including the Reportable Conditions Trigger Codes (RCTC).</p>
<h4>Conformance requirements for an eRSD Client</h4>
<p>The eRSD Client <strong>SHALL</strong>:</p>
<ul>
<li>Support fetching the eRSD Bundle using the supported RESTful interactions.</li>
<li>Support processing PlanDefinition and ValueSet resources that are included in the Bundle.</li>
</ul>
<p>The eRSD Client <strong>MAY</strong>:</p>
<ul>
<li>Support fetching and reading a Person resource.</li>
<li>Support fetching and reading Subscription resources associated with a Person.</li>
</ul>
</div><table><tr><td>Mode</td><td>CLIENT</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="POST a new resource (create interaction)">Create</b></th></tr><tr><td>Bundle</td><td>Supported profiles:<br/>  <a href="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle">http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle</a><br/>  <a href="http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle</a><br/>  <a href="http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle</a></td><td>y</td><td></td><td></td><td></td></tr><tr><td>ValueSet</td><td><a href="http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset</a></td><td>y</td><td></td><td></td><td></td></tr><tr><td>PlanDefinition</td><td><a href="http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition">http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition</a></td><td>y</td><td></td><td></td><td></td></tr><tr><td>Person</td><td> </td><td>y</td><td></td><td></td><td></td></tr><tr><td>Subscription</td><td> </td><td>y</td><td></td><td></td><td></td></tr><tr><td>Library</td><td><a href="http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library</a></td><td>y</td><td></td><td></td><td></td></tr></table></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client"/>
  <version value="2.1.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 (http://www.hl7.org/Special/committees/pher/index.cfm)"/>
  <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>