minimal Common Oncology Data Elements (mCODE) Implementation Guide
3.0.0-ballot - 2023May 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 (v3.0.0-ballot: STU 3 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

CapabilityStatement: mcode-receiver-patient-bundle (Experimental)

Official URL: http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patient-bundle Version: 3.0.0-ballot
Draft as of 2020-10-30 Computable Name: CapabilityStatementPatientBundle

Gets an mCODE Patient Bundle for a specific patient that contains all of that patient’s resources that conform to mCODE Profiles.

Raw OpenAPI-Swagger Definition file | Download

mCODE Data Receiver: Get Bundle for a Patient

  • Official URL:http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patient-bundle
  • 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)

Gets an mCODE Patient Bundle for a specific patient that contains all of that patient's resources that conform to mCODE Profiles.

Support the Following Implementation Guides:

Include And Support Everything In The Following CapabilityStatements:

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.

Summary of Client Wide Operations