Package | hl7.fhir.us.codex-radiation-therapy |
Type | CapabilityStatement |
Id | CodexRTServerCapabilityStatement |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/codex-radiation-therapy/https://build.fhir.org/ig/HL7/codex-radiation-therapy/CapabilityStatement-CodexRTServerCapabilityStatement.html |
URL | http://hl7.org/fhir/us/codex-radiation-therapy/CapabilityStatement/CodexRTServerCapabilityStatement |
Version | 2.0.0 |
Status | draft |
Date | 2020-11-23 |
Name | CodeXRTServerCapabilityStatement |
Title | CodeX RT Server CapabilityStatement |
Realm | us |
Authority | hl7 |
Description | CodeX RT Server CapabilityStatement |
Kind | requirements |
No resources found
SearchParameter | |
us-core-patient-birthdate | USCorePatientBirthdate |
us-core-patient-family | USCorePatientFamily |
us-core-patient-given | USCorePatientGiven |
us-core-patient-identifier | USCorePatientIdentifier |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement CodexRTServerCapabilityStatement
xml
, json
Note to Implementers: FHIR Capabilities
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.
server
A CodeX RT Server SHALL:
meta.profile
attribute for each instance.
- See the General Security Considerations section for requirements and recommendations.
- A server SHALL reject any unauthorized requests by returning an
HTTP 401
unauthorized response code.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
Patient | Supported Profiles Cancer Patient Profile | y | y | identifier, family, given, birthdate, gender | |||||
Procedure | Supported Profiles Radiotherapy Course Summary Radiotherapy Treated Phase Radiotherapy Treated Plan Radiotherapy Treated Fraction | y | y | identifier, subject, category, code | |||||
ServiceRequest | Supported Profiles Radiotherapy Course Prescription Radiotherapy Phase Prescription Radiotherapy Plan Prescription Radiotherapy Planned Course Radiotherapy Planned Phase Radiotherapy Treatment Plan | y | y | identifier, subject, category, code | |||||
Encounter | Supported Profiles Radiotherapy Treatment Session | y | y | patient, based-on | |||||
Device | Supported Profiles Radiotherapy Seed Device Radiotherapy Treatment Device | y | |||||||
BodyStructure | Supported Profiles Radiotherapy Volume | y | y | identifier, patient | |||||
Location | Supported Profiles US Core Location Profile | y | |||||||
Observation | Supported Profiles Radiotherapy Disease Status | y |
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | family | string | |
SHOULD | given | string | |
SHOULD | birthdate | date | |
SHOULD | gender | token |
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | subject | reference | |
SHOULD | category | token | |
SHOULD | code | token |
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | subject | reference | |
SHOULD | category | token | |
SHOULD | code | token |
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHALL | patient | reference |
{ "resourceType": "CapabilityStatement", "id": "CodexRTServerCapabilityStatement", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "cgp" } ], "url": "http://hl7.org/fhir/us/codex-radiation-therapy/CapabilityStatement/CodexRTServerCapabilityStatement", "version": "2.0.0", "name": "CodeXRTServerCapabilityStatement", "title": "CodeX RT Server CapabilityStatement", "status": "draft", "date": "2020-11-23", "publisher": "HL7 International / Cross-Group Projects", "contact": [ { "name": "HL7 International / Cross-Group Projects", "telecom": [ { "system": "url", "value": "http://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" } ], "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" } ], "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", "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-fraction" ], "_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" } ] } ], "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" } ], "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": "Encounter", "supportedProfile": [ "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-session" ], "_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": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "reference" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "based-on", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-based-on", "type": "reference" } ] }, { "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" } ] } ] } ] }