Workflow-run
Task
Document
- GETDocument metadata
- GETFull document details
- GETDocument CSV content
- POSTUnzip file and return PDFs
- POSTUnzip file and return PDFs (async)
- POSTCreate PDF format from a Word document
- POSTGenerate CSV document
- POSTPresigned URL for upload
- POSTClassify document (async)
- POSTLegacy split document (async)
- POSTSplit document (async)
- POSTCreate documents from splits
- POSTLegacy extract document (async)
- POSTDocument extraction (async)
- POSTRender document body
- POSTGenerate document from template (async)
- POSTTransform JSON to HTML
- POSTDocument reasoning (async)
- POSTSearch across documents
- GETPDF template document metadata
- POSTCombine PDF documents
Async-result
Communication
Clearinghouse
Diagnostics Ledger
Integration - Snowflake
Integration - Careviso
Integration - Glidian
- GETGet Glidian Payers
- GETGet Glidian Services
- GETGet Glidian Submission Requirements
- POSTCreate Prior Authorization Draft
- GETGet Prior Authorization Record
- PUTUpdate Prior Authorization Record
- GETGet Clinical Questions for Prior Authorization Record
- PUTUpdate Clinical Questions
- POSTSubmit Prior Authorization
Integration - Kno2
Integration - xCures
Integration - Salesforce
Integration - WellSky
Candid Health
Dashboard
Events
Browser Automation
Browser Agents
Database
Python
Copy
from samplehc import SampleHealthcare
client = SampleHealthcare(
api_key="My API Key",
)
response = client.v2.clearinghouse.claim.submit(
billing={},
claim_information={
"benefits_assignment_certification_indicator": "N",
"claim_charge_amount": "321669910225",
"claim_filing_code": "11",
"claim_frequency_code": "1",
"health_care_code_information": [{
"diagnosis_code": "diagnosisCode",
"diagnosis_type_code": "BK",
}],
"place_of_service_code": "01",
"plan_participation_code": "A",
"release_information_code": "I",
"service_lines": [{
"professional_service": {
"composite_diagnosis_code_pointers": {
"diagnosis_code_pointers": ["string"]
},
"line_item_charge_amount": "321669910225",
"measurement_unit": "MJ",
"procedure_code": "procedureCode",
"procedure_identifier": "ER",
"service_unit_count": "serviceUnitCount",
},
"service_date": "73210630",
}],
"signature_indicator": "N",
},
is_testing=True,
receiver={
"organization_name": "x"
},
submitter={
"contact_information": {}
},
subscriber={},
trading_partner_service_id="x",
)
print(response.claim_submission_id)Copy
{
"claimSubmissionId": "<string>",
"patientControlNumber": "<string>"
}Clearinghouse
Submit electronic claim
Submits an electronic claim for processing. The submission is handled asynchronously, and this endpoint returns an identifier to track the status of the claim submission.
POST
/
api
/
v2
/
clearinghouse
/
claim
Python
Copy
from samplehc import SampleHealthcare
client = SampleHealthcare(
api_key="My API Key",
)
response = client.v2.clearinghouse.claim.submit(
billing={},
claim_information={
"benefits_assignment_certification_indicator": "N",
"claim_charge_amount": "321669910225",
"claim_filing_code": "11",
"claim_frequency_code": "1",
"health_care_code_information": [{
"diagnosis_code": "diagnosisCode",
"diagnosis_type_code": "BK",
}],
"place_of_service_code": "01",
"plan_participation_code": "A",
"release_information_code": "I",
"service_lines": [{
"professional_service": {
"composite_diagnosis_code_pointers": {
"diagnosis_code_pointers": ["string"]
},
"line_item_charge_amount": "321669910225",
"measurement_unit": "MJ",
"procedure_code": "procedureCode",
"procedure_identifier": "ER",
"service_unit_count": "serviceUnitCount",
},
"service_date": "73210630",
}],
"signature_indicator": "N",
},
is_testing=True,
receiver={
"organization_name": "x"
},
submitter={
"contact_information": {}
},
subscriber={},
trading_partner_service_id="x",
)
print(response.claim_submission_id)Copy
{
"claimSubmissionId": "<string>",
"patientControlNumber": "<string>"
}Body
application/json
Minimum string length:
1Show child attributes
Show child attributes
Required string length:
1 - 60Required string length:
1 - 60Required string length:
1 - 35Required string length:
1 - 25Required string length:
2 - 80Show child attributes
Show child attributes
Required string length:
2 - 80Available options:
A, B, C, D, E, F, G, H, P, S, T, U Available options:
12, 13, 14, 15, 16, 41, 42, 43, 47 Available options:
M, F, U Show child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Available options:
11, 12, 13, 14, 15, 16, 17, AM, BL, CH, CI, DS, FI, HM, LM, MA, MB, MC, OF, TV, VA, WC, ZZ Available options:
01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 31, 32, 33, 34, 41, 42, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 60, 61, 62, 65, 66, 71, 72, 81, 99 Available options:
1, 7, 8 Available options:
N, Y Available options:
N, W, Y Available options:
I, Y Available options:
A, B, C Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
ER, HC, IV, WK Available options:
MJ, UN Required array length:
1 - 4 elementsRequired string length:
1 - 80Available options:
Y Available options:
Y Available options:
Y Available options:
0 Show child attributes
Show child attributes
Available options:
1, 4, 6 Required array length:
1 - 10 elementsShow child attributes
Show child attributes
claimInformation.serviceLines.serviceLineSupplementalInformation.attachmentReportTypeCode
enum<string>
required
Available options:
03, 04, 05, 06, 07, 08, 09, 10, 11, 13, 15, 21, A3, A4, AM, AS, B2, B3, B4, BR, BS, BT, CB, CK, CT, D2, DA, DB, DG, DJ, DS, EB, HC, HR, I5, IR, LA, M1, MT, NM, OB, OC, OD, OE, OX, OZ, P4, P5, PE, PN, PO, PQ, PY, PZ, RB, RR, RT, RX, SG, V5, XP claimInformation.serviceLines.serviceLineSupplementalInformation.attachmentTransmissionCode
enum<string>
required
Available options:
AA, BM, EL, EM, FT, FX Show child attributes
Show child attributes
claimInformation.serviceLines.ambulanceTransportInformation.ambulanceTransportReasonCode
enum<string>
required
Available options:
A, B, C, D, E Required array length:
1 - 3 elementsShow child attributes
Show child attributes
claimInformation.serviceLines.ambulanceCertification.certificationConditionIndicator
enum<string>
required
Available options:
N, Y Required array length:
1 - 5 elementsAvailable options:
01, 04, 05, 06, 07, 08, 09, 12 Show child attributes
Show child attributes
claimInformation.serviceLines.conditionIndicatorDurableMedicalEquipment.certificationConditionIndicator
enum<string>
required
Available options:
Y, N claimInformation.serviceLines.conditionIndicatorDurableMedicalEquipment.conditionIndicator
enum<string>
required
Available options:
38, ZV claimInformation.serviceLines.conditionIndicatorDurableMedicalEquipment.conditionIndicatorCode
enum<string>
Available options:
38, ZV Show child attributes
Show child attributes
claimInformation.serviceLines.serviceLineDateInformation.certificationRevisionOrRecertificationDate
string
Required array length:
1 - 5 elementsShow child attributes
Show child attributes
claimInformation.serviceLines.testResults.measurementReferenceIdentificationCode
enum<string>
required
Available options:
OG, TR Available options:
HT, R1, R2, R3, R4 Show child attributes
Show child attributes
Available options:
01, 02, 03, 04, 05, 06, 09 Show child attributes
Show child attributes
claimInformation.serviceLines.serviceLineReferenceInformation.repricedLineItemReferenceNumber
string
claimInformation.serviceLines.serviceLineReferenceInformation.adjustedRepricedLineItemReferenceNumber
string
Required array length:
1 - 5 elementsclaimInformation.serviceLines.serviceLineReferenceInformation.clinicalLaboratoryImprovementAmendmentNumber
string
Required array length:
1 - 5 elementsRequired array length:
1 - 10 elementsShow child attributes
Show child attributes
claimInformation.serviceLines.linePricingRepricingInformation.pricingMethodologyCode
enum<string>
required
Available options:
00, 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14 claimInformation.serviceLines.linePricingRepricingInformation.repricingOrganizationIdentifier
string
claimInformation.serviceLines.linePricingRepricingInformation.repricingPerDiemOrFlatRateAmount
string
claimInformation.serviceLines.linePricingRepricingInformation.repricedApprovedAmbulatoryPatientGroupCode
string
claimInformation.serviceLines.linePricingRepricingInformation.repricedApprovedAmbulatoryPatientGroupAmount
string
Available options:
T1, T2, T3, T4, T5, T6 Available options:
1, 2, 3, 4, 5 Available options:
1, 2, 3, 4, 5, 6 Show child attributes
Show child attributes
Available options:
EN, EO, HI, N4, ON, UK, UP Available options:
F2, GR, ME, ML, UN Show child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required array length:
1 - 3 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Required array length:
1 - 15 elementsShow child attributes
Show child attributes
claimInformation.serviceLines.lineAdjudicationInformation.otherPayerPrimaryIdentifier
string
required
Available options:
ER, HC, HP, IV, WK Required array length:
1 - 4 elementsRequired array length:
1 - 5 elementsShow child attributes
Show child attributes
claimInformation.serviceLines.lineAdjudicationInformation.claimAdjustmentInformation.adjustmentGroupCode
enum<string>
required
Available options:
CO, CR, OA, PI, PR claimInformation.serviceLines.lineAdjudicationInformation.claimAdjustmentInformation.adjustmentDetails
object[]
required
Required array length:
1 - 6 elementsShow child attributes
Show child attributes
claimInformation.serviceLines.lineAdjudicationInformation.claimAdjustmentInformation.adjustmentDetails.adjustmentReasonCode
string
required
claimInformation.serviceLines.lineAdjudicationInformation.claimAdjustmentInformation.adjustmentDetails.adjustmentAmount
string
required
claimInformation.serviceLines.lineAdjudicationInformation.claimAdjustmentInformation.adjustmentDetails.adjustmentQuantity
string
Show child attributes
Show child attributes
Available options:
AS, UT Required array length:
1 - 99 elementsShow child attributes
Show child attributes
claimInformation.serviceLines.formIdentification.supportingDocumentation.questionNumber
string
required
claimInformation.serviceLines.formIdentification.supportingDocumentation.questionResponseCode
enum<string>
Available options:
N, W, Y claimInformation.serviceLines.formIdentification.supportingDocumentation.questionResponseAsDate
string
claimInformation.serviceLines.formIdentification.supportingDocumentation.questionResponseAsPercent
string
Required array length:
1 - 2 elementsAvailable options:
AA, EM, OA Available options:
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 15 Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Available options:
00, 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14 claimInformation.claimPricingRepricingInformation.repricedApprovedAmbulatoryPatientGroupAmount
string
Available options:
T1, T2, T3, T4, T5, T6 Available options:
1, 2, 3, 4, 5 Available options:
1, 2, 3, 4, 5, 6 Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required array length:
1 - 3 elementsAvailable options:
Y Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
claimInformation.claimSupplementalInformation.reportInformation.attachmentReportTypeCode
enum<string>
required
Available options:
03, 04, 05, 06, 07, 08, 09, 10, 11, 13, 15, 21, A3, A4, AM, AS, B2, B3, B4, BR, BS, BT, CB, CK, CT, D2, DA, DB, DG, DJ, DS, EB, HC, HR, I5, IR, LA, M1, MT, NM, OB, OC, OD, OE, OX, OZ, P4, P5, PE, PN, PO, PQ, PY, PZ, RB, RR, RT, RX, SG, V5, XP claimInformation.claimSupplementalInformation.reportInformation.attachmentTransmissionCode
enum<string>
required
Available options:
AA, BM, EL, EM, FT, FX Maximum array length:
10Show child attributes
Show child attributes
claimInformation.claimSupplementalInformation.reportInformations.attachmentReportTypeCode
enum<string>
required
Available options:
03, 04, 05, 06, 07, 08, 09, 10, 11, 13, 15, 21, A3, A4, AM, AS, B2, B3, B4, BR, BS, BT, CB, CK, CT, D2, DA, DB, DG, DJ, DS, EB, HC, HR, I5, IR, LA, M1, MT, NM, OB, OC, OD, OE, OX, OZ, P4, P5, PE, PN, PO, PQ, PY, PZ, RB, RR, RT, RX, SG, V5, XP claimInformation.claimSupplementalInformation.reportInformations.attachmentTransmissionCode
enum<string>
required
Available options:
AA, BM, EL, EM, FT, FX Available options:
1, 2, 3, 4, 5, 6, 7 Show child attributes
Show child attributes
Available options:
A, B, C, D, E Show child attributes
Show child attributes
Available options:
A, C, D, E, F, G, M Required array length:
1 - 3 elementsShow child attributes
Show child attributes
Required array length:
1 - 3 elementsShow child attributes
Show child attributes
Available options:
E1, E2, E3 claimInformation.patientConditionInformationVision.certificationConditionIndicator
enum<string>
required
Available options:
N, Y Required array length:
1 - 5 elementsAvailable options:
L1, L2, L3, L4, L5 Show child attributes
Show child attributes
Available options:
01, 02, 03, 04, 05, 06, 09 Available options:
02, 03, 05, 09 Required array length:
1 - 2 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Available options:
A, B, C, D, E, F, G, H, P, S, T, U Available options:
01, 18, 19, 20, 21, 39, 40, 53, G8 Available options:
11, 12, 13, 14, 15, 16, 17, AM, BL, CH, CI, DS, FI, HM, LM, MA, MB, MC, OF, TV, VA, WC, ZZ claimInformation.otherSubscriberInformation.benefitsAssignmentCertificationIndicator
enum<string>
required
Available options:
N, W, Y Available options:
I, Y Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherSubscriberName.otherInsuredQualifier
enum<string>
required
Available options:
1, 2 claimInformation.otherSubscriberInformation.otherSubscriberName.otherInsuredIdentifierTypeCode
enum<string>
required
Available options:
II, MI claimInformation.otherSubscriberInformation.otherSubscriberName.otherInsuredIdentifier
string
required
Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherSubscriberName.otherInsuredAddress.address1
string
required
claimInformation.otherSubscriberInformation.otherSubscriberName.otherInsuredAddress.city
string
required
claimInformation.otherSubscriberInformation.otherSubscriberName.otherInsuredAddress.postalCode
string
claimInformation.otherSubscriberInformation.otherSubscriberName.otherInsuredAddress.countryCode
string
claimInformation.otherSubscriberInformation.otherSubscriberName.otherInsuredAddress.countrySubDivisionCode
string
claimInformation.otherSubscriberInformation.otherSubscriberName.otherInsuredAdditionalIdentifier
string
Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerOrganizationName
string
required
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerIdentifierTypeCode
enum<string>
required
Available options:
PI, XV Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerAddress.address1
string
required
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerAddress.countrySubDivisionCode
string
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerAdjudicationOrPaymentDate
string
Required array length:
1 - 2 elementsShow child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerSecondaryIdentifier.qualifier
string
required
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerSecondaryIdentifier.identifier
string
required
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerSecondaryIdentifier.otherIdentifier
string
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerPriorAuthorizationNumber
string
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerPriorAuthorizationOrReferralNumber
string
claimInformation.otherSubscriberInformation.otherPayerName.otherPayerClaimAdjustmentIndicator
boolean
Available options:
12, 13, 14, 15, 16, 41, 42, 43, 47 Required array length:
1 - 5 elementsShow child attributes
Show child attributes
claimInformation.otherSubscriberInformation.claimLevelAdjustments.adjustmentGroupCode
enum<string>
required
Available options:
CO, CR, OA, PI, PR claimInformation.otherSubscriberInformation.claimLevelAdjustments.adjustmentDetails
object[]
required
Required array length:
1 - 6 elementsShow child attributes
Show child attributes
claimInformation.otherSubscriberInformation.claimLevelAdjustments.adjustmentDetails.adjustmentReasonCode
string
required
claimInformation.otherSubscriberInformation.claimLevelAdjustments.adjustmentDetails.adjustmentAmount
string
required
claimInformation.otherSubscriberInformation.claimLevelAdjustments.adjustmentDetails.adjustmentQuantity
string
Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerReferringProvider.otherPayerReferringProviderIdentifier
object[]
required
Required array length:
1 - 3 elementsShow child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerReferringProvider.otherPayerReferringProviderIdentifier.qualifier
string
required
claimInformation.otherSubscriberInformation.otherPayerReferringProvider.otherPayerReferringProviderIdentifier.identifier
string
required
claimInformation.otherSubscriberInformation.otherPayerReferringProvider.otherPayerReferringProviderIdentifier.otherIdentifier
string
Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerRenderingProvider.entityTypeQualifier
enum<string>
required
Available options:
1, 2 claimInformation.otherSubscriberInformation.otherPayerRenderingProvider.otherPayerRenderingProviderSecondaryIdentifier
object[]
Required array length:
1 - 3 elementsShow child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerRenderingProvider.otherPayerRenderingProviderSecondaryIdentifier.qualifier
string
required
claimInformation.otherSubscriberInformation.otherPayerRenderingProvider.otherPayerRenderingProviderSecondaryIdentifier.identifier
string
required
claimInformation.otherSubscriberInformation.otherPayerRenderingProvider.otherPayerRenderingProviderSecondaryIdentifier.otherIdentifier
string
Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerServiceFacilityLocation.otherPayerServiceFacilityLocationSecondaryIdentifier
object[]
required
Required array length:
1 - 3 elementsShow child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerServiceFacilityLocation.otherPayerServiceFacilityLocationSecondaryIdentifier.qualifier
string
required
claimInformation.otherSubscriberInformation.otherPayerServiceFacilityLocation.otherPayerServiceFacilityLocationSecondaryIdentifier.identifier
string
required
claimInformation.otherSubscriberInformation.otherPayerServiceFacilityLocation.otherPayerServiceFacilityLocationSecondaryIdentifier.otherIdentifier
string
Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerSupervisingProvider.otherPayerSupervisingProviderIdentifier
object[]
required
Required array length:
1 - 3 elementsShow child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerSupervisingProvider.otherPayerSupervisingProviderIdentifier.qualifier
string
required
claimInformation.otherSubscriberInformation.otherPayerSupervisingProvider.otherPayerSupervisingProviderIdentifier.identifier
string
required
claimInformation.otherSubscriberInformation.otherPayerSupervisingProvider.otherPayerSupervisingProviderIdentifier.otherIdentifier
string
Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerBillingProvider.entityTypeQualifier
enum<string>
required
Available options:
1, 2 claimInformation.otherSubscriberInformation.otherPayerBillingProvider.otherPayerBillingProviderIdentifier
object[]
required
Required array length:
1 - 2 elementsShow child attributes
Show child attributes
claimInformation.otherSubscriberInformation.otherPayerBillingProvider.otherPayerBillingProviderIdentifier.qualifier
string
required
claimInformation.otherSubscriberInformation.otherPayerBillingProvider.otherPayerBillingProviderIdentifier.identifier
string
required
claimInformation.otherSubscriberInformation.otherPayerBillingProvider.otherPayerBillingProviderIdentifier.otherIdentifier
string
Show child attributes
Show child attributes
claimInformation.otherSubscriberInformation.medicareOutpatientAdjudication.hcpcsPayableAmount
string
claimInformation.otherSubscriberInformation.medicareOutpatientAdjudication.claimPaymentRemarkCode
string[]
Required array length:
1 - 5 elementsclaimInformation.otherSubscriberInformation.medicareOutpatientAdjudication.endStageRenalDiseasePaymentAmount
string
claimInformation.otherSubscriberInformation.medicareOutpatientAdjudication.nonPayableProfessionalComponentBilledAmount
string
Show child attributes
Show child attributes
Available options:
M, F, U Available options:
01, 19, 20, 21, 39, 40, 53, G8 Required array length:
1 - 2147483647 elementsShow child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Available options:
PI, XV Required string length:
9Available options:
2U, FY, NF Show child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Required string length:
10Show child attributes
Show child attributes
Required string length:
10Response
Claim submission initiated successfully. Returns an ID to track the claim submission.
Claim submission initiated successfully. Returns an ID to track the claim submission.
⌘I