minimal Common Oncology Data Elements (mCODE) Implementation Guide
3.0.0 - STU3 Release United States of America flag

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. For a full list of available versions, see the Directory of published versions

: mCODE Data Receiver: Get Bundle for a Patient - XML Representation

Draft as of 2020-10-30

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="mcode-receiver-patient-bundle"/>
  <text>
    <status value="generated"/>
    <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>Gets an <a href="StructureDefinition-mcode-patient-bundle.html">mCODE Patient Bundle</a> for a specific patient that contains all of that patient's resources that conform to mCODE Profiles.</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">minimal Common Oncology Data Elements (mCODE) Implementation Guide</a></li></ul>  <!-- Imports --><h3 id="should_css" class="no_toc">Include And Support Everything In The Following CapabilityStatements:</h3><ul><li><a href="http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client">US Core Client CapabilityStatement</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>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cic"/>
  </extension>
  <url
       value="http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-receiver-patient-bundle"/>
  <version value="3.0.0"/>
  <name value="CapabilityStatementPatientBundle"/>
  <title value="mCODE Data Receiver: Get Bundle for a Patient"/>
  <status value="draft"/>
  <experimental value="true"/>
  <date value="2020-10-30T07:15:00.000000-04:00"/>
  <publisher value="HL7 International / Clinical Interoperability Council"/>
  <contact>
    <name value="HL7 International / Clinical Interoperability Council"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cic"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="ciclist@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="Gets an [mCODE Patient Bundle](StructureDefinition-mcode-patient-bundle.html) for a specific patient that contains all of that patient's resources that conform to mCODE Profiles."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <imports
           value="http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client"/>
  <fhirVersion value="4.0.1"/>
  <format value="xml"/>
  <format value="json"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode"/>
  <rest>
    <mode value="client"/>
    <documentation
                   value="An mCODE Client **SHALL**:

1. Support all profiles defined in this Implementation Guide..
1.  Implement the RESTful behavior according to the FHIR specification.
1. 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.
1. Support json source formats for all mCODE interactions.
1. Identify the mCODE  profiles supported as part of the FHIR `meta.profile` attribute for each instance.
1. Support the searchParameters on each profile individually and in combination.

The mCODE Client **SHOULD**:

1. Support xml source formats for all mCODE interactions.
"/>
    <security>
      <description
                   value="1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.
1. A client **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."/>
    </security>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="mcode-patient-bundle"/>
      <definition
                  value="http://hl7.org/fhir/us/mcode/OperationDefinition/mcode-patient-everything"/>
    </operation>
  </rest>
</CapabilityStatement>