Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0-ballot - STU1 Ballot
Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0-ballot - STU1 Ballot
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-ballot 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
| Draft as of 2020-12-06 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:CapabilityStatement ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "resp-net-data-source"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Data Source (e.g EHR)</h2>\n <p>(Requirements Definition Capability Statement)</p>\n <p>Canonical URL: http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source</p>\n <p>Published by: <b>HL7 International - Public Health Work Group</b>\n </p>\n <p>This profile defines the expected capabilities of the <i>Data Source (e.g EHR) </i> actor to support the RESP-NET use cases. \n This actor is responsible for notifying HDEA based on Named Events and support US Core FHIR APIs for data queries.</p>\n <h2>General</h2>\n <div class=\"table-wrapper\">\n <table>\n <tbody>\n <tr>\n <th>FHIR Version:</th>\n <td>4.0.1</td>\n </tr>\n <tr>\n <th>Supported formats:</th>\n <td>json</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h2>REST behavior</h2>\n <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>\n <p>\n <b>Security:</b>\n </p>\n <p>Implementations must meet the general security requirements documented in FHIR <a href=\"http://hl7.org/fhir/security.html\">Security guidance</a>.</p>\n <p>In addition the Data Source (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>\n\n <h3>US Core Support</h3>\n\n <p>\n The Data Source (e.g EHR) <b>SHALL</b> implement the \n <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 health care surveys IG.\n </p>\n <br/>\n\n <h3>Resource summary</h3>\n <div class=\"table-wrapper\">\n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource</th>\n <th>Search</th>\n <th>Read</th>\n <th>Read Version</th>\n <th>Instance History</th>\n <th>Resource History</th>\n <th>Create</th>\n <th>Update</th>\n <th>Delete</th>\n <th>Operations</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th><a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription.html\">Backported Subscription</a></th>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-read\" title=\"Allows retrieval of a specific Subscription Resource instances.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-create\" title=\"Allows creation of a specific Subscription Resource instance\">SHALL</a>\n </td>\n <td>\n <a href=\"#Subscription-update\" title=\"Allows update of a specific Subscription Resource instance\">SHALL</a>\n </td>\n <td>\n <a href=\"#Subscription-delete\" title=\"Allows deletion of a specific Subscription Resource instance\">SHALL</a>\n </td>\n <td>\n <a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/OperationDefinition-backport-subscriptiontopic-list.html\">$topic-list</a>\n <a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/OperationDefinition-backport-subscription-status.html\">$status</a>\n </td>\n </tr>\n <tr>\n <th><a href=\"http://build.fhir.org/ig/HL7/fhir-medmorph/StructureDefinition-medmorph-encounter-end-subscription.html\">Encounter End Subscription Topic</a></th>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-read\" title=\"Allows retrieval of a Encounter End Subscription instance.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-create\" title=\"Allows creation of a Subscription Resource instance for Encounter End event notification\">SHALL</a>\n </td>\n <td>\n <a href=\"#Subscription-update\" title=\"Allows update of a Subscription Resource instance for Encounter End event notification\">SHALL</a>\n </td>\n <td>\n <a href=\"#Subscription-delete\" title=\"Allows deletion of a Subscription Resource instance for Encounter End event notification\">SHALL</a>\n </td>\n <td>\n </td>\n </tr>\n <tr>\n <th><a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription-notification.html\">Backport Subscription Notification Bundle</a></th>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n <a href=\"#Notification-Bundle-create\" title=\"Allows creation of a Subscription Notification Bundle for Encounter close event\">SHALL</a>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n </tr>\n <tr>\n <th><a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscriptionstatus.html\">Backport Subscription Status</a></th>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-Status-read\" title=\"Allows retrieval of a Subscription Status for a specific Subscription\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n </tr>\n <tr>\n <th>US Core APIs</th>\n <td>\n <a href=\"#USCore-search-type\" title=\"Allows search of a specific US Core Resource instances.\">SHALL</a>\n </td>\n <td>\n <a href=\"#USCore-read\" title=\"Allows retrieval of a specific US Core Resource instances.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n </tr>\n <tr>\n <th><a href=\"http://hl7.org/fhir/R4/medicationadministration.html\">MedicationAdministration</a></th>\n <td>\n <a href=\"#MedAdm-search\" title=\"Allows search of a specific US Core Resource instances.\">SHALL</a>\n </td>\n <td>\n <a href=\"#MedAdm-read\" title=\"Allows retrieval of a specific US Core Resource instances.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n \n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription (Includes Subscriptions for encounter-close Subscription Topic)</a>\n </h3>\n <p>Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription.html\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Subscription-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific Subscription instance.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Subscription-create\"> </a>\n <span>create</span>\n </th>\n <td>\n <p>Allows creation of Subscription instances</p>\n </td>\n </tr> \n <tr>\n <th>\n <a name=\"Subscription-update\"> </a>\n <span>update</span>\n </th>\n <td>\n <p>Allows Update of Subscription instances</p>\n </td>\n </tr> \n <tr>\n <th>\n <a name=\"Subscription-delete\"> </a>\n <span>update</span>\n </th>\n <td>\n <p>Allows deletion of Subscription instances</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/> \n <h3>\n <a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle (Notification Bundle for Subscriptions)</a>\n </h3>\n <p>Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription-notification.html)\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Notification-Bundle-create\"> </a>\n <span>create</span>\n </th>\n <td>\n <p>Allows creation of Notification Bundles for Subscriptions </p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/parameters.html\">Parameters (Parameters Profile to retrieve Subscription Status)</a>\n </h3>\n <p>Profile: ("http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscriptionstatus.html")\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Subscription-Status-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows clients to request Subscription Status for Subscriptions </p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/us/core\">US Core APIs</a>\n </h3>\n <p>Profile: None\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"USCore-search-type\"> </a>\n <span>search</span>\n </th>\n <td>\n <p>Allows searching of specific US Core resource profile instances.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"USCore-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of specific US Core resource profile instances</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/> \n <h3>\n <a href=\"http://hl7.org/fhir/medicationadministration.html\">MedicationAdministation</a>\n </h3>\n <p>Profile: ("resp-net-medicationadministration.html")\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"MedAdm-search\"> </a>\n <span>search</span>\n </th>\n <td>\n <p>Allows searching of specific MedicationAdministration resource profile instances.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"MedAdm-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of specific MedicationAdministration resource profile instances</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/> \n </div>"
] ; #
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
fhir:value [ fhir:v "pher" ]
] ) ; #
fhir:url [ fhir:v "http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source"^^xsd:anyURI] ; #
fhir:version [ fhir:v "1.0.0-ballot"] ; #
fhir:name [ fhir:v "RespNetEHRCapabilityStatement"] ; #
fhir:title [ fhir:v "RESP-NET EHR Capability Statement"] ; #
fhir:status [ fhir:v "draft"] ; #
fhir:date [ fhir:v "2020-12-06"^^xsd:date] ; #
fhir:publisher [ fhir:v "HL7 International / Public Health"] ; #
fhir:contact ( [
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/pher" ] ] )
] ) ; #
fhir:description [ fhir:v "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."] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "US" ] ] )
] ) ; #
fhir:kind [ fhir:v "requirements"] ; #
fhir:fhirVersion [ fhir:v "4.0.1"] ; #
fhir:format ( [ fhir:v "json"] ) ; #
fhir:rest ( [
fhir:mode [ fhir:v "server" ] ;
fhir:documentation [ fhir:v "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. " ] ;
fhir:security [
fhir:description [ fhir:v "Implementations must meet the general security requirements documented in the security section of the implementation guide." ] ] ;
( fhir:resource [
fhir:type [ fhir:v "Subscription" ] ;
( fhir:interaction [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:code [ fhir:v "read" ] ;
fhir:documentation [ fhir:v "Allows retrieval of a specific Subscription instance." ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:code [ fhir:v "create" ] ;
fhir:documentation [ fhir:v "Allows creation of a Subscription resource instance." ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:code [ fhir:v "update" ] ;
fhir:documentation [ fhir:v "Allows update of a Subscription resource instance." ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:code [ fhir:v "delete" ] ;
fhir:documentation [ fhir:v "Allows deletion of a Subscription resource instance." ] ] ) ] )
] ) . #
IG © 2021+ HL7 International / Public Health. Package hl7.fhir.us.resp-net#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change