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-patient-bundle
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)
Retrieves a Bundle of Condition resources with a code in mCODE's cancer condition value set, and allows for associated Patient resources to be retrieved in a subsequent request. Use ONLY when reverse chaining AND _include
are not available on the system.
Support the Following Implementation Guides:
FHIR Client RESTful Capabilities
An mCODE Client SHALL:
- Support all profiles defined in this Implementation Guide..
- Implement the RESTful behavior according to the FHIR specification.
- 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.
- Support json source formats for all mCODE interactions.
- Identify the mCODE profiles supported as part of the FHIR
meta.profile
attribute for each instance. - Support the searchParameters on each profile individually and in combination.
The mCODE Client SHOULD:
- Support xml source formats for all mCODE interactions.
Security:
- See the General Security Considerations section for requirements and recommendations.
- A client SHALL reject any unauthorized requests by returning an
HTTP 401
unauthorized response code.
Summary of Client Wide Operations