# C4DIC CapabilityStatement - CARIN Digital Insurance Card v2.0.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **C4DIC CapabilityStatement**

## CapabilityStatement: C4DIC CapabilityStatement 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org/fhir/us/insurance-card/CapabilityStatement/c4dic | *Version*:2.0.0 | |
| * Standards status: *[Trial-use](http://hl7.org/fhir/R4/versions.html#std-process) | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 2 | *Computable Name*:InsuranceCardCapabilityStatement |

 
This Section describes the expected capabilities of the C4DIC Server actor which is responsible for providing responses to the queries submitted by the C4DIC Requestors. 

 [Raw OpenAPI-Swagger Definition file](c4dic.openapi.json) | [Download](c4dic.openapi.json) 

## C4DIC CapabilityStatement

* **Official URL:**`http://hl7.org/fhir/us/insurance-card/CapabilityStatement/c4dic`
* **Implementation Guide Version:** 0.1.0
* **FHIR Version:** 4.0.1
* **Intended Use:** Requirements
* **Supported Formats:** **shall** support JSON, **should** support XML 
* **Supported Patch Formats:** APPLICATION/JSON-PATCH+JSON 
* **Published:** 2022-04-20
* **Published by:** HL7 Payer/Provider Information Exchange Working Group (PIE WG)
* **Status:** Active

This Section describes the expected capabilities of the C4DIC Server actor which is responsible for providing responses to the queries submitted by the C4DIC Requestors.

### Support the Following Implementation Guides:

* [http://hl7.org/fhir/us/insurance-card/ImplementationGuide/hl7.fhir.us.insurance-card](http://hl7.org/fhir/us/insurance-card/ImplementationGuide/hl7.fhir.us.insurance-card)

### FHIR Server RESTful Capabilities

The C4DIC Server **SHALL**:

1. Support all profiles defined in this Implementation Guide.
1. Implement the RESTful behavior according to the FHIR specification.
1. For all the supported search interactions in this guide, support the GET based search.
1. Return the following response classes: • (Status 400): invalid parameter • (Status 401/4xx): unauthorized request • (Status 403): insufficient scopes • (Status 404): unknown resource • (Status 410): deleted resource
1. Support json source formats for all profiles C4DIC interactions.
1. Identify the C4DIC 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 C4DIC Server **SHOULD**:

1. Support xml source formats for all C4DIC interactions.

**Security:**

1. See the[General Security Considerations](Authorization_Authentication_and_Registration.md)section for requirements and recommendations.
1. A server**SHALL**reject any unauthorized requests by returning an`HTTP 401`unauthorized response code.

### RESTful Capabilities by Resource/Profile:

**Summary**

| | | | | | | |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| [Coverage](#coverage) | search-type, read, vread | [C4DIC-Coverage](http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage) | _id, _profile, _lastUpdated, beneficiary, subscriber, patient, identifier, period, status | Coverage:beneficiary, Coverage:payor |  |  |
| [Organization](#organization) | search-type, read, vread | [C4DIC-Organization](http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization) | _id |  |  |  |
| [Patient](#patient) | search-type, read, vread | [C4DIC-Patient](http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient) | _id, _lastUpdated, identifier, name |  |  |  |

#### Coverage

Conformance Expectation: **SHALL**

Resource Specific Documentation:

Example query to search for Coverages which contain insurance card information: {baseurl}/Coverage?_profile=http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage

Supported Profiles:

* [C4DIC-Coverage](http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage)

Reference Policy: `resolves`

Profile Interaction Summary:

* **SHALL** support `search-type`, `read`.
* **SHOULD** support `vread`.

Fetch and Search Criteria:

*  A Server **SHALL** be capable of returning a Coverage resource using: `GET [base]/Coverage/[id]` 
*  A Server **SHOULD** be capable of returning a Coverage resource using: `GET [base]/Coverage/[id]/_history/vid` 
*  A Server **SHALL** be capable of returning resources matching a search query using: `GET [base]/Coverage/[id]{?[parameters]{&_format=[mime-type]}}` 
*  A Server **(conformance expectation undefined)** be capable of supporting the following _includes: 
* Coverage:beneficiary - `GET [base]/Coverage?[parameter=value]&_include=Coverage:beneficiary`
* Coverage:payor - `GET [base]/Coverage?[parameter=value]&_include=Coverage:payor`
 

Search Parameter Summary:

| | | | |
| :--- | :--- | :--- | :--- |
| **SHALL** | [ _id](http://hl7.org/fhir/R4/search.html#id) | token | `GET [base]/Coverage?_id=[id]` |
| **SHALL** | [ _profile](http://hl7.org/fhir/R4/search.html#id) | token | `GET [base]/Coverage?_profile=http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage` |
| **SHALL** | [ _lastUpdated](http://hl7.org/fhir/R4/search.html#lastUpdated) | reference | `GET [base]/Coverage?_lastUpdated=[dateTime]` |
| **SHALL** | [ beneficiary](http://hl7.org/fhir/R4/coverage.html#search) | date | `GET [base]/Coverage?beneficiary=[beneficiary]` |
| **SHALL** | [ subscriber](http://hl7.org/fhir/R4/coverage.html#search) | token | `GET [base]/Coverage?subscriber=[system]|[code]` |
| **SHALL** | [ patient](http://hl7.org/fhir/R4/coverage.html#search) | token | `GET [base]/Coverage?patient=[system]|[code]` |
| **SHALL** | [ identifier](http://hl7.org/fhir/R4/coverage.html#search) | date | `GET [base]/Coverage?identifier=[identifier]` |
| **SHALL** | [ period](http://hl7.org/fhir/R4/coverage.html#search) | date | `GET [base]/Coverage?period=[period]` |
| **SHALL** | [ status](http://hl7.org/fhir/R4/coverage.html#search) | token | `GET [base]/Coverage?status=[system]|[code]` |

#### Organization

Conformance Expectation: **SHALL**

Supported Profiles:

* [C4DIC-Organization](http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization)

Reference Policy: `resolves`

Profile Interaction Summary:

* **SHALL** support `search-type`, `read`.
* **SHOULD** support `vread`.

Fetch and Search Criteria:

*  A Server **SHALL** be capable of returning an Organization resource using: `GET [base]/Organization/[id]` 
*  A Server **SHOULD** be capable of returning an Organization resource using: `GET [base]/Organization/[id]/_history/vid` 
*  A Server **SHALL** be capable of returning resources matching a search query using: `GET [base]/Organization/[id]{?[parameters]{&_format=[mime-type]}}` 

Search Parameter Summary:

| | | | |
| :--- | :--- | :--- | :--- |
| **SHALL** | [ _id](http://hl7.org/fhir/R4/search.html#id) | reference | `GET [base]/Organization?_id=[id]` |

#### Patient

Conformance Expectation: **SHALL**

Supported Profiles:

* [C4DIC-Patient](http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient)

Reference Policy: `resolves`

Profile Interaction Summary:

* **SHALL** support `search-type`, `read`.
* **SHOULD** support `vread`.

Fetch and Search Criteria:

*  A Server **SHALL** be capable of returning a Patient resource using: `GET [base]/Patient/[id]` 
*  A Server **SHOULD** be capable of returning a Patient resource using: `GET [base]/Patient/[id]/_history/vid` 
*  A Server **SHALL** be capable of returning resources matching a search query using: `GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}` 

Search Parameter Summary:

| | | | |
| :--- | :--- | :--- | :--- |
| **SHALL** | [ _id](http://hl7.org/fhir/R4/search.html#id) | reference | `GET [base]/Patient?_id=[id]` |
| **SHALL** | [ _lastUpdated](http://hl7.org/fhir/R4/search.html#lastUpdated) | reference | `GET [base]/Patient?_lastUpdated=[dateTime]` |
| **SHALL** | [ identifier](http://hl7.org/fhir/R4/patient.html#search) | reference | `GET [base]/Patient?identifier=[type]/[id]` |
| **SHALL** | [ name](http://hl7.org/fhir/R4/patient.html#search) | reference | `GET [base]/Patient?name=[type]/[id]` |



## Resource Content

```json
{
  "resourceType" : "CapabilityStatement",
  "id" : "c4dic",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "claims"
  }],
  "url" : "http://hl7.org/fhir/us/insurance-card/CapabilityStatement/c4dic",
  "version" : "2.0.0",
  "name" : "InsuranceCardCapabilityStatement",
  "title" : "C4DIC CapabilityStatement",
  "status" : "active",
  "experimental" : false,
  "date" : "2022-04-20",
  "publisher" : "HL7 International / Payer/Provider Information Exchange Work Group",
  "contact" : [{
    "name" : "HL7 International / Payer/Provider Information Exchange Work Group",
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/claims"
    },
    {
      "system" : "email",
      "value" : "pie@lists.HL7.org"
    }]
  }],
  "description" : "This Section describes the expected capabilities of the C4DIC Server actor which is responsible for providing responses to the queries submitted by the C4DIC Requestors.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US"
    }]
  }],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : ["json", "xml"],
  "_format" : [{
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode" : "SHALL"
    }]
  },
  {
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode" : "SHOULD"
    }]
  }],
  "patchFormat" : ["application/json-patch+json"],
  "implementationGuide" : ["http://hl7.org/fhir/us/insurance-card/ImplementationGuide/hl7.fhir.us.insurance-card"],
  "rest" : [{
    "mode" : "server",
    "documentation" : "The C4DIC Server **SHALL**:\n\n1.\tSupport all profiles defined in this Implementation Guide.\n2.\tImplement the RESTful behavior according to the FHIR specification.\n3.\tFor all the supported search interactions in this guide, support the GET based search.\n4.\tReturn the following response classes:\n•\t(Status 400): invalid parameter\n•\t(Status 401/4xx): unauthorized request\n•\t(Status 403): insufficient scopes\n•\t(Status 404): unknown resource\n•\t(Status 410): deleted resource\n5.\tSupport json source formats for all profiles C4DIC interactions.\n6.\tIdentify the C4DIC profiles supported as part of the FHIR meta.profile attribute for each instance.\n7.\tSupport the searchParameters on each profile individually and in combination.\n\nThe C4DIC Server **SHOULD**:\n\n1.\tSupport xml source formats for all C4DIC interactions.",
    "security" : {
      "description" : "1. See the [General Security Considerations](Authorization_Authentication_and_Registration.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
    },
    "resource" : [{
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode" : "SHALL"
      }],
      "type" : "Coverage",
      "supportedProfile" : ["http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage"],
      "interaction" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "code" : "search-type"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "code" : "read"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHOULD"
        }],
        "code" : "vread"
      }],
      "referencePolicy" : ["resolves"],
      "searchInclude" : ["Coverage:beneficiary", "Coverage:payor"],
      "searchParam" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "_id",
        "type" : "token"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "_profile",
        "type" : "token"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "_lastUpdated",
        "type" : "reference"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "beneficiary",
        "type" : "date"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "subscriber",
        "type" : "token"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "patient",
        "type" : "token"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "identifier",
        "type" : "date"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "period",
        "type" : "date"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "status",
        "type" : "token"
      }]
    },
    {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode" : "SHALL"
      }],
      "type" : "Organization",
      "supportedProfile" : ["http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization"],
      "interaction" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "code" : "search-type"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "code" : "read"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHOULD"
        }],
        "code" : "vread"
      }],
      "referencePolicy" : ["resolves"],
      "searchParam" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "_id",
        "type" : "reference"
      }]
    },
    {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode" : "SHALL"
      }],
      "type" : "Patient",
      "supportedProfile" : ["http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient"],
      "interaction" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "code" : "search-type"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "code" : "read"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHOULD"
        }],
        "code" : "vread"
      }],
      "referencePolicy" : ["resolves"],
      "searchParam" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "_id",
        "type" : "reference"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "_lastUpdated",
        "type" : "reference"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "identifier",
        "type" : "reference"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "name",
        "type" : "reference"
      }]
    }]
  }]
}

```
