This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v3.0.0: STU 3) 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
Official URL: http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-cancer-conditions-then-patients | Version: 3.0.0 | |||
Draft as of 2020-10-30 | Computable Name: CapabilityStatementSenderConditionsThenPatients |
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.
Raw OpenAPI-Swagger Definition file | Download
http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-cancer-conditions-then-patients
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.
An mCODE Server SHALL:
meta.profile
attribute for each instance.The mCODE Server SHOULD:
Security:
HTTP 401
unauthorized response code.Summary
♦ = SHALL expectation;⋄ = SHOULD expectation;▿ = MAY expectation;
Resource Type | Supported Interactions | Supported Profiles | Supported Searches | Supported _includes | Supported _revincludes | Supported Operations |
---|---|---|---|---|---|---|
Patient♦ | read♦ | Cancer Patient Profile♦ | _id♦ | |||
Condition♦ | search-type♦ | Cancer Patient Profile | code:in♦ | |||
Group♦ | search-type♦ | code♦ |
Conformance Expectation:SHALL
Supported Profiles:
Profile Interaction Summary:
read
.Fetch and Search Criteria:
GET [base]/Patient/[id]
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | _id | token | GET [base]/Patient?_id=[id] |
Conformance Expectation:SHALL
Supported Profiles:
Profile Interaction Summary:
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:
GET [base]/Condition/[id]{?[parameters]{&_format=[mime-type]}}
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | code:in | uri | GET [base]/Condition?code:in=[uri] |
Conformance Expectation:SHALL
Profile Interaction Summary:
search-type
†.search-type†
Retrieve Group of references to Patient resources conforming to mCODE.
Fetch and Search Criteria:
GET [base]/Group/[id]{?[parameters]{&_format=[mime-type]}}
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | code | token | GET [base]/Group?code=[system]|[code] |