C-CDA on FHIR
1.2.0-ballot - CI Build United States of America flag

This page is part of the C-CDA on FHIR Implementation Guide (v1.2.0-ballot: STU 1 Ballot 4) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

: CCDA on FHIR Client - XML Representation

Active as of 2020-08-12

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="CcdaOnFhirClient"/>
  <meta>
    <versionId value="4"/>
    <lastUpdated value="2020-08-13T15:32:45.138+00:00"/>
    <source value="#vsazekVhbJUN5DVP"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
            <h2>CcdaOnFhirClient</h2>
            <div>
                <p>This section describes the expected capabilities of the C-CDA on FHIR Document Consumer (aka client) actor which is responsible for creating and initiating the queries for clinical documents provided by a C-CDA on FHIR Document Source (aka server) actors. This CapabilityStatement imports and extends the 
                    <a href="https://www.hl7.org/fhir/us/core/CapabilityStatement-us-core-client.html">us-core-client CapabilityStatement</a>
                </p>
            </div>
            <table>
                <tr>
                    <td>Mode</td>
                    <td>CLIENT</td>
                </tr>
            </table>
            <table>
                <tr>
                    <th>
                        <b>Resource Type</b>
                    </th>
                    <th>
                        <b>Profile</b>
                    </th>
                    <th>
                        <b title="GET a resource (read interaction)">Read</b>
                    </th>
                    <th>
                        <b title="GET past versions of resources (vread interaction)">V-Read</b>
                    </th>
                    <th>
                        <b title="GET all set of resources of the type (search interaction)">Search</b>
                    </th>
                    <th>
                        <b title="PUT a new resource version (update interaction)">Update</b>
                    </th>
                    <th>
                        <b title="PATCH a new resource version (patch interaction)">Patch</b>
                    </th>
                    <th>
                        <b title="POST a new resource (create interaction)">Create</b>
                    </th>
                    <th>
                        <b title="DELETE a resource (delete interaction)">Delete</b>
                    </th>
                    <th>
                        <b title="GET changes to a resource (history interaction on instance)">Updates</b>
                    </th>
                    <th>
                        <b title="GET changes for all resources of the type (history interaction on type)">History</b>
                    </th>
                </tr>
                <tr>
                    <td>Bundle</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                </tr>
                <tr>
                    <td>Composition</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                    <td>y</td>
                </tr>
            </table>
        </div>
  </text>
  <url
       value="http://hl7.org/fhir/us/ccda/CapabilityStatement/CcdaOnFhirClient"/>
  <version value="1.2.0-ballot"/>
  <name value="CcdaOnFhirClient"/>
  <title value="CCDA on FHIR Client"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2020-08-12"/>
  <publisher value="HL7 Structured Documents Working Group"/>
  <contact>
    <name value="HL7 Structured Documents Working Group"/>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/Special/committees/structure/index.cfm"/>
    </telecom>
  </contact>
  <description
               value="This section describes the expected capabilities of the C-CDA on FHIR Document Consumer (aka client) actor which is responsible for creating and initiating the queries for clinical documents provided by a C-CDA on FHIR Document Source (aka server) actors. This CapabilityStatement imports and extends the [us-core-client CapabilityStatement](https://www.hl7.org/fhir/us/core/CapabilityStatement-us-core-client.html)"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </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"/>
  <rest>
    <mode value="client"/>
    <resource>
      <type value="Bundle"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="vread"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="patch"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <interaction>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <code value="history-type"/>
      </interaction>
    </resource>
    <resource>
      <type value="Composition"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Care-Plan-Document"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Consultation-Note"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Continuity-of-Care-Document"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Diagnostic-Imaging-Report"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Discharge-Summary"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Operative-Note"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Procedure-Note"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Progress-Note"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Referral-Note"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/ccda/StructureDefinition/Transfer-Summary"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="vread"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="patch"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <interaction>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <code value="history-type"/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>