Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0 - STU1 Release 1 United States of America flag

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

CapabilityStatement: RESP-NET EHR Capability Statement

Official URL: http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: RespNetEHRCapabilityStatement
Other Identifiers: OID:2.16.840.1.113883.4.642.40.52.13.1

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.

Raw OpenAPI-Swagger Definition file | Download

Data Source (e.g EHR)

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source

Published by: HL7 International - Public Health Work Group

This profile defines the expected capabilities of the Data Source (e.g EHR) 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.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

Data Source with HDEA functionality bundled together

The primary focus of the Data Source actor in this case is to create the RESPnet report and send it to the PHA.

Data Sources (with inbuilt HDEA functionality) SHALL meet the general security requirements documented in FHIR Security guidance.

Data Sources (with inbuilt HDEA functionality) SHALL be capable of generating the RESP-NET reporting Bundle in response to a encounter-close named-event

Data Sources (with inbuilt HDEA functionality) SHALL be capable of submitting the RESP-NET reporting Bundle to the Public Health Agency(PHA) using $process-message operation

Data Sources (with inbuilt HDEA functionality) SHALL use SMART on FHIR Backend Services to authenticate and authorize with the PHA to submit the bundle to the $process-message operation

Data Source supporting External HDEA application

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.

The rest of the requirements identified below in this capability statement only apply Data Sources supporting external HDEA Applications

Security Requirements:

Data Sources supporting external HDEA applications must meet the general security requirements documented in FHIR Security guidance.

In addition the Data Source supporting external HDEA applications (e.g EHR) needs to meet the security requirements as outlined in the Formal Specification - SMART on FHIR Backend Services Requirements.

US Core Support

The Data Source supporting external HDEA (e.g EHR) SHALL implement the US Core Server capability statement as foundational FHIR APIs needed by the RESP-NET Content IG.


Resource summary for Data Sources supporting external HDEA applications

Resource Search Read Read Version Instance History Resource History Create Update Delete Operations
Backported Subscription SHALL SHALL SHALL SHALL $topic-list $status
Encounter End Subscription Topic SHALL SHALL SHALL SHALL
Backport Subscription Notification Bundle SHALL
Backport Subscription Status SHALL
US Core APIs SHALL SHALL
MedicationAdministration SHALL SHALL


Subscription (Includes Subscriptions for encounter-close Subscription Topic)

Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription.html

Interactions

Name Description
  read

Allows retrieval of a specific Subscription instance.
  create

Allows creation of Subscription instances
  update

Allows Update of Subscription instances
  delete

Allows deletion of Subscription instances


Bundle (Notification Bundle for Subscriptions)

Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription-notification.html)

Interactions

Name Description
  create

Allows creation of Notification Bundles for Subscriptions



Parameters (Parameters Profile to retrieve Subscription Status)

Profile: "subscriptionstatus profile from Subscription-backport Implementation Guide"

Interactions

Name Description
  read

Allows clients to request Subscription Status for Subscriptions



US Core APIs

Profile: All US Core profiles

Interactions

Name Description
  search

Allows searching of specific US Core resource profile instances.
  read

Allows retrieval of specific US Core resource profile instances


MedicationAdministration

Profile: "us-ph-medicationadministration from Public Health Library"

Interactions

Name Description
  search

Allows searching of specific MedicationAdministration resource profile instances.
  read

Allows retrieval of specific MedicationAdministration resource profile instances