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

minimal Common Oncology Data Elements (mCODE) Implementation Guide, published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-mCODE-ig/ and changes regularly. See the Directory of published versions

CapabilityStatement: mCODE Data Receiver: Get Patients in Group (Experimental)

Official URL: http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patients-in-group Version: 4.0.0-ballot
Draft as of 2020-10-30 Computable Name: CapabilityStatementReceiverPatientsInGroup
Other Identifiers: OID:2.16.840.1.113883.4.642.40.15.13.4

Capabilities for an mCODE Data Receiver where not all cancer patients conform to mCODE. Retrieves a Group of references to Patient resources that conform to mCODE, and allows for the full Patient resources to be retrieved in a subsequent request.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement mcode-receiver-patients-in-group

mCODE Data Receiver: Get Patients in Group

  • 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.

This CapabilityStatement imports the CapabilityStatement US Core Client CapabilityStatement

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_id
Group ycode

Resource Conformance: SHALL Patient

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

Supported Profiles

Cancer Patient Profile

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: SHALL Group

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

    Retrieve Group of references to Patient resources conforming to mCODE.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcodetoken