Central Cancer Registry Reporting Content IG
1.0.0 - STU 1
Central Cancer Registry Reporting Content IG
1.0.0 - STU 1
This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Central Cancer Registry Reporting Content IG (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Draft as of 2020-12-06 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="central-cancer-registry-reporting-ehr"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<h2>EHR</h2>
<p>(Requirements Definition Capability Statement)</p>
<p>Canonical URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/CapabilityStatement/central-cancer-registry-reporting-ehr</p>
<p>Published by: <b>HL7 International - Public Health Work Group</b>
</p>
<p>This profile defines the expected capabilities of the <i>EHR </i> actor to support the central cancer registry reporting use cases.
This actor is responsible for publishing Subscription Topics based on Named Events, generate notifications base on subscriptions and support US Core FHIR APIs.</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>
<p>The primary focus of the EHR is to allow the creation, modification and deletion of Subscriptions, notify subscribers based on subscriptions and support US Core APIs.</p>
<p>
<b>Security:</b>
</p>
<p>Implementations 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 EHR needs to meet the security requirements as outlined in the <a href="spec.html#authentication-and-authorization-requirements">Formal Specification - Security Section.</a></p>
<h3>US Core Support</h3>
<p>
The 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 Central Cancer Registry Reporting IG.
</p>
<br/>
<h3>mCode Support</h3>
<p>
The EHR <b>SHALL</b> implement the
<a href="spec.html#mcode-fhir-ig-usage">mCode profiles</a> outlined to support the Central Cancer Registry Reporting IG.
</p>
<br/>
<h3>Resource summary</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://hl7.org/fhir/uv/subscriptions-backport/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">MAY</a>
</td>
<td>
<a href="#Subscription-update" title="Allows update of a specific Subscription Resource instance">MAY</a>
</td>
<td>
<a href="#Subscription-delete" title="Allows deletion of a specific Subscription Resource instance">MAY</a>
</td>
<td>
$status
</td>
</tr>
<tr>
<th><a href="http://hl7.org/fhir/us/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 specific Encounter End Subscription instance.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
<a href="#Subscription-create" title="Allows creation of a specific Subscription Resource instance for Encounter End event">MAY</a>
</td>
<td>
<a href="#Subscription-update" title="Allows update of a specific Subscription Resource instance for Encounter End event">MAY</a>
</td>
<td>
<a href="#Subscription-delete" title="Allows deletion of a specific Subscription Resource instance for Encounter End event">MAY</a>
</td>
<td>
</td>
</tr>
<tr>
<th><a href="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription-notification-r4.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://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription-status-r4.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><a href="http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html">US Core APIs</a></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>
</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><a href="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription.html">Profile</a>
</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>update</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 (Notifcation Bundle for Subscriptions)</a>
</h3>
<p><a href="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription-notification-r4.html">Profile</a>
</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 Notifcation 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><a href="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription-status-r4.html">Profile</a>
</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/STU3.1.1/">US Core APIs</a>
</h3>
<p>Profile: None
</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/>
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="pher"/>
</extension>
<url
value="http://hl7.org/fhir/us/central-cancer-registry-reporting/CapabilityStatement/central-cancer-registry-reporting-ehr"/>
<version value="1.0.0"/>
<name value="CentralCancerRegistryReportingEHRCapabilityStatement"/>
<title value="Central Cancer Registry Reporting 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 Central Cancer Registry Reporting Content IG. 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="MAY"/>
</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="MAY"/>
</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="MAY"/>
</extension>
<code value="delete"/>
<documentation
value="Allows deletion of a Subscription resource instance."/>
</interaction>
</resource>
</rest>
</CapabilityStatement>
IG © 2021+ HL7 International / Public Health. Package hl7.fhir.us.central-cancer-registry-reporting#1.0.0 based on FHIR 4.0.1. Generated 2024-05-31
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change