minimal Common Oncology Data Elements (mCODE) Implementation Guide
4.0.0-ballot - STU4 Ballot United States of America flag

This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v4.0.0-ballot: STU4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

CapabilityStatement: mCODE Data Receiver CapabilityStatement: Get in-scope patients (and associated Conditions) using _include (Experimental)

Official URL: http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patients-and-cancer-conditions Version: 4.0.0-ballot
Draft as of 2020-10-30 Computable Name: CapabilityStatementReceiverPatientsAndCancerConditions
Other Identifiers: OID:2.16.840.1.113883.4.642.40.15.13.3

Uses _include to retrieve a Bundle of Condition resources with a code in mCODE’s cancer condition value set, along with the associated Patient resources. Use ONLY when reverse chaining is not available on the system.

Raw OpenAPI-Swagger Definition file | Download

mCODE Data Receiver CapabilityStatement: Get in-scope patients (and associated Conditions) using _include

  • Implementation Guide Version: 4.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2020-10-30 07:15:00-0400
  • Published by: HL7 International / Clinical Interoperability Council

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.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: client

An mCODE Client SHALL:

  1. Support all profiles defined in this Implementation Guide..
  2. Implement the RESTful behavior according to the FHIR specification.
  3. 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.
  4. Support json source formats for all mCODE interactions.
  5. Identify the mCODE profiles supported as part of the FHIR meta.profile attribute for each instance.
  6. Support the searchParameters on each profile individually and in combination.

The mCODE Client SHOULD:

  1. Support xml source formats for all mCODE interactions.
Security
  1. See the General Security Considerations section for requirements and recommendations.
  2. A client 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		y
ConditionSupported profiles:
  Cancer Patient Profile		ycode:inCondition:subject
Group ycode

Resource Conformance: SHALLPatient

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

Supported Profiles

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

Resource Conformance: SHALLCondition

Core FHIR Resource
Condition
Reference Policy
Interaction summary
  • SHALL support search-type.

Supported Profiles

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcode:intoken
 

Resource Conformance: SHALLGroup

Core FHIR Resource
Group
Reference Policy
Interaction summary
  • SHALL support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcodetoken