HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
1.1.0 - STU 2 Ballot
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
1.1.0 - STU 2 Ballot
This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 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 
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="capabilitystatement-ersd-client"/>
<meta>
<versionId value="7"/>
<lastUpdated value="2020-11-30T21:30:13.681+00:00"/>
<source value="#fGy6iOk8XyBptfoW"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<table>
<tr>
<td style="font-weight: bold">id</td>
<td>
<span title="id">capabilitystatement-ersd-client</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">url</td>
<td>
<span title="url">http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">version</td>
<td>
<span title="version">1.0.0</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">name</td>
<td>
<span title="name">CapabilityStatement_eRSD_Client</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">title</td>
<td>
<span title="title">Capability Statement eRSD Client</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">status</td>
<td>
<span title="status">draft</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">experimental</td>
<td>
<span title="experimental">false</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">date</td>
<td>
<span title="date">2019-08-23</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">publisher</td>
<td>
<span title="publisher">HL7 Public Health Work Group</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">description</td>
<td>
<span 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>
</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">kind</td>
<td>
<span title="kind">requirements</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">fhirVersion</td>
<td>
<span title="fhirVersion">4.0.1</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">format</td>
<td>
<span title="format">xml</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">format</td>
<td>
<span title="format">json</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">rest</td>
<td>
<table>
<tr>
<td style="font-weight: bold">mode</td>
<td>
<span title="mode">client</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">resource</td>
<td>
<table>
<tr>
<td style="font-weight: bold">type</td>
<td>
<span title="type">Bundle</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">supportedProfile</td>
<td>
<span title="supportedProfile">http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">supportedProfile</td>
<td>
<span title="supportedProfile">http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-message-bundle</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">documentation</td>
<td>
<span 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.</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">interaction</td>
<td>
<table>
<tr>
<td style="font-weight: bold">capabilitystatement-expectation</td>
<td>
<ul style="list-style:none; padding-left:0; margin:0 0;">
<li>
<span title="valueCode">SHALL</span>
</li>
</ul>
</td>
</tr>
<tr>
<td style="font-weight: bold">code</td>
<td>
<span title="code">read</span>
</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>
<span title="type">ValueSet</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">profile</td>
<td>
<span title="profile">http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-valueset</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">documentation</td>
<td>
<span title="documentation">A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between CodeSystem definitions and their use in coded elements.</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">interaction</td>
<td>
<table>
<tr>
<td style="font-weight: bold">capabilitystatement-expectation</td>
<td>
<ul style="list-style:none; padding-left:0; margin:0 0;">
<li>
<span title="valueCode">SHALL</span>
</li>
</ul>
</td>
</tr>
<tr>
<td style="font-weight: bold">code</td>
<td>
<span title="code">read</span>
</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>
<span title="type">PlanDefinition</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">profile</td>
<td>
<span title="profile">http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">documentation</td>
<td>
<span title="documentation">A plan definition is a pre-defined group of actions to be taken in particular circumstances, such as the triggering of a ERSD subscription, often including conditional elements, options, and other decision points.</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">interaction</td>
<td>
<table>
<tr>
<td style="font-weight: bold">capabilitystatement-expectation</td>
<td>
<ul style="list-style:none; padding-left:0; margin:0 0;">
<li>
<span title="valueCode">SHALL</span>
</li>
</ul>
</td>
</tr>
<tr>
<td style="font-weight: bold">code</td>
<td>
<span title="code">read</span>
</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>
<span title="type">Person</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">documentation</td>
<td>
<span 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.</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">interaction</td>
<td>
<table>
<tr>
<td style="font-weight: bold">capabilitystatement-expectation</td>
<td>
<ul style="list-style:none; padding-left:0; margin:0 0;">
<li>
<span title="valueCode">MAY</span>
</li>
</ul>
</td>
</tr>
<tr>
<td style="font-weight: bold">code</td>
<td>
<span title="code">read</span>
</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>
<span title="type">Subscription</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">documentation</td>
<td>
<span 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.</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">interaction</td>
<td>
<table>
<tr>
<td style="font-weight: bold">capabilitystatement-expectation</td>
<td>
<ul style="list-style:none; padding-left:0; margin:0 0;">
<li>
<span title="valueCode">MAY</span>
</li>
</ul>
</td>
</tr>
<tr>
<td style="font-weight: bold">code</td>
<td>
<span title="code">read</span>
</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>
<span title="type">Library</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">profile</td>
<td>
<span title="profile">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library</span>
</td>
</tr>
<tr>
<td style="font-weight: bold">interaction</td>
<td>
<table>
<tr>
<td style="font-weight: bold">capabilitystatement-expectation</td>
<td>
<ul style="list-style:none; padding-left:0; margin:0 0;">
<li>
<span title="valueCode">SHALL</span>
</li>
</ul>
</td>
</tr>
<tr>
<td style="font-weight: bold">code</td>
<td>
<span title="code">read</span>
</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.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="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/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>
IG © 2020+ HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). Package hl7.fhir.us.ecr#1.1.0 based on FHIR 4.0.1. Generated 2020-12-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change