Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1
Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1
This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) (v1.0.0: STU1 Release 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). 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="medmorph-healthdata-exchange-app-client"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<h2>Health Data Exchange App (HDEA) Client Application - (MedMorph backend services app)</h2>
<p>(Requirements Definition Capability Statement)</p>
<p>Canonical URL: http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-healthdata-exchange-app-client</p>
<p>Published by: <b>HL7 International - Public Health Work Group</b>
</p>
<p>This CapabilityStatement defines the expected capabilities of the HDEA actor when conforming to the MedMorph IG and acting as a client initiating the interactions with both the Data Source and the Data Receivers/TTP.
This actor is responsible for consuming Knowledge Artifacts created by Public Health Agencies and/or Research Organizations, subscribing to topics in Data Sources using Named Events, Creating the submission reports and finally submitting the reports to the Data Receiver. </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 HDEA is to consuming Knowledge Artifacts created by PHA/RO, subscribing to topics in Data Sources using Named Events, creating the submission reports and finally submitting the reports to the Data Receivers.</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 HDEA 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>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>
</tr>
</thead>
<tbody>
<tr>
<th>PlanDefinition (<a href="StructureDefinition-us-ph-plandefinition.html">Profile</a>)</th>
<td>
<a href="#PlanDefinition-search-type" title="Allows a user to search for existing PlanDefinition instances">SHALL</a>
</td>
<td>
<a href="#PlanDefinition-read" title="Allows retrieval of a specific PlanDefinition Resource instance ">SHALL</a>
</td>
<td>
<a href="#PlanDefinition-vread" title="Allows retrieval of a specific PlanDefinition Resource instance version">SHOULD</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td/>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/plandefinition.html">PlanDefinition</a>
</h3>
<p>Profile: <a href="StructureDefinition-us-ph-plandefinition.html">http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition</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="PlanDefinition-search-type"> </a>
<span>search-type</span>
</th>
<td>
<p>Allows discovery of existing PlanDefinition instances representing Knowledge Artifacts.</p>
</td>
</tr>
<tr>
<th>
<a name="PlanDefinition-read"> </a>
<span>read</span>
</th>
<td>
<p>Allows retrieval of a specific PlanDefinition instance.</p>
</td>
</tr>
<tr>
<th>
<a name="PlanDefinition-vread"> </a>
<span>vread</span>
</th>
<td>
<p>Allows retrieval of a historical version of a PlanDefinition instance.</p>
</td>
</tr>
<tr>
<th>
<a name="PlanDefinition-create"> </a>
<span>create</span>
</th>
<td>
<p>Allows creation of PlanDefinition instances</p>
</td>
</tr>
<tr>
<th>
<a name="PlanDefinition-update"> </a>
<span>update</span>
</th>
<td>
<p>Allows Updating of PlanDefinition instances</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h4>Search</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Definition & Chaining</th>
</tr>
</thead>
<tbody>
<tr>
<th>identifier</th>
<td>token</td>
<td>Search using identifiers as allowed according to the FHIR specification.</td>
</tr>
<tr>
<th>name</th>
<td>string</td>
<td>Search using PlanDefinition name.</td>
</tr>
<tr>
<th>publisher</th>
<td>string</td>
<td>Search using publisher name.</td>
</tr>
<tr>
<th>title</th>
<td>string</td>
<td>Search using title.</td>
</tr>
<tr>
<th>version</th>
<td>string</td>
<td>Search using version.</td>
</tr>
<tr>
<th>name and version</th>
<td>string, string</td>
<td>Search using name and version.</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>FHIR Operations summary</h3>
<p>The HDEA SHALL be capable of invoking these operations passing and collecting FHIR resources</p>
<ul>
<li>
<a href="OperationDefinition-Bundle-pseudonymize.html">Bundle pseudonymize</a>
</li>
<li>
<a href="OperationDefinition-Bundle-anonymize.html">Bundle anonymize</a>
</li>
<li>
<a href="OperationDefinition-Bundle-de-identify.html">Bundle de-identify</a>
</li>
<li>
<a href="OperationDefinition-Bundle-re-identify.html">Bundle re-identify</a>
</li>
<li>
<a href="OperationDefinition-Bundle-hash.html">Bundle hash</a>
</li>
<li>
<a href="http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message">process-message</a>
</li>
</ul>
<br/>
</div>
</text>
<url
value="http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-healthdata-exchange-app-client"/>
<version value="1.0.0"/>
<name value="HealthDataExchangeAppClientMode"/>
<title
value="Health Data Exchange App (HDEA) Client Application - (MedMorph backend services app)"/>
<status value="draft"/>
<date value="2020-12-06"/>
<publisher value="HL7 International - Public Health Work Group"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://hl7.org/Special/committees/pher"/>
</telecom>
</contact>
<description
value="This CapabilityStatement defines the expected capabilities of the HDEA actor when conforming to the MedMorph RA IG and playing the role of a client initiating the interactions with both Data Sources and Data Receivers/TTP."/>
<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="client"/>
<documentation
value="The focus of the HDEA is to act as a client and access Knowledge Artifacts, create subscriptions, receive notifications, create message bundles, invoke trust services and submit reports. "/>
<security>
<description
value="Implementations must meet the general security requirements documented in the security section of the implementation guide."/>
</security>
<resource>
<type value="PlanDefinition"/>
<supportedProfile
value="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows discovery of existing PlanDefinition instances."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Allows retrieval of a specific PlanDefinition instance."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
<documentation
value="Allows retrieval of a historical version of a PlanDefinition instance."/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PlanDefinition-name"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="publisher"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="title"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PlanDefinition-title"/>
<type value="string"/>
</searchParam>
</resource>
<resource>
<type value="Bundle"/>
<supportedProfile
value="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"/>
<supportedProfile
value="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-content-bundle"/>
<operation>
<name value="pseudonymize"/>
<definition
value="http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-pseudonymize"/>
</operation>
<operation>
<name value="anonymize"/>
<definition
value="http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-anonymize"/>
</operation>
<operation>
<name value="de-identify"/>
<definition
value="http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-de-identify"/>
</operation>
<operation>
<name value="re-identify"/>
<definition
value="http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-re-identify"/>
</operation>
</resource>
<operation>
<name value="process-message"/>
<definition
value="http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"/>
</operation>
</rest>
<rest>
<mode value="server"/>
<documentation
value="The focus of the HDEA as a Server is to expose $process-message endpoint at the root of the FHIR server."/>
<security>
<description
value="Implementations must meet the general security requirements documented in the security section of the implementation guide."/>
</security>
<operation>
<name value="process-message"/>
<definition
value="http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"/>
</operation>
</rest>
</CapabilityStatement>
IG © 2020+ HL7 International - Public Health Work Group. Package hl7.fhir.us.medmorph#1.0.0 based on FHIR 4.0.1. Generated 2023-06-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change