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
This section outlines requirements and recommendations for CodeX RT participants. The conformance verbs - SHALL, SHOULD, and MAY - are defined in FHIR Conformance Rules. The conformance verb MUST is a synonym for SHALL.
Three roles for CodeX RT Participants are defined along the actors defined in IHE-RO XRTS:
Treatment Summary Provider - A system that provides the summary of ongoing or completed radiotherapy treatments by storing CodeX RT compliant resources to an RO Resource Repository.
Treatment Observer - A system that retrieves the latest radiotherapy treatment summary information as CodeX RT compliant resources from an RO Resource Repository.
Radiation Oncology (RO) Resource Repository - The RO Resource Repository is a system and can receive CodeX RT compliant resources and make them available as defined in the CodeX RT Server CapabilityStatement. A FHIR Server that fulfills this role may not be limited to Radiation Oncology. It may be a generic FHIR server that fulfills other roles at the same time.
This STU1 IG currently only provides a CapabilityStatement for a RO Resource Repository. As additional experience interacting with CodeX RT data accrues the required capabilities for Treatment Summary Provider and Treatment Observer will be captured in future updates to this IG. See the IHE-RO XRTS Supplement for a specification which transactions are required by the Treatment Summary Provider and the Treatment Observer.
CodeX RT participants MUST meet the following requirements for conformance:
The information produced and consumed by CodeX RT participants is defined by a set of profiles. All CodeX RT participants must conform to the expectations set by these profiles.
Treatment Summary Providers and RO Resource Repositories MUST be able to populate data elements with Must-Support (MS) obligations (marked with the S flag), for all profiles they support (as declared in their CapabilityStatement). Treatment Observers MUST be able to meaningfully process elements with MS obligations for each profile they support (as declared in their CapabilityStatement). “Able to Populate” and Meaningfully Process” are defined according to mCODE’s definition.
The query support required of conforming implementations is specified in the CapabilityStatement.
Additional conformance requirements from US Core apply to RESTful interactions, searches, and resource formats in CodeX RT. CodeX RT derives from mCODE, which “inherits” all US Core conformance requirements. US Core provides base profiles for many (but not all) CodeX RT profiles, outlines expectations for handling of missing or unknown data elements, and outlines how to associate provenance information associated with collection, transfer, and updating of clinical information.
This FHIR implementation guide will use the US Core profiles. If this FHIR implementation guide is unable to use a US Core profile, we will follow the Cross Group Projects WG’s variance request process, and provide the US Realm Steering Committee an approved rationale for deviation in the implementation guide where applicable.
International users of CodeX RT may find US Core an impediment to implementation. Application of CodeX RT to other countries is open to further discussion.
meta.profile
to Signal ConformanceParticipants SHOULD populate meta.profile
elements for all resources to indicate which profiles the resources claim to conform to. Servers SHOULD also implement profile search, which allows participants to query using the _profile
parameter to return resources conforming to the profiles declared in meta.profile
.
CodeX RT implementers should conform to the mCODE element-level conformance requirements.