xCaliber healthCare Data Mesh

Coverage

Overview

The Coverage API equips healthcare developers with a standardized interface to seamlessly integrate and manage insurance coverage information, streamlining the verification and validation processes within clinical workflows. By leveraging this API, developers can enhance the accuracy of patient coverage checks, optimize billing procedures, and improve overall administrative efficiency in healthcare applications.

Use Case

  • Eligibility Checks - Check if patients have active insurance coverage for intended services.
  • Claims Processing - Verify coverage details to enable automated claim submissions.
  • Member Management - Add, update and view health plan membership details for patients.
  • Benefits Management - Maintain benefits, copays, deductibles levels for patient covers.
  • Authorization - Submit and track requests for prior authorizations needed before services.
  • Premium Payments - Record payment transactions associated with insurance premium amounts.
  • Product Catalog - Define and manage health insurance products with attributes, pricing.
  • Reporting & Analytics - Generate reports on membership, utilization, denials and appeals.
  • Value-based Care - Attribute and analyze outcomes of member panels under VBC contracts.
  • Patient Collections - Check eligibility status and outreach to patients regarding balances.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaInsurances
ElationPatient-Insurance
EpicInsurance Identifier, Insurance

Object Definition

{
  "resourceType": "Coverage",
  "id": "9876B1",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the coverage</div>"
  },
  "identifier": [
    {
      "system": "http://benefitsinc.com/certificate",
      "value": "12345"
    }
  ],
  "status": "active",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "EHCPOL",
        "display": "extended healthcare"
      }
    ]
  },
  "policyHolder": {
    "reference": "http://benefitsinc.com/FHIR/Organization/CBI35"
  },
  "subscriber": {
    "reference": "Patient/4"
  },
  "beneficiary": {
    "reference": "Patient/4"
  },
  "dependent": "0",
  "relationship": {
    "coding": [
      {
        "code": "self"
      }
    ]
  },
  "period": {
    "start": "2011-05-23",
    "end": "2012-05-23"
  },
  "payor": [
    {
      "reference": "Organization/2"
    }
  ],
  "class": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "group"
          }
        ]
      },
      "value": "CB135",
      "name": "Corporate Baker's Inc. Local #35"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "subgroup"
          }
        ]
      },
      "value": "123",
      "name": "Trainee Part-time Benefits"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "plan"
          }
        ]
      },
      "value": "B37FC",
      "name": "Full Coverage: Medical, Dental, Pharmacy, Vision, EHC"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "subplan"
          }
        ]
      },
      "value": "P7",
      "name": "Includes afterlife benefits"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "class"
          }
        ]
      },
      "value": "SILVER",
      "name": "Silver: Family Plan spouse only"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "subclass"
          }
        ]
      },
      "value": "Tier2",
      "name": "Low deductable, max $20 copay"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "sequence"
          }
        ]
      },
      "value": "9"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "rxid"
          }
        ]
      },
      "value": "MDF12345"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "rxbin"
          }
        ]
      },
      "value": "987654"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "rxgroup"
          }
        ]
      },
      "value": "M35PT"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "rxpcn"
          }
        ]
      },
      "value": "234516"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "sequence"
          }
        ]
      },
      "value": "9"
    }
  ],
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeCoverageThis is a Coverage resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedBackboneElementThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierA unique identifier assigned to this coverage.
statuscodeThe status of the resource instance.
typeCodeableConceptThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
policyHolderReferenceThe party who 'owns' the insurance policy.
subscriberReferenceThe party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
subscriberIdstringThe insurer assigned ID for the Subscriber.
beneficiaryReferenceThe party who benefits from the insurance coverage; the patient when products and/or services are provided.
dependentstringA unique identifier for a dependent under the coverage.
relationshipCodeableConceptThe relationship of beneficiary (patient) to the subscriber.
periodPeriodTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
payorReferenceThe program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
classBackboneElementA suite of underwriter specific classifiers.
class.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
class.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
class.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
class.typeCodeableConceptThe type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.
class.valuestringThe alphanumeric string value associated with the insurer issued label.
class.namestringA short description for the class.
orderpositiveIntThe order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
networkstringThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
costToBeneficiaryBackboneElementA suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.
costToBeneficiary.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
costToBeneficiary.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
costToBeneficiary.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
costToBeneficiary.typeCodeableConceptThe category of patient centric costs associated with treatment.
costToBeneficiary.valueQuantityQuantityThe amount due from the patient for the cost category.
costToBeneficiary.valueMoneyMoneyThe amount due from the patient for the cost category.
costToBeneficiary.exceptionBackboneElementA suite of codes indicating exceptions or reductions to patient costs and their effective periods.
costToBeneficiary.exception.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
costToBeneficiary.exception.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
costToBeneficiary.exception.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
costToBeneficiary.exception.typeCodeableConceptThe code for the specific exception.
costToBeneficiary.exception.periodPeriodThe timeframe during when the exception is in force.
subrogationbooleanWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
contractReferenceThe policy(s) which constitute this insurance coverage.

Extensions

NameURL
ANSI271http://xcaliber-fhir/structureDefinition/ansi-271
CREATED_DATEhttp://xcaliber-fhir/structureDefinition/created-date
DATE_OF_SERVICEhttp://xcaliber-fhir/structureDefinition/date-of-service
PATIENT_LAST_ELIGIBILITY_CHECKhttp://xcaliber-fhir/structureDefinition/patient-last-eligibility-check
DELETED_DATEhttp://xcaliber-fhir/structureDefinition/deleted-date
DEPARTMENTIDhttp://xcaliber-fhir/structureDefinition/department-id
EXTENSIONhttp://xcaliber-fhir/structureDefinition/extension
INSUREDENTITYTYPEIDhttp://xcaliber-fhir/structureDefinition/insured-entity-type-id
SEQUENCENUMBERhttp://xcaliber-fhir/structureDefinition/sequence-number
UPDATEAPPOINTMENTShttp://xcaliber-fhir/structureDefinition/update-appointments
VALIDATEINSURANCEIDNUMBERhttp://xcaliber-fhir/structureDefinition/validate-insurance-id-number
INSURANCEPOLICYHOLDERCOUNTRYhttp://xcaliber-fhir/structureDefinition/policy-holder/country
INSURANCEPOLICYHOLDERDOBhttp://xcaliber-fhir/structureDefinition/policy-holder/dob
INSURANCEPOLICYHOLDERNAMEhttp://xcaliber-fhir/structureDefinition/policy-holder/name
INSURANCEPOLICYHOLDERFIRSTNAMEhttp://xcaliber-fhir/structureDefinition/policy-holder/first-name
INSURANCEPOLICYHOLDERLASTNAMEhttp://xcaliber-fhir/structureDefinition/policy-holder/last-name
INSURANCEPOLICYHOLDERMIDDLENAMEhttp://xcaliber-fhir/structureDefinition/policy-holder/middle-name
INSURANCEPOLICYHOLDERSUFFIXhttp://xcaliber-fhir/structureDefinition/policy-holder/suffix
PERSON_LAST_NAMEhttp://xcaliber-fhir/structureDefinition/person-last-name
INSURANCEPHONEhttp://xcaliber-fhir/structureDefinition/insurance-phone
PATIENTIDhttp://xcaliber-fhir/structureDefinition/patient-id
COINSURANCEPERCENThttp://xcaliber-fhir/structureDefinition/coinsurance-percent
INSUREDREFERRINGPROVIDERhttp://xcaliber-fhir/structureDefinition/referring-provider
INSUREDIDNUMBERhttp://xcaliber-fhir/structureDefinition/insured-id-number
INSURANCEPRODUCTTYPEhttp://xcaliber-fhir/structureDefinition/product-type
ELIGIBILITYLASTCHECKEDhttp://xcaliber-fhir/structureDefinition/eligibility-last-checked
ELIGIBILITYMESSAGEhttp://xcaliber-fhir/structureDefinition/eligibility-message
ELIGIBILITYREASONhttp://xcaliber-fhir/structureDefinition/eligibility-reason
ELIGIBILITYSTATUShttp://xcaliber-fhir/structureDefinition/eligibility-status
ADDITIONALINFORMATIONhttp://xcaliber-fhir/structureDefinition/additional-information
AUTHORIZATIONNUMBERhttp://xcaliber-fhir/structureDefinition/authorization-number
AUTHORIZATIONSTATUShttp://xcaliber-fhir/structureDefinition/authorization-status
VISITSAPPROVEDhttp://xcaliber-fhir/structureDefinition/visits-approved
MEMBERIDhttp://xcaliber-fhir/structureDefinition/member-id

Operations & APIs

Coverage-GET

Coverage-POST

Coverage ID-GET

Coverage ID-PUT

Coverage ID-DELETE

Coverage Export-POST