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

• Official URL:http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patients-and-cancer-conditions
• 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 _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.

Support the Following Implementation Guides:

• HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1

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

Patient

Conformance Expectation: SHALL

Supported Profiles:

• SHALL support: Cancer Patient

Profile Interaction Summary:

• SHALL support read.

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a Patient resource using: GET [base]/Patient/[id]

Condition

Conformance Expectation: SHALL

Supported Profiles:

• Cancer Patient

Profile Interaction Summary:

• SHALL support search-type^†.

search-type^†

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

Fetch and Search Criteria:

• A Client SHALL be capable of fetching resources matching a search query using: GET [base]/Condition/[id]{?[parameters]{&_format=[mime-type]}}
• A Client (conformance expectation undefined) be capable of supporting the following _includes:
  • Condition:subject - GET [base]/Condition?[parameter=value]&_include=Condition:subject

Search Parameter Summary:

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: