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 
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:CapabilityStatement;
fhir:nodeRole fhir:treeRoot;
fhir:Resource.id [ fhir:value "mcode-sender-patients-and-cancer-conditions"];
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "generated" ];
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">mCODE Data Sender CapabilityStatement: Get in-scope patients (and associated Conditions) using _include</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-patients-and-cancer-conditions</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 <code>_include</code> to retrieve a Bundle of Condition resources with a code in mCODE's cancer condition value set, along with the associated Patient resources. Use ONLY when reverse chaining is 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\">HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1</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><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</td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient\">Cancer Patient</a></td> <!-- Supported Searches --><td/> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td/> <!-- Supported Operations --><td/></tr><tr><td><a href=\"#condition\">Condition</a></td><td>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>code:in</td> <!-- Supported _includes --><td>Condition:subject</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>.</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><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</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><li>A Server <strong>(conformance expectation undefined)</strong> be capable of supporting the following _includes:<ul><li>Condition:subject - <code class=\"highlighter-rouge\">GET [base]/Condition?[parameter=value]&_include=Condition:subject</code></li></ul></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>"
];
fhir:CapabilityStatement.url [ fhir:value "http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-patients-and-cancer-conditions"];
fhir:CapabilityStatement.version [ fhir:value "2.0.0"];
fhir:CapabilityStatement.name [ fhir:value "CapabilityStatementSenderPatientsAndCancerConditions"];
fhir:CapabilityStatement.title [ fhir:value "mCODE Data Sender CapabilityStatement: Get in-scope patients (and associated Conditions) using _include"];
fhir:CapabilityStatement.status [ fhir:value "draft"];
fhir:CapabilityStatement.experimental [ fhir:value "true"^^xsd:boolean];
fhir:CapabilityStatement.date [ fhir:value "2020-10-30T07:15:00.000000-04:00"^^xsd:dateTime];
fhir:CapabilityStatement.publisher [ fhir:value "HL7 International Clinical Interoperability Council"];
fhir:CapabilityStatement.contact [
fhir:index 0;
fhir:ContactDetail.name [ fhir:value "HL7 International Clinical Interoperability Council" ];
fhir:ContactDetail.telecom [
fhir:index 0;
fhir:ContactPoint.system [ fhir:value "url" ];
fhir:ContactPoint.value [ fhir:value "http://www.hl7.org/Special/committees/cic" ] ], [
fhir:index 1;
fhir:ContactPoint.system [ fhir:value "email" ];
fhir:ContactPoint.value [ fhir:value "ciclist@lists.HL7.org" ] ]
];
fhir:CapabilityStatement.description [ fhir:value "Uses `_include` to retrieve a Bundle of Condition resources with a code in mCODE's cancer condition value set, along with the associated Patient resources. Use ONLY when reverse chaining is not available on the system."];
fhir:CapabilityStatement.jurisdiction [
fhir:index 0;
fhir:CodeableConcept.coding [
fhir:index 0;
fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ];
fhir:Coding.code [ fhir:value "US" ];
fhir:Coding.display [ fhir:value "United States of America" ] ]
];
fhir:CapabilityStatement.kind [ fhir:value "requirements"];
fhir:CapabilityStatement.fhirVersion [ fhir:value "4.0.1"];
fhir:CapabilityStatement.format [
fhir:value "xml";
fhir:index 0
], [
fhir:value "json";
fhir:index 1
];
fhir:CapabilityStatement.implementationGuide [
fhir:value "http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode";
fhir:index 0;
fhir:link <http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode>
];
fhir:CapabilityStatement.rest [
fhir:index 0;
fhir:CapabilityStatement.rest.mode [ fhir:value "server" ];
fhir:CapabilityStatement.rest.documentation [ fhir:value "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" ];
fhir:CapabilityStatement.rest.security [
fhir:CapabilityStatement.rest.security.description [ fhir:value "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." ] ];
fhir:CapabilityStatement.rest.resource [
fhir:index 0;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
fhir:Extension.valueCode [ fhir:value "SHALL" ] ];
fhir:CapabilityStatement.rest.resource.type [ fhir:value "Patient" ];
fhir:CapabilityStatement.rest.resource.supportedProfile [
fhir:value "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient";
fhir:index 0;
fhir:link <http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient>;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
fhir:Extension.valueCode [ fhir:value "SHALL" ] ] ];
fhir:CapabilityStatement.rest.resource.interaction [
fhir:index 0;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
fhir:Extension.valueCode [ fhir:value "SHALL" ] ];
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ] ] ], [
fhir:index 1;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
fhir:Extension.valueCode [ fhir:value "SHALL" ] ];
fhir:CapabilityStatement.rest.resource.type [ fhir:value "Condition" ];
fhir:CapabilityStatement.rest.resource.supportedProfile [
fhir:value "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient";
fhir:index 0;
fhir:link <http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient> ];
fhir:CapabilityStatement.rest.resource.interaction [
fhir:index 0;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
fhir:Extension.valueCode [ fhir:value "SHALL" ] ];
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ];
fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Identify Patient resources conforming to mCODE's CancerPatient profile via searching for conditions in a specific ValueSet." ] ];
fhir:CapabilityStatement.rest.resource.searchInclude [
fhir:value "Condition:subject";
fhir:index 0 ];
fhir:CapabilityStatement.rest.resource.searchParam [
fhir:index 0;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
fhir:Extension.valueCode [ fhir:value "SHALL" ] ];
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "code:in" ];
fhir:CapabilityStatement.rest.resource.searchParam.definition [
fhir:value "http://hl7.org/fhir/us/mcode/SearchParameter/Condition-code";
fhir:link <http://hl7.org/fhir/us/mcode/SearchParameter/Condition-code> ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "uri" ] ] ], [
fhir:index 2;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
fhir:Extension.valueCode [ fhir:value "SHALL" ] ];
fhir:CapabilityStatement.rest.resource.type [ fhir:value "Group" ];
fhir:CapabilityStatement.rest.resource.interaction [
fhir:index 0;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
fhir:Extension.valueCode [ fhir:value "SHALL" ] ];
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ];
fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Retrieve Group of references to Patient resources conforming to mCODE." ] ];
fhir:CapabilityStatement.rest.resource.searchParam [
fhir:index 0;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
fhir:Extension.valueCode [ fhir:value "SHALL" ] ];
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "code" ];
fhir:CapabilityStatement.rest.resource.searchParam.definition [
fhir:value "http://hl7.org/fhir/SearchParameter/Group-code";
fhir:link <http://hl7.org/fhir/SearchParameter/Group-code> ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ] ] ]
].
# - ontology header ------------------------------------------------------------
a owl:Ontology;
owl:imports fhir:fhir.ttl.
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