minimal Common Oncology Data Elements (mCODE) Implementation Guide
3.0.0 - STU3 Release
minimal Common Oncology Data Elements (mCODE) Implementation Guide
3.0.0 - STU3 Release
This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v3.0.0: STU 3) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Draft as of 2020-10-30 |
{
"resourceType" : "CapabilityStatement",
"id" : "mcode-sender-cancer-conditions-then-patients",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">mCODE Data Sender: Get Conditions then Patients</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-cancer-conditions-then-patients</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>Retrieves a Bundle of Condition resources with a code in mCODE's cancer condition value set, and allows for associated Patient resources to be retrieved in a subsequent request. Use ONLY when reverse chaining AND <code>_include</code> are not available on the system.</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\">minimal Common Oncology Data Elements (mCODE) Implementation Guide</a></li></ul> <!-- Imports --><h3 id=\"should_css\" class=\"no_toc\">Include And Support Everything In The Following CapabilityStatements:</h3><ul><li><a href=\"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server\">US Core Server CapabilityStatement</a></li></ul> <!-- REST Behavior --><h3 id=\"behavior\">FHIR Server RESTful Capabilities</h3><p>An mCODE Server <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 Server <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 server <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><p><i>♦ = <b>SHALL</b> expectation</i>;<i>⋄ = <b>SHOULD</b> expectation</i>;<i>▿ = <b>MAY</b> expectation</i>;</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\"><span style=\"white-space: nowrap;\">Patient<span title=\"SHALL\"><sup>♦</sup></span></span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient\">Cancer Patient Profile</a><span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">_id<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#condition\"><span style=\"white-space: nowrap;\">Condition<span title=\"SHALL\"><sup>♦</sup></span></span></a></td><td><span style=\"white-space: nowrap;\">search-type<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Profiles --><td><span style=\"white-space: nowrap;\"><a href=\"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient\">Cancer Patient Profile</a></span></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">code:in<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#group\"><span style=\"white-space: nowrap;\">Group<span title=\"SHALL\"><sup>♦</sup></span></span></a></td><td><span style=\"white-space: nowrap;\">search-type<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Profiles --><td></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">code<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td></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 Profile</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning a Patient resource using:<code class=\"highlighter-rouge\">GET [base]/Patient/[id]</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/us/core/STU5.0.1/SearchParameter-us-core-patient-id.html#id\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?_id=[id]</code></td></tr></tbody></table><h4 id=\"condition\" class=\"no_toc\">Condition</h4><p>Conformance Expectation:<strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient\">Cancer Patient Profile</a></li></ul><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>Identify Patient resources conforming to mCODE's CancerPatient profile via searching for conditions in a specific ValueSet.</p></blockquote><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/Condition/[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/condition.html#search\">code:in</a></td><td>uri</td><td><code class=\"highlighter-rouge\">GET [base]/Condition?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 Server <strong>SHALL</strong> be capable of returning 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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cic"
}
],
"url" : "http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-cancer-conditions-then-patients",
"version" : "3.0.0",
"name" : "CapabilityStatementSenderConditionsThenPatients",
"title" : "mCODE Data Sender: Get Conditions then Patients",
"status" : "draft",
"experimental" : true,
"date" : "2020-10-30T07:15:00.000000-04:00",
"publisher" : "HL7 International / Clinical Interoperability Council",
"contact" : [
{
"name" : "HL7 International / Clinical Interoperability Council",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cic"
},
{
"system" : "email",
"value" : "ciclist@lists.HL7.org"
}
]
}
],
"description" : "Retrieves a Bundle of Condition resources with a code in mCODE's cancer condition value set, and allows for associated Patient resources to be retrieved in a subsequent request. Use ONLY when reverse chaining AND `_include` are not available on the system.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"kind" : "requirements",
"imports" : [
"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server"
],
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"implementationGuide" : [
"http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode"
],
"rest" : [
{
"mode" : "server",
"documentation" : "An mCODE Server **SHALL**:\n\n1. Support all profiles defined in this Implementation Guide..\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scope\n - (Status 404): unknown resource\n - (Status 410): deleted resource.\n1. Support json source formats for all mCODE interactions.\n1. Identify the mCODE profiles supported as part of the FHIR `meta.profile` attribute for each instance.\n1. Support the searchParameters on each profile individually and in combination.\n\nThe mCODE Server **SHOULD**:\n\n1. Support xml source formats for all mCODE interactions.\n",
"security" : {
"description" : "1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Patient",
"supportedProfile" : [
"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id",
"type" : "token"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Condition",
"supportedProfile" : [
"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Identify Patient resources conforming to mCODE's CancerPatient profile via searching for conditions in a specific ValueSet."
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code:in",
"definition" : "http://hl7.org/fhir/us/mcode/SearchParameter/Condition-code",
"type" : "uri"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Group",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Retrieve Group of references to Patient resources conforming to mCODE."
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-code",
"type" : "token"
}
]
}
]
}
]
}
IG © 2019+ HL7 International / Clinical Interoperability Council. Package hl7.fhir.us.mcode#3.0.0 based on FHIR 4.0.1. Generated 2023-10-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change