{
"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.",
"_filename": "CapabilityStatement-mcode-sender-cancer-conditions-then-patients.json",
"package_name": "hl7.fhir.us.mcode.r4",
"format": [ "xml", "json" ],
"date": "2020-10-30T07:15:00.000000-04:00",
"publisher": "HL7 International / Clinical Interoperability Council",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America"
} ]
} ],
"name": "CapabilityStatementSenderConditionsThenPatients",
"type": null,
"experimental": "true",
"resourceType": "CapabilityStatement",
"imports": [ "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server" ],
"title": "mCODE Data Sender: Get Conditions then Patients",
"package_version": "3.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cic"
} ],
"status": "draft",
"id": "15114ba6-9308-4656-9dc7-2ba0f2be3a3e",
"kind": "requirements",
"implementationGuide": [ "http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode" ],
"url": "http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-cancer-conditions-then-patients",
"version": "3.0.0",
"contact": [ {
"name": "HL7 International / Clinical Interoperability Council",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/cic",
"system": "url"
}, {
"value": "ciclist@lists.HL7.org",
"system": "email"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"type": "Patient",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"type": "Condition",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Identify Patient resources conforming to mCODE's CancerPatient profile via searching for conditions in a specific ValueSet."
} ],
"searchParam": [ {
"name": "code:in",
"type": "uri",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/mcode/SearchParameter/Condition-code"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient" ]
}, {
"type": "Group",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Retrieve Group of references to Patient resources conforming to mCODE."
} ],
"searchParam": [ {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Group-code"
} ]
} ],
"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."
},
"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"
} ]
}