mCODE Lite (mCODE-LITE)
0.1.0 - draft
mCODE Lite (mCODE-LITE), published by MITRE. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CodeX-HL7-FHIR-Accelerator/mcode-lite/ and changes regularly. See the Directory of published versions
Draft as of 2024-01-25 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="eom-mcode-server"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">mCODE EOM Server: Get an EOM Bundle for a Patient</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-patient-bundle</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 EOM Server <strong>SHOULD</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 EOM 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>SHOULD</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li></ol><p><strong>Summary of Server Wide Operations</strong></p><ul><li><strong>SHOULD</strong> support the <a href="http://hl7.org/fhir/us/mcode/OperationDefinition/mcode-patient-everything"><code>$mcode-patient-bundle</code></a> operation.</li></ul></div>
</text>
<url
value="http://mitre.org/mcodelite/CapabilityStatement/eom-mcode-server"/>
<version value="0.1.0"/>
<name value="CapabilityStatementEomPatientBundle"/>
<title value="mCODE EOM Server: Get Bundle for an EOM Patient"/>
<status value="draft"/>
<experimental value="true"/>
<date value="2024-01-25T14:55:00.000000-04:00"/>
<publisher value="MITRE"/>
<contact>
<name value="MITRE"/>
<telecom>
<system value="url"/>
<value value="http://www.mitre.org"/>
</telecom>
</contact>
<contact>
<name value="May Terry"/>
<telecom>
<system value="email"/>
<value value="mayT@mitre.org"/>
<use value="work"/>
</telecom>
</contact>
<description
value="EOM example for creating an mCODE-derived capability statement."/>
<kind value="requirements"/>
<imports
value="http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server"/>
<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="server"/>
<documentation
value="An mCODE Enhancing Oncology Model (EOM) Server **SHOULD**:
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 EOM Server **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 server **SHOULD** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."/>
</security>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="eom-mcode-patient-bundle"/>
<definition
value="http://hl7.org/fhir/us/mcode/OperationDefinition/mcode-patient-everything"/>
</operation>
</rest>
</CapabilityStatement>