minimal Common Oncology Data Elements (mCODE) Implementation Guide
2.0.0 - STU 2
minimal Common Oncology Data Elements (mCODE) Implementation Guide
2.0.0 - STU 2
This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v2.0.0: STU 2) 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 
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="mcode-receiver-patients-with-cancer-condition"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">mCODE Data Receiver CapabilityStatement: Get in-scope patients using reverse chaining</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patients-with-cancer-condition</code></li><li><b>Implementation Guide Version:</b> None</li><li><b>FHIR Version:</b> 4.0.1</li><li><b>Intended Use:</b> Requirements</li><li><b>Supported Formats:</b> XML, JSON</li><li><b>Published:</b> 2020-10-30 07:15:00.000000-04:00</li><li><b>Published by:</b> None</li><li><b>Status:</b> Draft (experimental)</li></ul><p>Uses reverse chaining to retrieve a Bundle of Patient resources with a condition code in mCODE's cancer condition value set.</p> <!-- No support expectation extension --><h3 id="igs" class="no_toc">Support the Following Implementation Guides:</h3><ul><li><a href="http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode">HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1</a></li></ul> <!-- REST Behavior --><h3 id="behavior">FHIR Client RESTful Capabilities</h3><p>An mCODE Client <strong>SHALL</strong>:</p><ol><li>Support all profiles defined in this Implementation Guide..</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Return the following response classes:<ul><li>(Status 400): invalid parameter</li><li>(Status 401/4xx): unauthorized request</li><li>(Status 403): insufficient scope</li><li>(Status 404): unknown resource</li><li>(Status 410): deleted resource.</li></ul></li><li>Support json source formats for all mCODE interactions.</li><li>Identify the mCODE profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li><li>Support the searchParameters on each profile individually and in combination.</li></ol><p>The mCODE Client <strong>SHOULD</strong>:</p><ol><li>Support xml source formats for all mCODE interactions.</li></ol><p id="security"><strong>Security:</strong></p><ol><li>See the <a href="https://www.hl7.org/fhir/security.html#general">General Security Considerations</a> section for requirements and recommendations.</li><li>A client <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li></ol><h3 id="resource--details" class="no_toc">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary</strong></p><table class="grid"><thead><tr><th>Resource Type</th><th>Supported Interactions</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href="#patient">Patient</a></td><td>read, search-type</td> <!-- Supported Profiles --><td><a href="http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient">Cancer Patient</a></td> <!-- Supported Searches --><td>_has:Condition:subject:code:in</td> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td/> <!-- Supported Operations --><td/></tr><tr><td><a href="#group">Group</a></td><td>search-type</td> <!-- Supported Profiles --><td/> <!-- Supported Searches --><td>code</td> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td/> <!-- Supported Operations --><td/></tr></tbody></table> <!-- Resource Details --><h4 id="patient" class="no_toc">Patient</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support: <a href="http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient">Cancer Patient</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>search-type<sup>†</sup></p><p>Identify Patient resources conforming to mCODE's CancerPatient profile via reverse chaining searching for conditions in a specific ValueSet.</p></blockquote><p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching a Patient resource using: <code class="highlighter-rouge">GET [base]/Patient/[id]</code></li><li>A Client <strong>SHALL</strong> be capable of fetching resources matching a search query using: <code class="highlighter-rouge">GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html#has">_has:Condition:subject:code:in</a></td><td>uri</td><td><code class="highlighter-rouge">GET [base]/Patient?_has:Condition:subject:code:in=[uri]</code></td></tr></tbody></table><h4 id="group" class="no_toc">Group</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>search-type</code><sup>†</sup>.</li></ul><blockquote><p>search-type<sup>†</sup></p><p>Retrieve Group of references to Patient resources conforming to mCODE.</p></blockquote><p>Fetch and Search Criteria:</p><ul><li>A Client <strong>SHALL</strong> be capable of fetching resources matching a search query using: <code class="highlighter-rouge">GET [base]/Group/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/group.html#search">code</a></td><td>token</td><td><code class="highlighter-rouge">GET [base]/Group?code=[system]|[code]</code></td></tr></tbody></table></div>
</text>
<url
value="http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patients-with-cancer-condition"/>
<version value="2.0.0"/>
<name value="CapabilityStatementReceiverPatientsWithCancerCondition"/>
<title
value="mCODE Data Receiver CapabilityStatement: Get in-scope patients using reverse chaining"/>
<status value="draft"/>
<experimental value="true"/>
<date value="2020-10-30T07:15:00.000000-04:00"/>
<publisher value="HL7 International Clinical Interoperability Council"/>
<contact>
<name value="HL7 International Clinical Interoperability Council"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cic"/>
</telecom>
<telecom>
<system value="email"/>
<value value="ciclist@lists.HL7.org"/>
</telecom>
</contact>
<description
value="Uses reverse chaining to retrieve a Bundle of Patient resources with a condition code in mCODE's cancer condition value set."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="xml"/>
<format value="json"/>
<implementationGuide
value="http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode"/>
<rest>
<mode value="client"/>
<documentation
value="An mCODE Client **SHALL**:
1. Support all profiles defined in this Implementation Guide..
1. Implement the RESTful behavior according to the FHIR specification.
1. Return the following response classes:
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scope
- (Status 404): unknown resource
- (Status 410): deleted resource.
1. Support json source formats for all mCODE interactions.
1. Identify the mCODE profiles supported as part of the FHIR `meta.profile` attribute for each instance.
1. Support the searchParameters on each profile individually and in combination.
The mCODE Client **SHOULD**:
1. Support xml source formats for all mCODE interactions.
"/>
<security>
<description
value="1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.
1. A client **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."/>
</security>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Patient"/>
<supportedProfile
value="http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Identify Patient resources conforming to mCODE's CancerPatient profile via reverse chaining searching for conditions in a specific ValueSet."/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_has:Condition:subject:code:in"/>
<type value="uri"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Group"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Retrieve Group of references to Patient resources conforming to mCODE."/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="code"/>
<definition value="http://hl7.org/fhir/SearchParameter/Group-code"/>
<type value="token"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>
IG © 2019+ HL7 International Clinical Interoperability Council. Package hl7.fhir.us.mcode#2.0.0 based on FHIR 4.0.1. Generated 2022-01-18
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change