Common Data Models Harmonization
1.0.0 - STU 1 Publication
Common Data Models Harmonization
1.0.0 - STU 1 Publication
Common Data Models Harmonization, published by HL7 International - Biomedical Research and Regulation Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cdmh/ and changes regularly. See the Directory of published versions
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="cdmh-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/cdmh/CapabilityStatement/cdmh-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 CDMH IG use cases.
This actor is responsible for supporting ResearchStudy, Group Resource, Group export operations along with the CDMH IG and US Core profiles.</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 of a ResearchStudy, Group resource and support the Group export operation for the CDMH IG and US Core profiles. </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>
<h3>US Core Support</h3>
<p>
The EHR <b>SHALL</b> support the profiles listed in
<a href="http://hl7.org/fhir/us/core/STU4/CapabilityStatement-us-core-server.html">US Core Server capability statement</a> as foundational FHIR profiles needed by the CDMH IG.
</p>
<br/>
<h3>CDMH IG Profiles</h3>
<p>
The EHR <b>SHOULD</b> support the profiles listed in
<a href="artifacts.html">CDMH IG</a> for populating multiple common data models.
</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/R4/researchstudy.html">ResearchStudy</a></th>
<td>
<a href="#ResearchStudy-search" title="Allows search of a specific ResearchStudy Resource instances using names and identifiers.">SHALL</a>
</td>
<td>
<a href="#ResearchStudy-read" title="Allows retrieval of specific ResearchStudy instances using ids.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
<a href="#ResearchStudy-create" title="Allows creation of a specific ResearchStudy Resource instance to record participants in a research program.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<th><a href="http://hl7.org/fhir/R4/group.html">Group</a></th>
<td>
<a href="#Group-search" title="Allows search of a specific Group Resource instances using names and identifiers.">SHALL</a>
</td>
<td>
<a href="#Group-read" title="Allows retrieval of specific Group instances using ids.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
<a href="#Group-create" title="Allows creation of a specific Group Resource instance to record participants in a research program.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
<a href="#Group-export" title="Allows bulk export of data using the Group/$export operation">Bulk Data IG: Group/$export: SHALL</a>
</td>
</tr>
<tr>
<th>US Core Profiles</th>
<td>
</td>
<td>
<a href="#USCore-read" title="Allows retrieval of a specific US Core Resource instances as part of the Group/$export operation.">SHALL</a>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<th><a href="artifacts.html#structures-resource-profiles">CDMH IG Profiles</a></th>
<td>
</td>
<td>
<a href="#CDMH-read" title="Allows retrieval of a specific CDMH Resource instances as part of the Group/$export operation.">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/researchstudy.html">ResearchStudy</a>
</h3>
<p>Profile: <a href="StructureDefinition-cdmh-researchstudy.html">CdmhResearchStudy</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="ResearchStudy-create"> </a>
<span>search</span>
</th>
<td>
<p>Allows creation of a specific ResearchStudy resource instances to record participants in a research program.</p>
</td>
</tr>
<tr>
<th>
<a name="ResearchStudy-search"> </a>
<span>search</span>
</th>
<td>
<p>Allows searching of specific ResearchStudy resource profile instances.</p>
</td>
</tr>
<tr>
<th>
<a name="ResearchStudy-read"> </a>
<span>read</span>
</th>
<td>
<p>Allows retrieval of specific ResearchStudy resource profile 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.</td>
</tr>
<tr>
<th>title</th>
<td>string</td>
<td>Search using ResearchStudy name which represents the Research program name.</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a href="http://hl7.org/fhir/group.html">Group</a>
</h3>
<p>Profile: <a href="StructureDefinition-cdmh-group.html">CdmhGroup</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="Group-create"> </a>
<span>search</span>
</th>
<td>
<p>Allows creation of a specific Group resource instances to record participants in a research program.</p>
</td>
</tr>
<tr>
<th>
<a name="Group-search"> </a>
<span>search</span>
</th>
<td>
<p>Allows searching of specific Group resource profile instances.</p>
</td>
</tr>
<tr>
<th>
<a name="Group-read"> </a>
<span>read</span>
</th>
<td>
<p>Allows retrieval of specific Group resource profile instances</p>
</td>
</tr>
<tr>
<th>
<a name="Group-export"> </a>
<span>Bulk Data IG: Group/$export operation</span>
</th>
<td>
<p>Allows retrieval of specific data associated with patients who are part of the Group.</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.</td>
</tr>
<tr>
<th>name</th>
<td>string</td>
<td>Search using Group name which represents the Research program name.</td>
</tr>
</tbody>
</table>
</div>
<h3>
<a href="http://hl7.org/fhir/us/core">US Core Profiles</a>
</h3>
<p>Profile: <a href="http://hl7.org/fhir/us/core/STU4/CapabilityStatement-us-core-server.html">Profiles listed in US Core</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="USCore-read"> </a>
<span>read</span>
</th>
<td>
<p>Allows retrieval of specific US Core resource profile instances as part of the Group/$export operation.</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a>CDMH IG Profiles</a>
</h3>
<p>Profile: <a href="artifacts.html#structures-resource-profiles">Profiles listed in CDMH IG</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="CDMH-read"> </a>
<span>read</span>
</th>
<td>
<p>Allows retrieval of specific CDMH resource profile instances as part of the Group/$export operation.</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
</div>
</text>
<url value="http://hl7.org/fhir/us/cdmh/CapabilityStatement/cdmh-ehr"/>
<version value="1.0.0"/>
<name value="CdmhEHRCapabilityStatement"/>
<title value="Cdmh EHR Capability Statement"/>
<status value="draft"/>
<date value="2020-12-06"/>
<publisher
value="HL7 International - Biomedical Research and Regulation Work Group"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://hl7.org/Special/committees/rcrim"/>
</telecom>
</contact>
<description
value="This profile defines the expected capabilities of the ''EHR'' actor when conforming to the CDMH IG. This role is responsible for allowing creation and retrieval of ResearchStudy, and Group resources, along with retrieval of clinical data using the Group/$export operation."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<copyright
value="Used by permission of HL7, all rights reserved Creative Commons License"/>
<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 and retrieval of ResearchStudy and Group resources and clinical data using the Group/$export operation."/>
<security>
<description
value="Implementations must meet the general security requirements documented in the security section of the implementation guide."/>
</security>
<resource>
<type value="ResearchStudy"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Allows retrieval of a specific ResearchStudy 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 ResearchStudy resource instance."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows search of a ResearchStudy resource instance using identifiers and names."/>
</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/Group-identifier"/>
<type value="token"/>
</searchParam>
</resource>
<resource>
<type value="Group"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation value="Allows retrieval of a specific Group 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 Group resource instance."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows search of a Group resource instance using identifiers and names."/>
</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/Group-identifier"/>
<type value="token"/>
</searchParam>
<operation>
<name value="export"/>
<definition
value="http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export"/>
</operation>
</resource>
</rest>
</CapabilityStatement>
IG © 2019+ HL7 International - Biomedical Research and Regulation Work Group. Package hl7.fhir.us.cdmh#1.0.0 based on FHIR 4.0.1. Generated 2021-12-06
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change