CodeX Radiation Therapy
1.0.0 - STU 1
CodeX Radiation Therapy
1.0.0 - STU 1
This page is part of the CodeX™ Radiation Therapy (v1.0.0: STU 1) 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 
| Draft as of 2020-11-23 |
{
"resourceType" : "CapabilityStatement",
"id" : "CodexRTServerCapabilityStatement",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">None</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/codex-radiation-therapy/CapabilityStatement/CodexRTServerCapabilityStatement</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-11-23</li><li><b>Published by:</b> None</li><li><b>Status:</b> Draft</li></ul><p>CodeX RT Server CapabilityStatement</p> <!-- REST Behavior --><h3 id=\"behavior\">FHIR Server RESTful Capabilities</h3><p>A CodeX RT Server <strong>SHALL</strong>:</p><ol><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 and xml source formats for all CodeX RT interactions.</li><li>Identify the CodeX RT 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 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, search-type</td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient\">Cancer Patient Profile</a></td> <!-- Supported Searches --><td>identifier, family, given, birthdate, gender, family+given+birthdate+gender</td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#procedure\">Procedure</a></td><td>read, search-type</td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-summary\">Radiotherapy Course Summary</a>, <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-phase\">Radiotherapy Treated Phase</a>, <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-plan\">Radiotherapy Treated Plan</a></td> <!-- Supported Searches --><td>identifier, subject, category, code, identifier+code, subject+code, identifier+category, identifier+category+code, subject+category+code, subject+category</td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#servicerequest\">ServiceRequest</a></td><td>read, search-type</td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-prescription\">Radiotherapy Course Prescription</a>, <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-phase-prescription\">Radiotherapy Phase Prescription</a>, <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-plan-prescription\">Radiotherapy Plan Prescription</a>, <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-course\">Radiotherapy Planned Course</a>, <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-phase\">Radiotherapy Planned Phase</a>, <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-plan\">Radiotherapy Treatment Plan</a></td> <!-- Supported Searches --><td>identifier, subject, category, code, identifier+code, subject+code, identifier+category, identifier+category+code, subject+category+code, subject+category</td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#device\">Device</a></td><td>read</td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-seed-device\">Radiotherapy Seed Device</a>, <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-device\">Radiotherapy Treatment Device</a></td> <!-- Supported Searches --><td></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#bodystructure\">BodyStructure</a></td><td>read, search-type</td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume\">Radiotherapy Volume</a></td> <!-- Supported Searches --><td>identifier, patient</td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#location\">Location</a></td><td>read</td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-location\">US Core Location Profile</a></td> <!-- Supported Searches --><td></td> <!-- Supported _includes --><td></td> <!-- Supported _revincludes --><td></td> <!-- Supported Operations --><td></td></tr><tr><td><a href=\"#observation\">Observation</a></td><td>read</td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-disease-status\">Radiotherapy Disease Status</a></td> <!-- Supported Searches --><td></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:\t<strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><strong>SHOULD</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>, <code>search-type</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><li>A Server <strong>SHALL</strong> be capable of returning 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/patient.html#search\">identifier</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?identifier=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">family</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?family=[family]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">given</a></td><td>string</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?given=[given]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">birthdate</a></td><td>date</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?birthdate=[birthdate]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">gender</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?gender=[system]|[code]</code></td></tr></tbody></table><p>Search Parameter Combination Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter Combination</th><th>Types</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family\">family</a>+ <a href=\"http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given\">given</a>+ <a href=\"http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate\">birthdate</a>+ <a href=\"http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender\">gender</a></td><td>string+string+date+token</td><td><code class=\"highlighter-rouge\">GET [base]/Patient? family=[family]& given=[given]& birthdate=[birthdate]& gender=[system]|[code]</code></td></tr></tbody></table><h4 id=\"procedure\" class=\"no_toc\">Procedure</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-summary\">Radiotherapy Course Summary</a>,</li><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-phase\">Radiotherapy Treated Phase</a>,</li><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-plan\">Radiotherapy Treated Plan</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning a Procedure resource using: <code class=\"highlighter-rouge\">GET [base]/Procedure/[id]</code></li><li>A Server <strong>SHALL</strong> be capable of returning resources matching a search query using: <code class=\"highlighter-rouge\">GET [base]/Procedure/[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/procedure.html#search\">identifier</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?identifier=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">subject</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?subject=[type]/[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">category</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?category=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">code</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure?code=[system]|[code]</code></td></tr></tbody></table><p>Search Parameter Combination Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter Combination</th><th>Types</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-identifier\">identifier</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td>token+token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure? identifier=[system]|[code]& code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Procedure-subject\">subject</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td>reference+token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure? subject=[type]/[id]& code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-identifier\">identifier</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/Procedure-category\">category</a></td><td>token+token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure? identifier=[system]|[code]& category=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-identifier\">identifier</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/Procedure-category\">category</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td>token+token+token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure? identifier=[system]|[code]& category=[system]|[code]& code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Procedure-subject\">subject</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/Procedure-category\">category</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td>reference+token+token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure? subject=[type]/[id]& category=[system]|[code]& code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Procedure-subject\">subject</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/Procedure-category\">category</a></td><td>reference+token</td><td><code class=\"highlighter-rouge\">GET [base]/Procedure? subject=[type]/[id]& category=[system]|[code]</code></td></tr></tbody></table><h4 id=\"servicerequest\" class=\"no_toc\">ServiceRequest</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-prescription\">Radiotherapy Course Prescription</a>,</li><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-phase-prescription\">Radiotherapy Phase Prescription</a>,</li><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-plan-prescription\">Radiotherapy Plan Prescription</a>,</li><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-course\">Radiotherapy Planned Course</a>,</li><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-phase\">Radiotherapy Planned Phase</a>,</li><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-plan\">Radiotherapy Treatment Plan</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning a ServiceRequest resource using: <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]</code></li><li>A Server <strong>SHALL</strong> be capable of returning resources matching a search query using: <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[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/servicerequest.html#search\">identifier</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?identifier=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">subject</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?subject=[type]/[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">category</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?category=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">code</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest?code=[system]|[code]</code></td></tr></tbody></table><p>Search Parameter Combination Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter Combination</th><th>Types</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-identifier\">identifier</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td>token+token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest? identifier=[system]|[code]& code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Procedure-subject\">subject</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td>reference+token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest? subject=[type]/[id]& code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-identifier\">identifier</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/Procedure-category\">category</a></td><td>token+token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest? identifier=[system]|[code]& category=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-identifier\">identifier</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/Procedure-category\">category</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td>token+token+token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest? identifier=[system]|[code]& category=[system]|[code]& code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Procedure-subject\">subject</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/Procedure-category\">category</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td>reference+token+token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest? subject=[type]/[id]& category=[system]|[code]& code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Procedure-subject\">subject</a>+ <a href=\"http://hl7.org/fhir/SearchParameter/Procedure-category\">category</a></td><td>reference+token</td><td><code class=\"highlighter-rouge\">GET [base]/ServiceRequest? subject=[type]/[id]& category=[system]|[code]</code></td></tr></tbody></table><h4 id=\"device\" class=\"no_toc\">Device</h4><p>Conformance Expectation:\t<strong>SHOULD</strong></p><p>Supported Profiles:</p><ul><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-seed-device\">Radiotherapy Seed Device</a>,</li><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-device\">Radiotherapy Treatment Device</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 Device resource using: <code class=\"highlighter-rouge\">GET [base]/Device/[id]</code></li></ul><h4 id=\"bodystructure\" class=\"no_toc\">BodyStructure</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume\">Radiotherapy Volume</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning a BodyStructure resource using: <code class=\"highlighter-rouge\">GET [base]/BodyStructure/[id]</code></li><li>A Server <strong>SHALL</strong> be capable of returning resources matching a search query using: <code class=\"highlighter-rouge\">GET [base]/BodyStructure/[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/bodystructure.html#search\">identifier</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/BodyStructure?identifier=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/bodystructure.html#search\">patient</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/BodyStructure?patient=[type]/[id]</code></td></tr></tbody></table><h4 id=\"location\" class=\"no_toc\">Location</h4><p>Conformance Expectation:\t<strong>SHOULD</strong></p><p>Supported Profiles:</p><ul><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-location\">US Core Location 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 Location resource using: <code class=\"highlighter-rouge\">GET [base]/Location/[id]</code></li></ul><h4 id=\"observation\" class=\"no_toc\">Observation</h4><p>Conformance Expectation:\t<strong>SHOULD</strong></p><p>Supported Profiles:</p><ul><li><strong>SHOULD</strong> support: <a href=\"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-disease-status\">Radiotherapy Disease Status</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 an Observation resource using: <code class=\"highlighter-rouge\">GET [base]/Observation/[id]</code></li></ul></div>"
},
"url" : "http://hl7.org/fhir/us/codex-radiation-therapy/CapabilityStatement/CodexRTServerCapabilityStatement",
"version" : "1.0.0",
"name" : "CodeXRTServerCapabilityStatement",
"title" : "CodeX RT Server CapabilityStatement",
"status" : "draft",
"date" : "2020-11-23",
"publisher" : "HL7 Cross Group Projects Work Group",
"contact" : [
{
"name" : "HL7 Cross Group Projects Work Group",
"telecom" : [
{
"system" : "url",
"value" : "https://www.hl7.org/Special/committees/cgp"
},
{
"system" : "email",
"value" : "cgplist@lists.HL7.org"
}
]
}
],
"description" : "CodeX RT Server CapabilityStatement",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "server",
"documentation" : "A CodeX RT Server **SHALL**:\n\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 and xml source formats for all CodeX RT interactions.\n1. Identify the CodeX RT 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",
"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"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "family"
},
{
"url" : "required",
"valueString" : "given"
},
{
"url" : "required",
"valueString" : "birthdate"
},
{
"url" : "required",
"valueString" : "gender"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Patient",
"supportedProfile" : [
"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "family",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "given",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "birthdate",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate",
"type" : "date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "gender",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender",
"type" : "token"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "identifier"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "subject"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "identifier"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "identifier"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "subject"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "subject"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Procedure",
"supportedProfile" : [
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-summary",
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-phase",
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-plan"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-subject",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-category",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "identifier"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "subject"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "identifier"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "identifier"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "subject"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "subject"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "ServiceRequest",
"supportedProfile" : [
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-prescription",
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-phase-prescription",
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-plan-prescription",
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-course",
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-phase",
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-plan"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-subject",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-category",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Device",
"supportedProfile" : [
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-seed-device",
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-device"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "BodyStructure",
"supportedProfile" : [
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/BodyStructure-identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/BodyStructure-patient",
"type" : "reference"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Location",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Observation",
"supportedProfile" : [
"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-disease-status"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
}
]
}
]
}
]
}
IG © 2021+ HL7 Cross Group Projects Work Group. Package hl7.fhir.us.codex-radiation-therapy#1.0.0 based on FHIR 4.0.1. Generated 2023-07-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change