CodeX Radiation Therapy
2.0.0-ballot - Ballot
CodeX Radiation Therapy
2.0.0-ballot - Ballot
This page is part of the CodeX™ Radiation Therapy (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
| Draft as of 2020-11-23 |
@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:id [ fhir:v "CodexRTServerCapabilityStatement"] ; # fhir:text [ fhir:status [ fhir:v "extensions" ] ; fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">CodeX RT Server CapabilityStatement</h2><ul><li>Implementation Guide Version: 2.0.0-ballot</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2020-11-23</li><li>Published by: HL7 International / Cross-Group Projects</li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>A CodeX RT Server <strong>SHALL</strong>:</p>\n<ol>\n<li>Implement the RESTful behavior according to the FHIR specification.</li>\n<li>Return the following response classes:\n<ul>\n<li>(Status 400): invalid parameter</li>\n<li>(Status 401/4xx): unauthorized request</li>\n<li>(Status 403): insufficient scope</li>\n<li>(Status 404): unknown resource</li>\n<li>(Status 410): deleted resource.</li>\n</ul>\n</li>\n<li>Support json and xml source formats for all CodeX RT interactions.</li>\n<li>Identify the CodeX RT profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li>\n<li>Support the searchParameters on each profile individually and in combination.</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><ol>\n<li>See the <a href=\"https://www.hl7.org/fhir/security.html#general\">General Security Considerations</a> section for requirements and recommendations.</li>\n<li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li>\n</ol>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Patient1-1\">Patient</a></td><td>Supported profiles:<br/> <a href=\"http://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-cancer-patient.html\">Cancer Patient Profile</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>identifier, family, given, birthdate, gender</td><td/><td/><td/></tr><tr><td><a href=\"#Procedure1-2\">Procedure</a></td><td>Supported profiles:<br/> <a href=\"StructureDefinition-codexrt-radiotherapy-course-summary.html\">Radiotherapy Course Summary</a><br/> <a href=\"StructureDefinition-codexrt-radiotherapy-treated-phase.html\">Radiotherapy Treated Phase</a><br/> <a href=\"StructureDefinition-codexrt-radiotherapy-treated-plan.html\">Radiotherapy Treated Plan</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>identifier, subject, category, code</td><td/><td/><td/></tr><tr><td><a href=\"#ServiceRequest1-3\">ServiceRequest</a></td><td>Supported profiles:<br/> <a href=\"StructureDefinition-codexrt-radiotherapy-course-prescription.html\">Radiotherapy Course Prescription</a><br/> <a href=\"StructureDefinition-codexrt-radiotherapy-phase-prescription.html\">Radiotherapy Phase Prescription</a><br/> <a href=\"StructureDefinition-codexrt-radiotherapy-plan-prescription.html\">Radiotherapy Plan Prescription</a><br/> <a href=\"StructureDefinition-codexrt-radiotherapy-planned-course.html\">Radiotherapy Planned Course</a><br/> <a href=\"StructureDefinition-codexrt-radiotherapy-planned-phase.html\">Radiotherapy Planned Phase</a><br/> <a href=\"StructureDefinition-codexrt-radiotherapy-treatment-plan.html\">Radiotherapy Treatment Plan</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>identifier, subject, category, code</td><td/><td/><td/></tr><tr><td><a href=\"#Device1-4\">Device</a></td><td>Supported profiles:<br/> <a href=\"StructureDefinition-codexrt-radiotherapy-seed-device.html\">Radiotherapy Seed Device</a><br/> <a href=\"StructureDefinition-codexrt-radiotherapy-treatment-device.html\">Radiotherapy Treatment Device</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#BodyStructure1-5\">BodyStructure</a></td><td>Supported profiles:<br/> <a href=\"StructureDefinition-codexrt-radiotherapy-volume.html\">Radiotherapy Volume</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>identifier, patient</td><td/><td/><td/></tr><tr><td><a href=\"#Location1-6\">Location</a></td><td>Supported profiles:<br/> <a href=\"http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-location.html\">US Core Location Profile</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Observation1-7\">Observation</a></td><td>Supported profiles:<br/> <a href=\"StructureDefinition-codexrt-radiotherapy-disease-status.html\">Radiotherapy Disease Status</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL</span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/mcode/STU3/StructureDefinition-mcode-cancer-patient.html\">http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/us/core/STU5.0.1/SearchParameter-us-core-patient-identifier.html\">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/us/core/STU5.0.1/SearchParameter-us-core-patient-family.html\">family</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/us/core/STU5.0.1/SearchParameter-us-core-patient-given.html\">given</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/us/core/STU5.0.1/SearchParameter-us-core-patient-birthdate.html\">birthdate</a></td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/us/core/STU5.0.1/SearchParameter-us-core-patient-gender.html\">gender</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\"> </div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Procedure1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL</span>Procedure</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/procedure.html\">Procedure</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-codexrt-radiotherapy-course-summary.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-summary</a><br/><a href=\"StructureDefinition-codexrt-radiotherapy-treated-phase.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-phase</a><br/><a href=\"StructureDefinition-codexrt-radiotherapy-treated-plan.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-plan</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">subject</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">category</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">code</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\"> </div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ServiceRequest1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL</span>ServiceRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/servicerequest.html\">ServiceRequest</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-codexrt-radiotherapy-course-prescription.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-prescription</a><br/><a href=\"StructureDefinition-codexrt-radiotherapy-phase-prescription.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-phase-prescription</a><br/><a href=\"StructureDefinition-codexrt-radiotherapy-plan-prescription.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-plan-prescription</a><br/><a href=\"StructureDefinition-codexrt-radiotherapy-planned-course.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-course</a><br/><a href=\"StructureDefinition-codexrt-radiotherapy-planned-phase.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-phase</a><br/><a href=\"StructureDefinition-codexrt-radiotherapy-treatment-plan.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-plan</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">subject</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">category</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">code</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\"> </div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Device1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Device</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/device.html\">Device</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-codexrt-radiotherapy-seed-device.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-seed-device</a><br/><a href=\"StructureDefinition-codexrt-radiotherapy-treatment-device.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-device</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"BodyStructure1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL</span>BodyStructure</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/bodystructure.html\">BodyStructure</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-codexrt-radiotherapy-volume.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/bodystructure.html#search\">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/bodystructure.html#search\">patient</a></td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\"> </div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Location1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Location</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/location.html\">Location</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-location.html\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-location</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Observation1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Observation</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-codexrt-radiotherapy-disease-status.html\">http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-disease-status</a></p></div></div><p/></div></div></div></div>" ] ; # fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ; fhir:value [ fhir:v "cgp" ] ] ) ; # fhir:url [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/CapabilityStatement/CodexRTServerCapabilityStatement"^^xsd:anyURI] ; # fhir:version [ fhir:v "2.0.0-ballot"] ; # fhir:name [ fhir:v "CodeXRTServerCapabilityStatement"] ; # fhir:title [ fhir:v "CodeX RT Server CapabilityStatement"] ; # fhir:status [ fhir:v "draft"] ; # fhir:date [ fhir:v "2020-11-23"^^xsd:date] ; # fhir:publisher [ fhir:v "HL7 International / Cross-Group Projects"] ; # fhir:contact ( [ fhir:name [ fhir:v "HL7 International / Cross-Group Projects" ] ; ( fhir:telecom [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://www.hl7.org/Special/committees/cgp" ] ] [ fhir:system [ fhir:v "email" ] ; fhir:value [ fhir:v "cgplist@lists.HL7.org" ] ] ) ] ) ; # fhir:description [ fhir:v "CodeX RT Server CapabilityStatement"] ; # fhir:jurisdiction ( [ ( fhir:coding [ fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ; fhir:code [ fhir:v "US" ] ; fhir:display [ fhir:v "United States of America" ] ] ) ] ) ; # fhir:kind [ fhir:v "requirements"] ; # fhir:fhirVersion [ fhir:v "4.0.1"] ; # fhir:format ( [ fhir:v "xml"] [ fhir:v "json"] ) ; # fhir:rest ( [ fhir:mode [ fhir:v "server" ] ; fhir:documentation [ fhir:v "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" ] ; fhir:security [ fhir:description [ fhir:v "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:resource [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:type [ fhir:v "Patient" ] ; ( fhir:supportedProfile [ fhir:v "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] ) ; ( fhir:interaction [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "read" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "search-type" ] ] ) ; ( fhir:searchParam [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:name [ fhir:v "identifier" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier> ] ; fhir:type [ fhir:v "token" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "family" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family> ] ; fhir:type [ fhir:v "string" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "given" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given> ] ; fhir:type [ fhir:v "string" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "birthdate" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate> ] ; fhir:type [ fhir:v "date" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "gender" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender> ] ; fhir:type [ fhir:v "token" ] ] ) ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:type [ fhir:v "Procedure" ] ; ( fhir:supportedProfile [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-summary"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-summary> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-phase"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-phase> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-plan"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-plan> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] ) ; ( fhir:interaction [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "read" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "search-type" ] ] ) ; ( fhir:searchParam [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:name [ fhir:v "identifier" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/clinical-identifier"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/clinical-identifier> ] ; fhir:type [ fhir:v "token" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "subject" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/Procedure-subject"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/Procedure-subject> ] ; fhir:type [ fhir:v "reference" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "category" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/Procedure-category"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/Procedure-category> ] ; fhir:type [ fhir:v "token" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "code" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/clinical-code"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/clinical-code> ] ; fhir:type [ fhir:v "token" ] ] ) ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:type [ fhir:v "ServiceRequest" ] ; ( fhir:supportedProfile [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-prescription"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-course-prescription> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-phase-prescription"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-phase-prescription> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-plan-prescription"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-plan-prescription> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-course"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-course> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-phase"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-planned-phase> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-plan"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-plan> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] ) ; ( fhir:interaction [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "read" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "search-type" ] ] ) ; ( fhir:searchParam [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:name [ fhir:v "identifier" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/clinical-identifier"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/clinical-identifier> ] ; fhir:type [ fhir:v "token" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "subject" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/Procedure-subject"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/Procedure-subject> ] ; fhir:type [ fhir:v "reference" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "category" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/Procedure-category"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/Procedure-category> ] ; fhir:type [ fhir:v "token" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:name [ fhir:v "code" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/clinical-code"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/clinical-code> ] ; fhir:type [ fhir:v "token" ] ] ) ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:type [ fhir:v "Device" ] ; ( fhir:supportedProfile [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-seed-device"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-seed-device> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-device"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-device> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] ) ; ( fhir:interaction [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "read" ] ] ) ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:type [ fhir:v "BodyStructure" ] ; ( fhir:supportedProfile [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] ) ; ( fhir:interaction [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "read" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "search-type" ] ] ) ; ( fhir:searchParam [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:name [ fhir:v "identifier" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/BodyStructure-identifier"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/BodyStructure-identifier> ] ; fhir:type [ fhir:v "token" ] ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:name [ fhir:v "patient" ] ; fhir:definition [ fhir:v "http://hl7.org/fhir/SearchParameter/BodyStructure-patient"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/SearchParameter/BodyStructure-patient> ] ; fhir:type [ fhir:v "reference" ] ] ) ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:type [ fhir:v "Location" ] ; ( fhir:supportedProfile [ fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-location> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] ) ; ( fhir:interaction [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "read" ] ] ) ] [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ; fhir:type [ fhir:v "Observation" ] ; ( fhir:supportedProfile [ fhir:v "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-disease-status"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-disease-status> ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHOULD" ] ] ) ] ) ; ( fhir:interaction [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ; fhir:value [ fhir:v "SHALL" ] ] ) ; fhir:code [ fhir:v "read" ] ] ) ] ) ] ) . #
IG © 2021+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.codex-radiation-therapy#2.0.0-ballot based on FHIR 4.0.1. Generated 2024-04-09
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change