xCaliber healthCare Data Mesh

Claim

Source Object: Claim

Overview and Usage: The "Claim" source object in athena EHR is a comprehensive data model designed to capture and manage information related to patient claim alerts, including billing and insurance details. It is essential for tracking billing and insurance-related information associated with patient claims. Here's an overview of key fields and their usage:

  • Billed Provider ID: "billedproviderid" identifies the provider responsible for billing and processing insurance claims.
  • Billed Service Date: "billedservicedate" records the date when the billed service was provided to the patient.
  • Charge Amount: "chargeamount" specifies the amount charged for the service or procedure.
  • Claim Created Date: "claimcreateddate" indicates the date when the insurance claim was created or processed.
  • Claim ID: "claimid" serves as a unique identifier for the insurance claim.
  • Diagnoses: The "diagnoses" section contains information about patient diagnoses, including codes, descriptions, and category.
  • Patient ID: "patientid" links the chart alert to the specific patient's record.
  • Patient Payer: "patientpayer" includes details about the patient's insurance payer, status, and related notes.
  • Primary Insurance Payer: The "primaryinsurancepayer" section provides information about the primary insurance payer, including package ID, status, and related details.
  • Procedures: The "procedures" section records details about procedures performed, including allowable amounts, codes, descriptions, and related transaction information.
  • Secondary Insurance Payer: The "secondaryinsurancepayer" section offers details about the secondary insurance payer, including package ID, status, and related information.
  • Appointment ID: "appointmentid" associates the chart alert with a specific patient appointment.
  • Department ID: "departmentid" specifies the department or healthcare unit associated with the chart alert.
  • Referral Authorization ID: "referralauthid" contains the identification of a referral authorization associated with the alert.
  • Referring Provider ID: "referringproviderid" identifies the provider who referred the patient for the services or procedures.
  • Reserved Field: "reserved19" represents a field that may have a specific use within athena EHR.
  • Transaction Details: The "transactiondetails" section includes information related to claim charges, allowable amounts, codes, and notes.
  • Custom Fields: "customfields" provides flexibility for adding custom data fields and options.

The "Claim" source object is vital for managing billing and insurance-related information associated with patient charts. It is used to track claims, procedures, and diagnoses, ensuring accurate billing and insurance processing. Developers can leverage this source object to build features and applications that support billing, claims management, and insurance-related processes within athena EHR.

Mapping Table

Data FieldExample ValueSource Data Field DescriptionSource Field Data TypeSource Data Field CardinalityMapped FHIR++ ResourceMapped FHIR Data FieldAugmented MappingAssociated Coding SystemAssociated FHIR Data Field ExtensionMapping Context
billedproviderid-The provider ID of the billing provider for this claim.Integer0..1Claimprovider.reference--billed-provider-idTop Level
billedservicedate-The billed date of service.String0..1ClaimbillablePeriod.end---Top Level
chargeamount-The total amount billed for all services from this claim.String0..1Claimtotal---Top Level
claimcreateddate-The date the claim was created.String0..1Claimcreated---Top Level
claimid-athenaNet's internal ID for this claim, specific to the practice.String0..1Claimid---Top Level
diagnoses-Diagnoses is an array of all diagnoses. Each entry in the array is a hash with several fields. /ccda is a better clinical representation. These fields are:Object0..*Claim----Top Level
diagnoses.deleteddiagnosis-In certain cases, diagnoses may be added and then removed from a particular claim. In normal circumstances, this will be false. However, if a diagnosis was removed, this will be true.String0..1Claimdiagnosis[}.extension[].valueString--deleted-diagnosisTop Level
diagnoses.diagnosiscategory-The category for this diagnosis.String0..1Claimdiagnosis[].type[].text---Top Level
diagnoses.diagnosiscodeset-Either ICD9 or ICD10.String0..1Claimdiagnosis[].diagnosis.CodeableConcept.coding[].system-ICD10,ICD9-Top Level
diagnoses.diagnosisdescription-A description of this diagnosis.String0..1Claimdiagnosis[].diagnosis.CodeableConcept.coding[].display---Top Level
diagnoses.diagnosisid-A unique ID related to this diagnosis.String0..1Claimdiagnosis[*].diagnosisReference.reference---Top Level
diagnoses.diagnosisrawcode-The raw ICD-9 code. This will migrate to ICD-10 in the future.String0..1Claimdiagnosis[].diagnosis.CodeableConcept.coding[].code---Top Level
patientid-The patient ID associated with this claim.Integer1..1Claimpatient.reference---Top Level
patientpayer-The status and notes of a responsible payer. This payer is the patient.Object0..*Claim----Top Level
patientpayer.note-The status associated with this responsible payer.String0..1Claimextension[*].valueString--patient-payer-noteTop Level
patientpayer.status-The status and notes of a responsible payer. This payer is the primary insurace.String0..1Claimstatus---Top Level
primaryinsurancepayer-The primary insurance id associated with this claim.Object0..*Claim----Top Level
primaryinsurancepayer.primarypatientinsuranceid--Integer0..1Claiminsurance[0].coverage.reference---Top Level
procedures-Procedures is an array of all procedures. /ccda is a better clinical representation. These fields are:Object0..*Claim----Top Level
procedures.chargeamount-The amount charged for this procedure.String0..1Claimprocedure[].extension[].valueString--procedure-charge-amountTop Level
procedures.procedurecode-The CPT code associated with this procedure.String0..1Claimprocedure[].procedureCodeableConcept.coding[].code---Top Level
procedures.proceduredescription-A description of this procedure.String0..1Claimprocedure[].procedureCodeableConcept.coding[].display---Top Level
secondaryinsurancepayer-The status and notes of a responsible payer. This payer is the secondary insurace.Object0..*Claim----Top Level
secondaryinsurancepayer.secondarypatientinsuranceid-The secondary insurance id associated with this claim.Integer0..1Claiminsurance[1].coverage.reference---Top Level
appointmentid-The appointment ID associated with this claim.String0..1Claimextension[*].valueString--appointment-idTop Level
departmentid-The department ID associated with this claim.Integer1..1Claimextension[*].valueInteger--department-idTop Level
referralauthid-The referral authorization ID for this claim.Integer0..1Claimextension[*].valueInteger--referral-auth-idTop Level
referringproviderid-The referring provider ID for this claim. See /referringproviders. This is not the same as the ID from the /providers call.Integer0..1Claimprovider.extensions[*].valueInteger--referring-provider-idTop Level
reserved19-The text in the Reserved 19 field.String0..1Claimextension[*].valueString--reserved19Top Level
transactiondetails-A hash of ids (transactionid) to amounts; these should sum to the chargeamount.Object0..*Claimextension[*].valueString--transaction-detailsTop Level
transactionid-A unique ID for the primary transaction this claim represents. May be useful for debugging.String0..1Claimextension[*].valueString--transaction-idTop Level
customfields-The claim custom field values may or may not be the same between departments.Object0..*Claim---custom-fieldsTop Level
customfields.customfieldid-Corresponds to the /customfields customfieldid.String0..1Claimextension[].valueCodeableConcept[0].coding[].code---Top Level
customfields.customfieldvalue-For a non-select custom field, the value.String0..1Claimextension[].valueCodeableConcept[0].coding[].display---Top Level
customfields.optionid-For a select custom field, the selectid value (from /customfield's selectlist).String0..1Claimextension[].valueCodeableConcept[0].coding[].id--option-idTop Level
primaryinsurancepayer-The status and notes of a responsible payer. This payer is the patient.Object0..*Claim----Top Level
primaryinsurancepayer.primaryinsurancepackageid-The primary insurance Package id associated with this claim.String0..1Claiminsurance[0].extension[*].valueString--primary-insurance-package-idTop Level
primaryinsurancepayer.status-The status associated with this responsible payer.String0..1Claiminsurance[0].extension[*].valueString--primary-insurance-statusTop Level
procedures-Procedures is an array of all procedures. /ccda is a better clinical representation. These fields are:Object0..*Claim----Top Level
procedures.allowableamount-The total amount expected from payer for all services from this procedure.String0..1Claimprocedure[].extension[].valueString--allowable-amountTop Level
procedures.allowablemax-The maximum amount expected from payer for all services from this procedure.String0..1Claimprocedure[].extension[].valueString--allowable-maxTop Level
procedures.allowablemin-The minimum amount expected from payer for all services from this procedure.String0..1Claimprocedure[].extension[].valueString--allowable-minTop Level
procedures.procedurecategory-The category name associated with this procedure.String0..1Claimprocedure[].type[].coding[0].display---Top Level
procedures.transactionid-The ID of the last transaction associated with the claim.String0..1Claimprocedure[].extension[].valueString--procedure-transaction-idTop Level
secondaryinsurancepayer-The status and notes of a responsible payer. This payer is the secondary insurace.Object0..*Claim----Top Level
secondaryinsurancepayer.secondaryinsurancepackageid-The secondary insurance id associated with this claim.Integer0..1Claiminsurance[1].extension[*].valueString--secondary-insurance-package-idTop Level
orderingproviderid-The ordering provider id.Integer0..1Claimprovider.extensions[*].valueIntegerordering-provider-idTop Level
renderingproviderid-The rendering provider id.Integer0..1Claimprovider.extensions[*].valueIntegerrendering-provider-idTop Level
servicedate-A date string that corresponds with when the patient was seen.String0..1Claimextensions[*].valueStringservice-dateTop Level
supervisingproviderid-The supervising provider ID.Integer0..1Claimprovider.referenceTop Level
claimcharges.allowableamount-The total expected allowable amount for this charge. If passed, will override the amount that would be calculated from the usual practice allowable schedule.Number0..1Claimprocedure[].extension[].valueIntegerclaim-charges-allowable-amountTop Level
claimcharges.allowablemax-The total maximum allowable amount for this charge. If passed, will override the amount that would be calculated from the usual practice allowable schedule.Number0..1Claimprocedure[].extension[].valueIntegerclaim-charges-allowable-maxTop Level
claimcharges.allowablemin-The total minimum allowable amount for this charge. If passed, will override the amount that would be calculated from the usual practice allowable schedule.Number0..1Claimprocedure[].extension[].valueIntegerclaim-charges-allowable-minTop Level
claimcharges.allowablescheduleid-The ID of the athenaNet allowable schedule to associated with this charge. If passed, will override the usual practice allowable schedule.Integer0..1Claimprocedure[].extension[].valueIntegerclaim-charges-allowable-schedule-idTop Level
claimcharges.icd10code1-Primary ICD-10 diagnosis for this charge.String0..1Claimdiagnosis.diagnosesCodeableConcept.coding[*].codesystem=ICD10ICD10icd-codesTop Level
claimcharges.icd9code1-Primary ICD-9 diagnosis for this charge.String0..1Claimdiagnosis.diagnosesCodeableConcept.coding[*].codesystem-ICD9ICD9-Top Level
claimcharges.linenote-Optional line note for this charge. Any value for this field will be truncated to 80 characters.String0..1Claimprocedure[].extension[].valueStringline-noteTop Level
claimcharges.procedurecode-CPT code for this procedure, including any modifiers (e.g. 99213,26,59).String0..1Claimprocedure[*].procedureCoadableConcept.coding.codeprocedure-codeTop Level
claimcharges.unitamount-The per-unit amount for this charge. If passed, will overwrite the amount defined in the practice fee schedule.Number0..1Claimprocedure[].extension[].valueIntegerunit-amountTop Level
claimcharges.units-The number of units to bill for this charge. If not specified, defaults to 1.Integer0..1Claimprocedure[].extension[].valueIntegerunitsTop Level
primarypatientinsuranceid-The athena primary patient insurance ID. Defaults to the patient's active primary insurance.Integer0..1Claiminsurance[0].coverage.reference-Top Level
secondarypatientinsuranceid-The athena secondary patient insurance ID. Defaults to the patient's active secondary insurance.Integer0..1Claiminsurance[1].coverage.reference-Top Level
claimchargesClaimextensions[*].extensionclaim-chargesTop Level