Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0 - STU 1
Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0 - STU 1
Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-resp-net-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="resp-net-data-source"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<h2>Data Source (e.g EHR)</h2>
<p>(Requirements Definition Capability Statement)</p>
<p>Canonical URL: http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source</p>
<p>Published by: <b>HL7 International - Public Health Work Group</b>
</p>
<p>This profile defines the expected capabilities of the <i>Data Source (e.g EHR) </i> actor to support the RESP-NET use cases.
Data Sources can be implemented and deployed with HDEA capability bundled together also identified as Data Source with HDEA functionality.
Data Sources may be implemented with an external HDEA identified as Data Source with External HDEA.
The conformance requirements for these different DataSources with and without HDEA functionality is different and outlined below.
</p>
<h2>General</h2>
<div class="table-wrapper">
<table>
<tbody>
<tr>
<th>FHIR Version:</th>
<td>4.0.1</td>
</tr>
<tr>
<th>Supported formats:</th>
<td>json</td>
</tr>
</tbody>
</table>
</div>
<h2>REST behavior</h2>
<h3>Data Source with HDEA functionality bundled together</h3>
<p> The primary focus of the Data Source actor in this case is to create the RESPnet report and send it to the PHA.
</p>
<p>Data Sources (with inbuilt HDEA functionality) <b>SHALL</b> meet the general security requirements documented in FHIR <a href="http://hl7.org/fhir/security.html">Security guidance</a>.</p>
<p>Data Sources (with inbuilt HDEA functionality) <b>SHALL</b> be capable of generating the RESP-NET reporting Bundle in response to a encounter-close named-event</p>
<p>Data Sources (with inbuilt HDEA functionality) <b>SHALL</b> be capable of submitting the RESP-NET reporting Bundle to the Public Health Agency(PHA) using $process-message operation</p>
<p>Data Sources (with inbuilt HDEA functionality) <b>SHALL</b> use SMART on FHIR Backend Services to authenticate and authorize with the PHA to submit the bundle to the $process-message operation</p>
<h3>Data Source supporting External HDEA application</h3>
<p>The primary focus of the Data Source actor is to allow the creation, modification and deletion of Subscriptions, notify subscribers based on subscriptions and support US Core APIs.</p>
<p>The rest of the requirements identified below in this capability statement only apply Data Sources supporting external HDEA Applications</p>
<p>
<b>Security Requirements:</b>
</p>
<p>Data Sources supporting external HDEA applications must meet the general security requirements documented in FHIR <a href="http://hl7.org/fhir/security.html">Security guidance</a>.</p>
<p>In addition the Data Source supporting external HDEA applications (e.g EHR) needs to meet the security requirements as outlined in the <a href="spec.html#smart-on-fhir-backend-services-requirements">Formal Specification - SMART on FHIR Backend Services Requirements.</a></p>
<h3>US Core Support</h3>
<p>
The Data Source supporting external HDEA (e.g EHR) <b>SHALL</b> implement the
<a href="http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html">US Core Server capability statement</a> as foundational FHIR APIs needed by the RESP-NET Content IG.
</p>
<br/>
<h3>Resource summary for Data Sources supporting external HDEA applications</h3>
<div class="table-wrapper">
<table class="grid">
<thead>
<tr>
<th>Resource</th>
<th>Search</th>
<th>Read</th>
<th>Read Version</th>
<th>Instance History</th>
<th>Resource History</th>
<th>Create</th>
<th>Update</th>
<th>Delete</th>
<th>Operations</th>
</tr>
</thead>
<tbody>
<tr>
<th><a href="http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription.html">Backported Subscription</a></th>
<td>
</td>
<td>
<a href="#Subscription-read" title="Allows retrieval of a specific Subscription Resource instances.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
<a href="#Subscription-create" title="Allows creation of a specific Subscription Resource instance">SHALL</a>
</td>
<td>
<a href="#Subscription-update" title="Allows update of a specific Subscription Resource instance">SHALL</a>
</td>
<td>
<a href="#Subscription-delete" title="Allows deletion of a specific Subscription Resource instance">SHALL</a>
</td>
<td>
<a href="http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/OperationDefinition-backport-subscriptiontopic-list.html">$topic-list</a>
<a href="http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/OperationDefinition-backport-subscription-status.html">$status</a>
</td>
</tr>
<tr>
<th><a href="http://build.fhir.org/ig/HL7/fhir-medmorph/StructureDefinition-medmorph-encounter-end-subscription.html">Encounter End Subscription Topic</a></th>
<td>
</td>
<td>
<a href="#Subscription-read" title="Allows retrieval of a Encounter End Subscription instance.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
<a href="#Subscription-create" title="Allows creation of a Subscription Resource instance for Encounter End event notification">SHALL</a>
</td>
<td>
<a href="#Subscription-update" title="Allows update of a Subscription Resource instance for Encounter End event notification">SHALL</a>
</td>
<td>
<a href="#Subscription-delete" title="Allows deletion of a Subscription Resource instance for Encounter End event notification">SHALL</a>
</td>
<td>
</td>
</tr>
<tr>
<th><a href="http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription-notification.html">Backport Subscription Notification Bundle</a></th>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
<a href="#Notification-Bundle-create" title="Allows creation of a Subscription Notification Bundle for Encounter close event">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<th><a href="http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscriptionstatus.html">Backport Subscription Status</a></th>
<td>
</td>
<td>
<a href="#Subscription-Status-read" title="Allows retrieval of a Subscription Status for a specific Subscription">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<th>US Core APIs</th>
<td>
<a href="#USCore-search-type" title="Allows search of a specific US Core Resource instances.">SHALL</a>
</td>
<td>
<a href="#USCore-read" title="Allows retrieval of a specific US Core Resource instances.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<th><a href="http://hl7.org/fhir/R4/medicationadministration.html">MedicationAdministration</a></th>
<td>
<a href="#MedAdm-search" title="Allows search of a specific US Core Resource instances.">SHALL</a>
</td>
<td>
<a href="#MedAdm-read" title="Allows retrieval of a specific US Core Resource instances.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/subscription.html">Subscription (Includes Subscriptions for encounter-close Subscription Topic)</a>
</h3>
<p>Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription.html
</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Subscription-read"> </a>
<span>read</span>
</th>
<td>
<p>Allows retrieval of a specific Subscription instance.</p>
</td>
</tr>
<tr>
<th>
<a name="Subscription-create"> </a>
<span>create</span>
</th>
<td>
<p>Allows creation of Subscription instances</p>
</td>
</tr>
<tr>
<th>
<a name="Subscription-update"> </a>
<span>update</span>
</th>
<td>
<p>Allows Update of Subscription instances</p>
</td>
</tr>
<tr>
<th>
<a name="Subscription-delete"> </a>
<span>delete</span>
</th>
<td>
<p>Allows deletion of Subscription instances</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/bundle.html">Bundle (Notification Bundle for Subscriptions)</a>
</h3>
<p>Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription-notification.html)
</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Notification-Bundle-create"> </a>
<span>create</span>
</th>
<td>
<p>Allows creation of Notification Bundles for Subscriptions </p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/parameters.html">Parameters (Parameters Profile to retrieve Subscription Status)</a>
</h3>
<p>Profile: "subscriptionstatus profile from Subscription-backport Implementation Guide"
</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Subscription-Status-read"> </a>
<span>read</span>
</th>
<td>
<p>Allows clients to request Subscription Status for Subscriptions </p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/us/core">US Core APIs</a>
</h3>
<p>Profile: All US Core profiles
</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="USCore-search-type"> </a>
<span>search</span>
</th>
<td>
<p>Allows searching of specific US Core resource profile instances.</p>
</td>
</tr>
<tr>
<th>
<a name="USCore-read"> </a>
<span>read</span>
</th>
<td>
<p>Allows retrieval of specific US Core resource profile instances</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/medicationadministration.html">MedicationAdministration</a>
</h3>
<p>Profile: "us-ph-medicationadministration from Public Health Library"
</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="MedAdm-search"> </a>
<span>search</span>
</th>
<td>
<p>Allows searching of specific MedicationAdministration resource profile instances.</p>
</td>
</tr>
<tr>
<th>
<a name="MedAdm-read"> </a>
<span>read</span>
</th>
<td>
<p>Allows retrieval of specific MedicationAdministration resource profile instances</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="pher"/>
</extension>
<url
value="http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source"/>
<version value="1.0.0"/>
<name value="RespNetEHRCapabilityStatement"/>
<title value="RESP-NET EHR Capability Statement"/>
<status value="draft"/>
<date value="2020-12-06"/>
<publisher value="HL7 International / Public Health"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/pher"/>
</telecom>
</contact>
<description
value="This profile defines the expected capabilities of the ''EHR'' actor when conforming to the RESP-NET Content Implementation Guide. This role is responsible for allowing creation, modification and deletion of Subscriptions and allows searching and retrieval of resources using US Core APIs."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="json"/>
<rest>
<mode value="server"/>
<documentation
value="The focus of the EHR is to allow creation, modification and deletion of Subscriptions and allows searching and retrieval of resources using US Core APIs. "/>
<security>
<description
value="Implementations must meet the general security requirements documented in the security section of the implementation guide."/>
</security>
<resource>
<type value="Subscription"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Allows retrieval of a specific Subscription instance."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="create"/>
<documentation
value="Allows creation of a Subscription resource instance."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="update"/>
<documentation
value="Allows update of a Subscription resource instance."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="delete"/>
<documentation
value="Allows deletion of a Subscription resource instance."/>
</interaction>
</resource>
</rest>
</CapabilityStatement>
IG © 2023+ HL7 International / Public Health. Package hl7.fhir.us.resp-net#1.0.0 based on FHIR 4.0.1. Generated 2025-05-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change