This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v2.1.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
Draft as of 2020-10-30 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:CapabilityStatement ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "mcode-receiver-patient-bundle"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">mCODE Data Receiver: Get Bundle for a Patient</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patient-bundle</code></li><li><b>Implementation Guide Version:</b> None</li><li><b>FHIR Version:</b> 4.0.1</li><li><b>Intended Use:</b> Requirements</li><li><b>Supported Formats:</b> XML, JSON</li><li><b>Published:</b> 2020-10-30 07:15:00.000000-04:00</li><li><b>Published by:</b> None</li><li><b>Status:</b> Draft (experimental)</li></ul><p>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 <code>_include</code> are not available on the system.</p> <!-- No support expectation extension --><h3 id=\"igs\" class=\"no_toc\">Support the Following Implementation Guides:</h3><ul><li><a href=\"http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode\">HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1</a></li></ul> <!-- REST Behavior --><h3 id=\"behavior\">FHIR Client RESTful Capabilities</h3><p>An mCODE Client <strong>SHALL</strong>:</p><ol><li>Support all profiles defined in this Implementation Guide..</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Return the following response classes:<ul><li>(Status 400): invalid parameter</li><li>(Status 401/4xx): unauthorized request</li><li>(Status 403): insufficient scope</li><li>(Status 404): unknown resource</li><li>(Status 410): deleted resource.</li></ul></li><li>Support json source formats for all mCODE interactions.</li><li>Identify the mCODE profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li><li>Support the searchParameters on each profile individually and in combination.</li></ol><p>The mCODE Client <strong>SHOULD</strong>:</p><ol><li>Support xml source formats for all mCODE interactions.</li></ol><p id=\"security\"><strong>Security:</strong></p><ol><li>See the <a href=\"https://www.hl7.org/fhir/security.html#general\">General Security Considerations</a> section for requirements and recommendations.</li><li>A client <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li></ol><p><strong>Summary of Client Wide Operations</strong></p><ul><li><strong>SHALL</strong> support the <a href=\"http://hl7.org/fhir/us/mcode/OperationDefinition/mcode-patient-everything\"><code>$mcode-patient-bundle</code></a> operation.</li></ul></div>"
] ; #
fhir:url [ fhir:v "http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patient-bundle"^^xsd:anyURI] ; #
fhir:version [ fhir:v "2.1.0"] ; #
fhir:name [ fhir:v "CapabilityStatementPatientBundle"] ; #
fhir:title [ fhir:v "mCODE Data Receiver: Get Bundle for a Patient"] ; #
fhir:status [ fhir:v "draft"] ; #
fhir:experimental [ fhir:v "true"^^xsd:boolean] ; #
fhir:date [ fhir:v "2020-10-30T07:15:00.000000-04:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "HL7 International Clinical Interoperability Council"] ; #
fhir:contact ( [
fhir:name [ fhir:v "HL7 International Clinical Interoperability Council" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/cic" ] ] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "ciclist@lists.HL7.org" ] ] )
] ) ; #
fhir:description [ fhir:v "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."] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "US" ] ;
fhir:display [ fhir:v "United States of America" ] ] )
] ) ; #
fhir:kind [ fhir:v "requirements"] ; #
fhir:fhirVersion [ fhir:v "4.0.1"] ; #
fhir:format ( [ fhir:v "xml"] [ fhir:v "json"] ) ; #
fhir:implementationGuide ( [
fhir:v "http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode>
] ) ; #
fhir:rest ( [
fhir:mode [ fhir:v "client" ] ;
fhir:documentation [ fhir:v "An mCODE Client **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 Client **SHOULD**:\n\n1. Support xml source formats for all mCODE interactions.\n" ] ;
fhir:security [
fhir:description [ fhir:v "1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.\n1. A client **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code." ] ] ;
( fhir:operation [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [ fhir:v "SHALL" ] ] ) ;
fhir:name [ fhir:v "mcode-patient-bundle" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/mcode/OperationDefinition/mcode-patient-everything"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/mcode/OperationDefinition/mcode-patient-everything> ] ] )
] ) . #
IG © 2022+ HL7 International Clinical Interoperability Council. Package hl7.fhir.us.mcode#2.1.0 based on FHIR 4.0.1. Generated 2023-03-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change