This page is part of the C-CDA on FHIR Implementation Guide (v1.2.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: CCDA on FHIR Client - JSON Representation

Raw json | Download

{
  "resourceType" : "CapabilityStatement",
  "id" : "CcdaOnFhirClient",
  "meta" : {
    "versionId" : "4",
    "lastUpdated" : "2020-08-13T15:32:45.138+00:00",
    "source" : "#vsazekVhbJUN5DVP"
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n            <h2>CcdaOnFhirClient</h2>\n            <div>\n                <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 \n                    <a href=\"https://www.hl7.org/fhir/us/core/CapabilityStatement-us-core-client.html\">us-core-client CapabilityStatement</a>\n                </p>\n            </div>\n            <table>\n                <tr>\n                    <td>Mode</td>\n                    <td>CLIENT</td>\n                </tr>\n            </table>\n            <table>\n                <tr>\n                    <th>\n                        <b>Resource Type</b>\n                    </th>\n                    <th>\n                        <b>Profile</b>\n                    </th>\n                    <th>\n                        <b title=\"GET a resource (read interaction)\">Read</b>\n                    </th>\n                    <th>\n                        <b title=\"GET past versions of resources (vread interaction)\">V-Read</b>\n                    </th>\n                    <th>\n                        <b title=\"GET all set of resources of the type (search interaction)\">Search</b>\n                    </th>\n                    <th>\n                        <b title=\"PUT a new resource version (update interaction)\">Update</b>\n                    </th>\n                    <th>\n                        <b title=\"PATCH a new resource version (patch interaction)\">Patch</b>\n                    </th>\n                    <th>\n                        <b title=\"POST a new resource (create interaction)\">Create</b>\n                    </th>\n                    <th>\n                        <b title=\"DELETE a resource (delete interaction)\">Delete</b>\n                    </th>\n                    <th>\n                        <b title=\"GET changes to a resource (history interaction on instance)\">Updates</b>\n                    </th>\n                    <th>\n                        <b title=\"GET changes for all resources of the type (history interaction on type)\">History</b>\n                    </th>\n                </tr>\n                <tr>\n                    <td>Bundle</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                </tr>\n                <tr>\n                    <td>Composition</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                    <td>y</td>\n                </tr>\n            </table>\n        </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cgp"
    }
  ],
  "url" : "http://hl7.org/fhir/us/ccda/CapabilityStatement/CcdaOnFhirClient",
  "version" : "1.2.0",
  "name" : "CcdaOnFhirClient",
  "title" : "CCDA on FHIR Client",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-08-12",
  "publisher" : "HL7 International / Cross-Group Projects",
  "contact" : [
    {
      "name" : "HL7 International / Cross-Group Projects",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cgp"
        }
      ]
    }
  ],
  "description" : "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" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "imports" : [
    🔗 "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client"
  ],
  "fhirVersion" : "4.0.1",
  "format" : [
    "xml",
    "json"
  ],
  "rest" : [
    {
      "mode" : "client",
      "resource" : [
        {
          "type" : "Bundle",
          "interaction" : [
            {
              "code" : "create"
            },
            {
              "code" : "search-type"
            },
            {
              "code" : "read"
            },
            {
              "code" : "vread"
            },
            {
              "code" : "update"
            },
            {
              "code" : "patch"
            },
            {
              "code" : "delete"
            },
            {
              "code" : "history-instance"
            },
            {
              "code" : "history-type"
            }
          ]
        },
        {
          "type" : "Composition",
          "supportedProfile" : [
            🔗 "http://hl7.org/fhir/us/ccda/StructureDefinition/Care-Plan-Document"🔗 ,
            "http://hl7.org/fhir/us/ccda/StructureDefinition/Consultation-Note"🔗 ,
            "http://hl7.org/fhir/us/ccda/StructureDefinition/Continuity-of-Care-Document"🔗 ,
            "http://hl7.org/fhir/us/ccda/StructureDefinition/Diagnostic-Imaging-Report"🔗 ,
            "http://hl7.org/fhir/us/ccda/StructureDefinition/Discharge-Summary"🔗 ,
            "http://hl7.org/fhir/us/ccda/StructureDefinition/Operative-Note"🔗 ,
            "http://hl7.org/fhir/us/ccda/StructureDefinition/Procedure-Note"🔗 ,
            "http://hl7.org/fhir/us/ccda/StructureDefinition/Progress-Note"🔗 ,
            "http://hl7.org/fhir/us/ccda/StructureDefinition/Referral-Note"🔗 ,
            "http://hl7.org/fhir/us/ccda/StructureDefinition/Transfer-Summary"
          ],
          "interaction" : [
            {
              "code" : "create"
            },
            {
              "code" : "search-type"
            },
            {
              "code" : "read"
            },
            {
              "code" : "vread"
            },
            {
              "code" : "update"
            },
            {
              "code" : "patch"
            },
            {
              "code" : "delete"
            },
            {
              "code" : "history-instance"
            },
            {
              "code" : "history-type"
            }
          ]
        }
      ]
    }
  ]
}