minimal Common Oncology Data Elements (mCODE) Implementation Guide
2.0.0 - STU 2

This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: mcode-receiver-patients-with-cancer-condition

Raw OpenAPI-Swagger Definition file | Download

mCODE Data Receiver CapabilityStatement: Get in-scope patients using reverse chaining

  • Official URL:http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patients-with-cancer-condition
  • Implementation Guide Version: None
  • FHIR Version: 4.0.1
  • Intended Use: Requirements
  • Supported Formats: XML, JSON
  • Published: 2020-10-30 07:15:00.000000-04:00
  • Published by: None
  • Status: Draft (experimental)

Uses reverse chaining to retrieve a Bundle of Patient resources with a condition code in mCODE's cancer condition value set.

Support the Following Implementation Guides:

FHIR Client RESTful Capabilities

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.

RESTful Capabilities by Resource/Profile:

Summary

Resource TypeSupported InteractionsSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
Patientread, search-type Cancer Patient _has:Condition:subject:code:in
Groupsearch-type code

Patient

Conformance Expectation: SHALL

Supported Profiles:

Profile Interaction Summary:

  • SHALL support read, search-type†.

search-type†

Identify Patient resources conforming to mCODE's CancerPatient profile via reverse chaining searching for conditions in a specific ValueSet.

Fetch and Search Criteria:

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

Search Parameter Summary:

ConformanceParameterTypeExample
SHALL_has:Condition:subject:code:inuriGET [base]/Patient?_has:Condition:subject:code:in=[uri]

Group

Conformance Expectation: SHALL

Profile Interaction Summary:

  • SHALL support search-type†.

search-type†

Retrieve Group of references to Patient resources conforming to mCODE.

Fetch and Search Criteria:

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

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLcodetokenGET [base]/Group?code=[system]|[code]