CodeX Radiation Therapy
1.0.0 - STU 1 United States of America flag

This page is part of the CodeX™ Radiation Therapy (v1.0.0: STU 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: 1.0.0
Draft as of 2020-11-23 Computable Name: CodeXRTServerCapabilityStatement

CodeX RT Server CapabilityStatement

Raw OpenAPI-Swagger Definition file | Download

None

  • Official URL:http://hl7.org/fhir/us/codex-radiation-therapy/CapabilityStatement/CodexRTServerCapabilityStatement
  • Implementation Guide Version: None
  • FHIR Version: 4.0.1
  • Intended Use: Requirements
  • Supported Formats: XML, JSON
  • Published: 2020-11-23
  • Published by: None
  • Status: Draft

CodeX RT Server CapabilityStatement

FHIR Server RESTful Capabilities

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.

RESTful Capabilities by Resource/Profile:

Summary

Resource TypeSupported InteractionsSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
Patientread, search-type Cancer Patient Profile identifier, family, given, birthdate, gender, family+given+birthdate+gender
Procedureread, search-type Radiotherapy Course Summary, Radiotherapy Treated Phase, Radiotherapy Treated Plan identifier, subject, category, code, identifier+code, subject+code, identifier+category, identifier+category+code, subject+category+code, subject+category
ServiceRequestread, search-type Radiotherapy Course Prescription, Radiotherapy Phase Prescription, Radiotherapy Plan Prescription, Radiotherapy Planned Course, Radiotherapy Planned Phase, Radiotherapy Treatment Plan identifier, subject, category, code, identifier+code, subject+code, identifier+category, identifier+category+code, subject+category+code, subject+category
Deviceread Radiotherapy Seed Device, Radiotherapy Treatment Device
BodyStructureread, search-type Radiotherapy Volume identifier, patient
Locationread US Core Location Profile
Observationread Radiotherapy Disease Status

Patient

Conformance Expectation: SHALL

Supported Profiles:

Profile Interaction Summary:

  • SHALL support read, search-type.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Patient resource using: GET [base]/Patient/[id]
  • A Server SHALL be capable of returning resources matching a search query using: GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLidentifiertokenGET [base]/Patient?identifier=[system]|[code]
SHOULDfamilystringGET [base]/Patient?family=[family]
SHOULDgivenstringGET [base]/Patient?given=[given]
SHOULDbirthdatedateGET [base]/Patient?birthdate=[birthdate]
SHOULDgendertokenGET [base]/Patient?gender=[system]|[code]

Search Parameter Combination Summary:

ConformanceParameter CombinationTypesExample
SHALLfamily+ given+ birthdate+ genderstring+string+date+tokenGET [base]/Patient? family=[family]& given=[given]& birthdate=[birthdate]& gender=[system]|[code]

Procedure

Conformance Expectation: SHALL

Supported Profiles:

Profile Interaction Summary:

  • SHALL support read, search-type.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Procedure resource using: GET [base]/Procedure/[id]
  • A Server SHALL be capable of returning resources matching a search query using: GET [base]/Procedure/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLidentifiertokenGET [base]/Procedure?identifier=[system]|[code]
SHOULDsubjectreferenceGET [base]/Procedure?subject=[type]/[id]
SHOULDcategorytokenGET [base]/Procedure?category=[system]|[code]
SHOULDcodetokenGET [base]/Procedure?code=[system]|[code]

Search Parameter Combination Summary:

ConformanceParameter CombinationTypesExample
SHALLidentifier+ codetoken+tokenGET [base]/Procedure? identifier=[system]|[code]& code=[system]|[code]
SHALLsubject+ codereference+tokenGET [base]/Procedure? subject=[type]/[id]& code=[system]|[code]
SHALLidentifier+ categorytoken+tokenGET [base]/Procedure? identifier=[system]|[code]& category=[system]|[code]
SHALLidentifier+ category+ codetoken+token+tokenGET [base]/Procedure? identifier=[system]|[code]& category=[system]|[code]& code=[system]|[code]
SHALLsubject+ category+ codereference+token+tokenGET [base]/Procedure? subject=[type]/[id]& category=[system]|[code]& code=[system]|[code]
SHALLsubject+ categoryreference+tokenGET [base]/Procedure? subject=[type]/[id]& category=[system]|[code]

ServiceRequest

Conformance Expectation: SHALL

Supported Profiles:

Profile Interaction Summary:

  • SHALL support read, search-type.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a ServiceRequest resource using: GET [base]/ServiceRequest/[id]
  • A Server SHALL be capable of returning resources matching a search query using: GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLidentifiertokenGET [base]/ServiceRequest?identifier=[system]|[code]
SHOULDsubjectreferenceGET [base]/ServiceRequest?subject=[type]/[id]
SHOULDcategorytokenGET [base]/ServiceRequest?category=[system]|[code]
SHOULDcodetokenGET [base]/ServiceRequest?code=[system]|[code]

Search Parameter Combination Summary:

ConformanceParameter CombinationTypesExample
SHALLidentifier+ codetoken+tokenGET [base]/ServiceRequest? identifier=[system]|[code]& code=[system]|[code]
SHALLsubject+ codereference+tokenGET [base]/ServiceRequest? subject=[type]/[id]& code=[system]|[code]
SHALLidentifier+ categorytoken+tokenGET [base]/ServiceRequest? identifier=[system]|[code]& category=[system]|[code]
SHALLidentifier+ category+ codetoken+token+tokenGET [base]/ServiceRequest? identifier=[system]|[code]& category=[system]|[code]& code=[system]|[code]
SHALLsubject+ category+ codereference+token+tokenGET [base]/ServiceRequest? subject=[type]/[id]& category=[system]|[code]& code=[system]|[code]
SHALLsubject+ categoryreference+tokenGET [base]/ServiceRequest? subject=[type]/[id]& category=[system]|[code]

Device

Conformance Expectation: SHOULD

Supported Profiles:

Profile Interaction Summary:

  • SHALL support read.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Device resource using: GET [base]/Device/[id]

BodyStructure

Conformance Expectation: SHALL

Supported Profiles:

Profile Interaction Summary:

  • SHALL support read, search-type.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a BodyStructure resource using: GET [base]/BodyStructure/[id]
  • A Server SHALL be capable of returning resources matching a search query using: GET [base]/BodyStructure/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLidentifiertokenGET [base]/BodyStructure?identifier=[system]|[code]
SHALLpatientreferenceGET [base]/BodyStructure?patient=[type]/[id]

Location

Conformance Expectation: SHOULD

Supported Profiles:

Profile Interaction Summary:

  • SHALL support read.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Location resource using: GET [base]/Location/[id]

Observation

Conformance Expectation: SHOULD

Supported Profiles:

Profile Interaction Summary:

  • SHALL support read.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning an Observation resource using: GET [base]/Observation/[id]