Data @ the Point of Care Implementation Guide

XML Format: CapabilityStatement-dpc-capabilities


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="dpc-capabilities"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2/><div><p>This Capability Statement defines the available resource, endpoints and operations supported by the Data @ the Point of Care Application.</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></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 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="POST a new resource (create interaction)">Create</b></th><th><b title="DELETE a resource (delete interaction)">Delete</b></th></tr><tr><td>Group</td><td><a href="https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-attribution-roster">https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-attribution-roster</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Organization</td><td><a href="https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-organization">https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-organization</a></td><td>y</td><td></td><td></td><td></td><td></td></tr><tr><td>Patient</td><td><a href="https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-patient">https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-patient</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Practitioner</td><td><a href="https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-practitioner">https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-practitioner</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>StructureDefinition</td><td><a href="https://dpc.cms.gov/api/v1/StructureDefinition">https://dpc.cms.gov/api/v1/StructureDefinition</a></td><td>y</td><td>y</td><td></td><td></td><td></td></tr></table></div>
  </text>
  <url value="https://dpc.cms.gov/api/v1/CapabilityStatement/dpc-capabilities"/>
  <version value="0.3.0-SNAPSHOT"/>
  <status value="draft"/>
  <date value="2019"/>
  <publisher value="Centers for Medicare and Medicaid Services"/>
  <description
               value="This Capability Statement defines the available resource, endpoints and operations supported by the Data @ the Point of Care Application."/>
  <kind value="instance"/>
  <instantiates
                value="http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data"/>
  <software>
    <name value="Data @ Point of Care API"/>
    <version value="0.3.0-SNAPSHOT"/>
    <releaseDate value="2019"/>
  </software>
  <fhirVersion value="3.0.2"/>
  <acceptUnknown value="extensions"/>
  <format value="application/json"/>
  <format value="application/fhir+json"/>
  <rest>
    <mode value="server"/>
    <security>
      <extension
                 url="http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris">
        <extension url="token">
          <valueUri value="https://dpc.cms.gov/api/v1/Token/auth"/>
        </extension>
      </extension>
      <cors value="true"/>
      <service>
        <coding>
          <system
                  value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
          <code value="SMART-on-FHIR"/>
          <display value="SMART on FHIR"/>
        </coding>
        <text value="SMART on FHIR Backend Services"/>
      </service>
    </security>
    <resource>
      <type value="Group"/>
      <profile>
        <reference
                   value="https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-attribution-roster"/>
      </profile>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <versioning value="no-version"/>
      <searchParam>
        <name value="characteristic-value"/>
        <type value="token"/>
        <documentation
                       value="Search for Attribution rosters which are attributed to the given provider NPI"/>
      </searchParam>
      <searchParam>
        <name value="member"/>
        <type value="reference"/>
        <documentation
                       value="Search for Attribution groups in which the given Patient resource is a member."/>
      </searchParam>
    </resource>
    <resource>
      <type value="Organization"/>
      <profile>
        <reference
                   value="https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-organization"/>
      </profile>
      <interaction>
        <code value="read"/>
      </interaction>
      <versioning value="no-version"/>
    </resource>
    <resource>
      <type value="Patient"/>
      <profile>
        <reference
                   value="https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-patient"/>
      </profile>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <versioning value="no-version"/>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation
                       value="Find patient resources which match the given Identifier. For DPC, this will always return a single resource, as MBIs are unique."/>
      </searchParam>
    </resource>
    <resource>
      <type value="Practitioner"/>
      <profile>
        <reference
                   value="https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-practitioner"/>
      </profile>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <versioning value="no-version"/>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation
                       value="Find practitioner resources which match the given Identifier. For DPC, this will always return a single resource, as NPIs are unique."/>
      </searchParam>
    </resource>
    <resource>
      <type value="StructureDefinition"/>
      <profile>
        <reference value="https://dpc.cms.gov/api/v1/StructureDefinition"/>
      </profile>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <versioning value="no-version"/>
    </resource>
    <interaction>
      <code value="batch"/>
    </interaction>
    <operation>
      <name value="group-export"/>
      <definition>
        <reference
                   value="http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export"/>
      </definition>
    </operation>
    <operation>
      <name value="patient-everything"/>
      <definition>
        <reference
                   value="http://hl7.org/fhir/OperationDefinition/Patient-everything"/>
      </definition>
    </operation>
    <operation>
      <name value="validate"/>
      <definition>
        <reference
                   value="https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-practitioner-validate"/>
      </definition>
    </operation>
    <operation>
      <name value="submit"/>
      <definition>
        <reference
                   value="https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-practitioner-submit"/>
      </definition>
    </operation>
    <operation>
      <name value="validate"/>
      <definition>
        <reference
                   value="https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-patient-validate"/>
      </definition>
    </operation>
    <operation>
      <name value="submit"/>
      <definition>
        <reference
                   value="https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-patient-submit"/>
      </definition>
    </operation>
    <operation>
      <name value="add"/>
      <definition>
        <reference
                   value="https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-group-add"/>
      </definition>
    </operation>
    <operation>
      <name value="remove"/>
      <definition>
        <reference
                   value="https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-group-remove"/>
      </definition>
    </operation>
  </rest>
</CapabilityStatement>