PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.us.insurance-card@1.0.0
    http://hl7.org/fhir/us/insurance-card/CapabilityStatement/c4dic
{
  "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.",
  "_filename": "CapabilityStatement-c4dic.json",
  "package_name": "hl7.fhir.us.insurance-card",
  "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"
    } ]
  } ],
  "date": "2022-04-20",
  "publisher": "HL7 Payer/Provider Information Exchange Working Group (PIE WG)",
  "patchFormat": [ "application/json-patch+json" ],
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "US",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "name": "InsuranceCardCapabilityStatement",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "C4DIC CapabilityStatement",
  "package_version": "1.0.0",
  "status": "active",
  "id": "bba91ae8-d4c9-46d1-a540-f6bf04bc5730",
  "kind": "requirements",
  "implementationGuide": [ "http://hl7.org/fhir/us/insurance-card/ImplementationGuide/hl7.fhir.us.insurance-card" ],
  "url": "http://hl7.org/fhir/us/insurance-card/CapabilityStatement/c4dic",
  "version": "1.0.0",
  "contact": [ {
    "name": "HL7 Payer/Provider Information Exchange Working Group (PIE WG)",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/claims",
      "system": "url"
    }, {
      "value": "pie@lists.HL7.org",
      "system": "email"
    } ]
  } ],
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "Coverage",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "interaction": [ {
        "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": "SHALL"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "searchParam": [ {
        "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"
        } ]
      } ],
      "searchInclude": [ "Coverage:beneficiary", "Coverage:payor" ],
      "referencePolicy": [ "resolves" ],
      "supportedProfile": [ "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage" ]
    }, {
      "type": "Organization",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "interaction": [ {
        "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": "SHALL"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "referencePolicy": [ "resolves" ],
      "supportedProfile": [ "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization" ]
    }, {
      "type": "Patient",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "interaction": [ {
        "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": "SHALL"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "searchParam": [ {
        "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",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "referencePolicy": [ "resolves" ],
      "supportedProfile": [ "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient" ]
    } ],
    "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."
    },
    "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."
  } ]
}