CodeX Radiation Therapy
2.0.0-ballot - Ballot United States of America flag

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 2.0.0. For a full list of available versions, see the Directory of published versions

CapabilityStatement: CodeX RT Server CapabilityStatement

Official URL: http://hl7.org/fhir/us/codex-radiation-therapy/CapabilityStatement/CodexRTServerCapabilityStatement Version: 2.0.0-ballot
Draft as of 2020-11-23 Computable Name: CodeXRTServerCapabilityStatement
Other Identifiers: OID:2.16.840.1.113883.4.642.40.14.13.1

CodeX RT Server CapabilityStatement

Raw OpenAPI-Swagger Definition file | Download

CodeX RT Server CapabilityStatement

  • Implementation Guide Version: 2.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2020-11-23
  • Published by: HL7 International / Cross-Group Projects

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.

FHIR RESTful Capabilities

Mode: server

A CodeX RT Server SHALL:

  1. Implement the RESTful behavior according to the FHIR specification.
  2. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
    • (Status 410): deleted resource.
  3. Support json and xml source formats for all CodeX RT interactions.
  4. Identify the CodeX RT profiles supported as part of the FHIR meta.profile attribute for each instance.
  5. Support the searchParameters on each profile individually and in combination.
Security
  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.
Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
PatientSupported profiles:
  Cancer Patient Profile		yyidentifier, family, given, birthdate, gender
ProcedureSupported profiles:
  Radiotherapy Course Summary
  Radiotherapy Treated Phase
  Radiotherapy Treated Plan		yyidentifier, subject, category, code
ServiceRequestSupported profiles:
  Radiotherapy Course Prescription
  Radiotherapy Phase Prescription
  Radiotherapy Plan Prescription
  Radiotherapy Planned Course
  Radiotherapy Planned Phase
  Radiotherapy Treatment Plan		yyidentifier, subject, category, code
DeviceSupported profiles:
  Radiotherapy Seed Device
  Radiotherapy Treatment Device		y
BodyStructureSupported profiles:
  Radiotherapy Volume		yyidentifier, patient
LocationSupported profiles:
  US Core Location Profile		y
ObservationSupported profiles:
  Radiotherapy Disease Status		y

Resource Conformance: SHALLPatient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDfamilystring
SHOULDgivenstring
SHOULDbirthdatedate
SHOULDgendertoken
 

Resource Conformance: SHALLProcedure

Core FHIR Resource
Procedure
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDsubjectreference
SHOULDcategorytoken
SHOULDcodetoken
 

Resource Conformance: SHALLServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDsubjectreference
SHOULDcategorytoken
SHOULDcodetoken
 

Resource Conformance: SHOULDDevice

Core FHIR Resource
Device
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

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

Resource Conformance: SHALLBodyStructure

Core FHIR Resource
BodyStructure
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLpatientreference
 

Resource Conformance: SHOULDLocation

Core FHIR Resource
Location
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

http://hl7.org/fhir/us/core/StructureDefinition/us-core-location

Resource Conformance: SHOULDObservation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-disease-status