Package | hl7.fhir.us.mcode |
Type | CapabilityStatement |
Id | mcode-sender-cancer-conditions-then-patients |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/mcode/https://build.fhir.org/ig/HL7/fhir-mCODE-ig/CapabilityStatement-mcode-sender-cancer-conditions-then-patients.html |
URL | http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-cancer-conditions-then-patients |
Version | 4.0.0 |
Status | draft |
Date | 2020-10-30T07:15:00.000000-04:00 |
Name | CapabilityStatementSenderConditionsThenPatients |
Title | mCODE Data Sender: Get Conditions then Patients |
Realm | us |
Authority | hl7 |
Description | 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. |
Kind | requirements |
No resources found
CapabilityStatement | |
us-core-server | US Core Server CapabilityStatement |
ImplementationGuide | |
hl7.fhir.us.mcode | minimal Common Oncology Data Elements (mCODE) Implementation Guide |
SearchParameter | |
Condition-code | ConditionCodeSearchParameter |
us-core-patient-id | USCorePatientId |
StructureDefinition | |
mcode-cancer-patient | Cancer Patient Profile |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement mcode-sender-cancer-conditions-then-patients
xml
, json
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 Server CapabilityStatement
server
An mCODE Server SHALL:
meta.profile
attribute for each instance.The mCODE Server SHOULD:
- See the General Security Considerations section for requirements and recommendations.
- A server SHALL reject any unauthorized requests by returning an
HTTP 401
unauthorized response code.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
Patient | Supported Profiles Cancer Patient Profile | y | _id | ||||||
Condition | Supported Profiles Cancer Patient Profile | y | code:in | ||||||
Group | y | code |
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token |
search-type
Identify Patient resources conforming to mCODE's CancerPatient profile via searching for conditions in a specific ValueSet.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | code:in | token |
{ "resourceType": "CapabilityStatement", "id": "mcode-sender-cancer-conditions-then-patients", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "cic" } ], "url": "http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-cancer-conditions-then-patients", "version": "4.0.0", "name": "CapabilityStatementSenderConditionsThenPatients", "title": "mCODE Data Sender: Get Conditions then Patients", "status": "draft", "experimental": true, "date": "2020-10-30T07:15:00.000000-04:00", "publisher": "HL7 International / Clinical Interoperability Council", "contact": [ { "name": "HL7 International / Clinical Interoperability Council", "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/cic" }, { "system": "email", "value": "ciclist@lists.HL7.org" } ] } ], "description": "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.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US", "display": "United States of America" } ] } ], "kind": "requirements", "imports": [ "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server" ], "fhirVersion": "4.0.1", "format": [ "xml", "json" ], "implementationGuide": [ "http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode" ], "rest": [ { "mode": "server", "documentation": "An mCODE Server **SHALL**:\n\n1. Support all profiles defined in this Implementation Guide..\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scope\n - (Status 404): unknown resource\n - (Status 410): deleted resource.\n1. Support json source formats for all mCODE interactions.\n1. Identify the mCODE profiles supported as part of the FHIR `meta.profile` attribute for each instance.\n1. Support the searchParameters on each profile individually and in combination.\n\nThe mCODE Server **SHOULD**:\n\n1. Support xml source formats for all mCODE interactions.\n", "security": { "description": "1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code." }, "resource": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Patient", "supportedProfile": [ "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" } ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "_id", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id", "type": "token" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Condition", "supportedProfile": [ "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "search-type", "documentation": "Identify Patient resources conforming to mCODE's CancerPatient profile via searching for conditions in a specific ValueSet." } ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "code:in", "definition": "http://hl7.org/fhir/us/mcode/SearchParameter/Condition-code", "type": "token" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Group", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "search-type", "documentation": "Retrieve Group of references to Patient resources conforming to mCODE." } ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "code", "definition": "http://hl7.org/fhir/SearchParameter/Group-code", "type": "token" } ] } ] } ] }