{"basePath":"/v1","definitions":{"AmbulanceCertification":{"properties":{"certificationConditionIndicator":{"description":"The certification condition indicator.","type":"boolean"},"conditionCode1":{"description":"The first condition code.","type":"string"},"conditionCode2":{"description":"The second condition code.","type":"string"},"conditionCode3":{"description":"The third condition code.","type":"string"},"conditionCode4":{"description":"The fourth condition code.","type":"string"},"conditionCode5":{"description":"The fifth condition code.","type":"string"}},"type":"object"},"ClaimAdjustmentGroup":{"properties":{"adjustments":{"description":"A list of adjustments associated with this claim adjustment group.","items":{"properties":{"amount":{"description":"The amount of the adjustment.","type":"string"},"quantity":{"description":"The quantity of the adjustment.","type":"string"},"reasonCode":{"description":"The claim adjustment reason code.","type":"string"}},"type":"object"},"type":"array"},"groupCode":{"description":"The group code of the claim adjustment group.","type":"string"}},"type":"object"},"ErrorResponse":{"properties":{"developerMessage":{"description":"A more technical error message.","type":"string"},"errors":{"description":"A list of detailed user friendly messages.","items":{"$ref":"#/definitions/FieldError"},"type":"array"},"reasonCode":{"description":"A reason code.","type":"integer"},"statusCode":{"description":"The status code.","type":"integer"},"userMessage":{"description":"A high level error message.","type":"string"}},"type":"object"},"FieldError":{"properties":{"code":{"description":"A code for the error.","type":"string"},"errorMessage":{"description":"The message associated with this error.","type":"string"},"field":{"description":"The field or parameter associated with this error.","type":"string"},"index":{"description":"The array index of the item associated with this error.","type":"integer"}},"type":"object"},"ItemDescription":{"properties":{"amount":{"description":"An amount.","type":"string"},"code":{"description":"A code.","type":"string"},"codeType":{"description":"A code type.","type":"string"},"description":{"description":"A description.","type":"string"},"patientLiable":{"description":"Indicates whether the patient is liable for the item.","type":"boolean"},"procedure":{"description":"The procedure.","type":"string"}},"type":"object"},"PhysicalLocation":{"properties":{"addressLine1":{"description":"The address of the physical location.","type":"string"},"addressLine2":{"description":"The address of the physical location.","type":"string"},"city":{"description":"The city of the physical location.","type":"string"},"countryCode":{"description":"The country code of the physical location.","enum":["US","CA"],"type":"string"},"locationName":{"description":"The name of the physical location.","type":"string"},"stateCode":{"description":"The state code of the physical location.","type":"string"},"zipCode":{"description":"The ZIP code of the physical location.","type":"string"}},"type":"object"},"ProfessionalClaim":{"properties":{"billingProvider":{"properties":{"addressLine1":{"description":"The address of the billing provider.","type":"string"},"addressLine2":{"description":"The address of the billing provider.","type":"string"},"city":{"description":"The city of the billing provider.","type":"string"},"contactName":{"description":"The contact name of the billing provider.","type":"string"},"countryCode":{"description":"The country code of the billing provider.","enum":["US","CA"],"type":"string"},"ein":{"description":"The EIN of the billing provider.","type":"string"},"email":{"description":"The email address of the billing provider.","type":"string"},"extension":{"description":"The phone number extension of the billing provider.","type":"string"},"fax":{"description":"The fax number of the billing provider.","type":"string"},"firstName":{"description":"The first name of the billing provider.","type":"string"},"lastName":{"description":"The last or business name of the billing provider.","type":"string"},"locationNumber":{"description":"The location number of the billing provider.","type":"string"},"middleName":{"description":"The middle name of the billing provider.","type":"string"},"npi":{"description":"The national provider id of the billing provider.","type":"string"},"payToAddress":{"description":"The pay to address of the billing provider.","properties":{"addressLine1":{"description":"The address of the pay to address.","type":"string"},"addressLine2":{"description":"The address of the pay to address.","type":"string"},"city":{"description":"The city of the pay to address.","type":"string"},"countryCode":{"description":"The country code of the pay to address.","enum":["US","CA"],"type":"string"},"stateCode":{"description":"The state code of the pay to address.","type":"string"},"zipCode":{"description":"The ZIP code of the pay to address.","type":"string"}},"type":"object"},"payerAssignedProviderId":{"description":"The payer assigned provider id of the billing provider.","type":"string"},"phone":{"description":"The phone number of the billing provider.","type":"string"},"specialtyCode":{"description":"The specialty code of the billing provider.","type":"string"},"ssn":{"description":"The SSN of the billing provider.","type":"string"},"stateCode":{"description":"The state code of the billing provider.","type":"string"},"stateLicenseNumber":{"description":"The state license number of the billing provider.","type":"string"},"suffix":{"description":"The suffix of the billing provider.","type":"string"},"upin":{"description":"The UPIN of the billing provider.","type":"string"},"zipCode":{"description":"The ZIP code of the billing provider.","type":"string"}},"type":"object"},"claimInformation":{"properties":{"accidentCauseCode1":{"description":"The first accident cause code.","type":"string"},"accidentCauseCode2":{"description":"The second accident cause code.","type":"string"},"accidentDate":{"description":"The accident date.","format":"date","type":"string"},"accidentStateCode":{"description":"The accident state code.","type":"string"},"acuteManifestationDate":{"description":"The acute manifestation date.","format":"date","type":"string"},"adjustedRepricedClaimReferenceNumber":{"description":"The adjusted repriced claim reference number.","type":"string"},"admissionDate":{"description":"The admission date.","format":"date","type":"string"},"ambulanceCertifications":{"description":"A list of ambulance certifications.","items":{"$ref":"#/definitions/AmbulanceCertification"},"type":"array"},"ambulanceDropOffLocation":{"$ref":"#/definitions/PhysicalLocation"},"ambulancePickUpLocation":{"$ref":"#/definitions/PhysicalLocation"},"ambulanceTransportDistance":{"description":"The ambulance transport distance.","type":"string"},"ambulanceTransportReasonCode":{"description":"The ambulance transport reason code.","type":"string"},"ambulanceTransportRoundTripPurposeDescription":{"description":"The ambulance transport round trip purpose description.","type":"string"},"ambulanceTransportStretcherPurposeDescription":{"description":"The ambulance transport stretcher purpose description.","type":"string"},"anesthesiaRelatedSurgicalOtherProcedure":{"description":"The other anesthesia related surgical procedure.","type":"string"},"anesthesiaRelatedSurgicalPrincipalProcedure":{"description":"The principal anesthesia related surgical procedure.","type":"string"},"assumedCareDate":{"description":"The assumed care date.","format":"date","type":"string"},"authorizedReturnToWorkDate":{"description":"The authorized to return to work date.","format":"date","type":"string"},"benefitsAssignmentCertification":{"description":"The benefits assignment certification indicator.","type":"string"},"bundled":{"description":"Bundled indicator.","type":"boolean"},"carePlanOversightNumber":{"description":"The care plan oversight number.","type":"string"},"claimIdentifier":{"description":"The claim identifier.","type":"string"},"claimNoteReferenceCode":{"description":"The claim note reference code.","type":"string"},"claimNoteText":{"description":"The claim not text.","type":"string"},"clinicalLaboratoryImprovementAmendmentNumber":{"description":"The clinical laboratory improvement amendment number.","type":"string"},"conditionInformation":{"description":"A list of condition codes.","items":{"properties":{"conditionCode":{"description":"The condition code.","type":"string"}},"type":"object"},"type":"array"},"contractAmount":{"description":"The contract amount.","type":"string"},"contractCode":{"description":"The contract code.","type":"string"},"contractPercentage":{"description":"The contract percentage.","type":"string"},"contractTermsDiscountPercentage":{"description":"The contract terms discount percentage.","type":"string"},"contractTypeCode":{"description":"The contract type code.","type":"string"},"contractVersionIdentifier":{"description":"The contract version identifier.","type":"string"},"controlNumber":{"description":"The control number.","type":"string"},"delayReasonCode":{"description":"The delay reason code.","type":"string"},"demonstrationProjectIdentifier":{"description":"The demonstration project identifier for the claim.","type":"string"},"diagnoses":{"description":"A list of diagnoses.","items":{"properties":{"code":{"description":"The diagnosis code","type":"string"},"qualifier":{"description":"A description of the diagnosis qualifier code.","type":"string"},"qualifierCode":{"description":"The diagnosis qualifier code.","type":"string"}},"type":"object"},"type":"array"},"disabilityPeriodEndDate":{"description":"The disability period end date.","format":"date","type":"string"},"disabilityPeriodStartDate":{"description":"The disability period start date.","format":"date","type":"string"},"dischargeDate":{"description":"The discharge date.","format":"date","type":"string"},"displayMessage":{"description":"A display message from the payer.","type":"string"},"epsdtReferralCertificationConditionCodeAppliesIndicator":{"description":"The EPSDT referral certification condition code applies indicator.","type":"boolean"},"epsdtReferralConditionCode1":{"description":"The first EPSDT referral condition code.","type":"string"},"epsdtReferralConditionCode2":{"description":"The second EPSDT referral condition code.","type":"string"},"epsdtReferralConditionCode3":{"description":"The third EPSDT referral condition code.","type":"string"},"frequencyTypeCode":{"description":"The frequency type code.","type":"string"},"hearingAndVisionPrescriptionDate":{"description":"The hearing and vision prescription date.","format":"date","type":"string"},"homeboundIndicator":{"description":"The homebound indicator.","type":"boolean"},"informationReleaseCode":{"description":"The information release code.","type":"string"},"initialTreatmentDate":{"description":"The initial treatment date.","format":"date","type":"string"},"investigationalDeviceExemptionIdentifier":{"description":"The investigational device exemption identifier.","type":"string"},"lastMenstrualPeriodDate":{"description":"The last menstrual period date.","format":"date","type":"string"},"lastSeenDate":{"description":"The last seen date.","format":"date","type":"string"},"lastWorkedDate":{"description":"The last worked date.","format":"date","type":"string"},"lastXrayDate":{"description":"The last x-ray date.","format":"date","type":"string"},"mammographyCertificationNumber":{"description":"The mammography certification number.","type":"string"},"medicalRecordNumber":{"description":"The medical record number for the claim.","type":"string"},"medicareCrossoverIndicator":{"description":"The medicare crossover indicator.","type":"boolean"},"messages":{"description":"Messages from the payer.","items":{"$ref":"#/definitions/ItemDescription"},"type":"array"},"onsetOfCurrentIllnessOrSymptomDate":{"description":"The onset of current illness or symptom date.","format":"date","type":"string"},"otherPayers":{"description":"A list of other payers involved in this claim.","items":{"properties":{"addressLine1":{"description":"The address of the other payer.","type":"string"},"addressLine2":{"description":"The address of the other payer.","type":"string"},"benefitsAssignmentCertification":{"description":"The benefit assignment certification indicator.","type":"boolean"},"city":{"description":"The city of the other payer.","type":"string"},"claimAdjustmentGroups":{"description":"A list of claim adjustment groups.","items":{"$ref":"#/definitions/ClaimAdjustmentGroup"},"type":"array"},"claimAdjustmentIndicator":{"description":"The claim adjustment indicator.","type":"boolean"},"claimControlNumber":{"description":"The claim control number.","type":"string"},"claimFileIndicatorCode":{"description":"The claim file indicator code of the other payer.","type":"string"},"claimOfficeNumber":{"description":"The claim office number.","type":"string"},"claimPaidDate":{"description":"The date the other payer paid the claim.","format":"date","type":"string"},"countryCode":{"description":"The country code of the other payer.","enum":["US","CA"],"type":"string"},"ein":{"description":"The EIN of the other payer.","type":"string"},"id":{"description":"The id of the other payer.","type":"string"},"informationReleaseCode":{"description":"The information release code.","type":"string"},"insuranceTypeCode":{"description":"The insurance type code of the other payer.","type":"string"},"medicareOutpatientAdjudicationInformation":{"description":"Medicare outpatient adjudication information.","properties":{"claimPaymentRemarkCode1":{"description":"The first claim payment remark code.","type":"string"},"claimPaymentRemarkCode2":{"description":"The second claim payment remark code.","type":"string"},"claimPaymentRemarkCode3":{"description":"The third claim payment remark code.","type":"string"},"claimPaymentRemarkCode4":{"description":"The fourth claim payment remark code.","type":"string"},"claimPaymentRemarkCode5":{"description":"The fifth claim payment remark code.","type":"string"},"endStageRenalDiseasePaymentAmount":{"description":"The end stage renal disease payment amount.","type":"string"},"nonPayableProfessionalComponentBilledAmount":{"description":"The non payable professional component billed amount.","type":"string"},"payableAmount":{"description":"The payable amount.","type":"string"},"reimburseRate":{"description":"The reimbursement rate.","type":"string"}},"type":"object"},"naicCode":{"description":"The NAIC code.","type":"string"},"name":{"description":"The name of the payer.","type":"string"},"nonCoveredAmount":{"description":"The non-covered amount.","type":"string"},"paidAmount":{"description":"The amount paid by the other payer.","type":"string"},"patientSignatureSourceCode":{"description":"The patient signature source code.","type":"string"},"priorAuthorizationNumber":{"description":"The prior authorization number for the other payer.","type":"string"},"referralNumber":{"description":"The referral number for the other payer.","type":"string"},"remainingPatientLiabilityAmount":{"description":"The remaining patient liability.","type":"string"},"responsibilitySequenceCode":{"description":"The responsibility sequence code of the other payer.","enum":["P","S","T"],"type":"string"},"secondaryPayerIdentificationNumber":{"description":"The secondary payer identification number.","type":"string"},"stateCode":{"description":"The state code of the other payer.","type":"string"},"subscriber":{"$ref":"#/definitions/Subscriber"},"subscriberRelationshipCode":{"description":"The relationship to the patient code.","enum":[18,1,19,20,21,39,40,53,"G8",34],"type":"string"},"zipCode":{"description":"The ZIP code of the other payer.","type":"string"}},"type":"object"},"type":"array"},"patientPaidAmount":{"description":"The patient paid amount.","type":"string"},"patientSignatureSourceCode":{"description":"The patient signature source code.","type":"string"},"payerClaimControlNumber":{"description":"The payer claim control number.","type":"string"},"placeOfServiceCode":{"description":"The place of service code.","type":"string"},"primaryCareProvider":{"$ref":"#/definitions/Provider"},"priorAuthorizationNumber":{"description":"The prior authorization number.","type":"string"},"propertyAndCasualtyFirstContactDate":{"description":"The property and casualty first contact date.","format":"date","type":"string"},"providerAcceptAssignmentCode":{"description":"The provider accept assignment code.","type":"string"},"providerSignatureOnFile":{"description":"Indicates whether or not the provider signature is on file.","type":"boolean"},"referralNumber":{"description":"The referral number.","type":"string"},"referringProvider":{"$ref":"#/definitions/Provider"},"relinquishedCareDate":{"description":"The relinquished care date.","format":"date","type":"string"},"renderingProvider":{"$ref":"#/definitions/Provider"},"repricedClaimReferenceNumber":{"description":"The repriced claim reference number.","type":"string"},"repricerReceivedDate":{"description":"The repricer received date.","format":"date","type":"string"},"serviceAuthorizationExceptionCode":{"description":"The service authorization exception code.","type":"string"},"serviceFacility":{"$ref":"#/definitions/Provider"},"serviceLines":{"description":"A list of service lines.","items":{"description":"A service line.","properties":{"additionalInformationLineNote":{"description":"An additional information line note.","type":"string"},"adjudicationInformation":{"description":"Service line adjudication information.","items":{"properties":{"claimAdjustmentGroups":{"description":"A list of claim adjustment groups.","items":{"$ref":"#/definitions/ClaimAdjustmentGroup"},"type":"array"},"claimPaidDate":{"description":"The date the claim was paid.","format":"date","type":"string"},"lineNumber":{"description":"The line numbers.","type":"string"},"modifierCode1":{"description":"The first modifier code.","type":"string"},"modifierCode2":{"description":"The second modifier code.","type":"string"},"modifierCode3":{"description":"The third modifier code.","type":"string"},"modifierCode4":{"description":"The fourth modifier code.","type":"string"},"paidAmount":{"description":"The amount paid.","type":"string"},"payerId":{"description":"The id of the payer.","type":"string"},"procedureCode":{"description":"The procedure code.","type":"string"},"procedureDescription":{"description":"The description of the procedure.","type":"string"},"quantity":{"description":"The quantity.","type":"string"},"remainingPatientLiabilityAmount":{"description":"The remaining patient liability amount.","type":"string"}},"type":"object"},"type":"array"},"adjustedRepricedLineItemReferenceNumber":{"description":"The adjusted repriced line item reference number.","type":"string"},"allowed":{"$ref":"#/definitions/ItemDescription"},"ambulanceCertifications":{"description":"A list of ambulance certifications.","items":{"$ref":"#/definitions/AmbulanceCertification"},"type":"array"},"ambulanceDropOffLocation":{"$ref":"#/definitions/PhysicalLocation"},"ambulancePatientCount":{"description":"The ambulance patient count.","type":"string"},"ambulancePickUpLocation":{"$ref":"#/definitions/PhysicalLocation"},"ambulanceTransportDistance":{"description":"The ambulance transport distance.","type":"string"},"ambulanceTransportReasonCode":{"description":"The ambulance transport reason code.","type":"string"},"ambulanceTransportRoundTripPurposeDescription":{"description":"The ambulance transport round trip purpose description.","type":"string"},"ambulanceTransportStretcherPurposeDescription":{"description":"The ambulance transport stretcher purpose description.","type":"string"},"amount":{"description":"The amount for the service.","type":"string"},"beginTherapyDate":{"description":"The begin therapy date.","format":"date","type":"string"},"bundlingDescription":{"description":"The bundling description for this line.","type":"string"},"certificationRevisionDate":{"description":"The certification revision date.","format":"date","type":"string"},"clinicalLaboratoryImprovementAmendmentNumber":{"description":"The clinical laboratory improvement amendment number.","type":"string"},"coInsurance":{"$ref":"#/definitions/ItemDescription"},"coPay":{"$ref":"#/definitions/ItemDescription"},"contractAmount":{"description":"The contract amount.","type":"string"},"contractCode":{"description":"The contract code.","type":"string"},"contractPercentage":{"description":"The contract percentage.","type":"string"},"contractTermsDiscountPercentage":{"description":"The contract terms discount percentage.","type":"string"},"contractTypeCode":{"description":"The contract type code.","type":"string"},"contractVersionIdentifier":{"description":"The contract version identifier.","type":"string"},"contractual":{"$ref":"#/definitions/ItemDescription"},"controlNumber":{"description":"The control number for the service line.","type":"string"},"copayStatusCode":{"description":"The co-pay status code.","type":"string"},"deductible":{"$ref":"#/definitions/ItemDescription"},"denyReason":{"description":"The deny reason for this line.","type":"string"},"diagnosisCodePointer1":{"description":"A pointer (number) to a diagnosis that this service line was related to.","type":"string"},"diagnosisCodePointer2":{"description":"A pointer (number) to a diagnosis that this service line was related to.","type":"string"},"diagnosisCodePointer3":{"description":"A pointer (number) to a diagnosis that this service line was related to.","type":"string"},"diagnosisCodePointer4":{"description":"A pointer (number) to a diagnosis that this service line was related to.","type":"string"},"displayMessage":{"description":"A display message for this line.","type":"string"},"dmeCertificateOfMedicalNecessityAttachmentTransmissionCode":{"description":"The DME certficate of medical necessity attachment transmission code.","type":"string"},"dmeCertificationConditionCode1":{"description":"The first DME certification condition code.","type":"string"},"dmeCertificationConditionCode2":{"description":"The second DME certification condition code.","type":"string"},"dmeCertificationConditionIndicator":{"description":"The DME certification condition indicator.","type":"boolean"},"dmeCertificationTypeCode":{"description":"The DME certification type code.","type":"string"},"dmeDuration":{"description":"The DME duration.","type":"string"},"dmeFrequencyCode":{"description":"The DME frequency code.","type":"string"},"dmeLengthOfMedicalNecessity":{"description":"The DME length of medical necessity.","type":"string"},"dmeProcedureCode":{"description":"The DME procedure code.","type":"string"},"dmePurchasePrice":{"description":"The DME purchase price.","type":"string"},"dmeRentalPrice":{"description":"The DME rental price.","type":"string"},"emergencyIndicator":{"description":"Indicates whether or not that was an emergency.","type":"boolean"},"epsdtIndicator":{"description":"EPSDT indicator.","type":"boolean"},"estimated":{"$ref":"#/definitions/ItemDescription"},"estimatedPatientResponsibility":{"description":"The estimated patient responsibility for this line.","type":"string"},"familyPlanningIndicator":{"description":"Family planning indicator.","type":"boolean"},"formIdentificationCodes":{"description":"A list of form identification codes.","items":{"properties":{"codeListQualifierCode":{"description":"The code list qualifier code.","type":"string"},"formIdentifier":{"description":"The form identifier.","type":"string"},"supportingDocumentation":{"description":"A list of supporting documentation.","items":{"properties":{"dateResponse":{"description":"The date response","format":"date","type":"string"},"percentResponse":{"description":"The percentage response.","type":"string"},"questionNumber":{"description":"The question number.","type":"string"},"textResponse":{"description":"The text response.","type":"string"},"yesNoResponse":{"description":"Yes or no response indicator.","type":"boolean"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"fromDate":{"description":"The service from date.","format":"date","type":"string"},"goalsRehabilitationPotentialDischargePlansLineNote":{"description":"A goals rehabilitation potential discharge plans line note.","type":"string"},"holdReasons":{"description":"A list of hold reasons for this line.","items":{"$ref":"#/definitions/ItemDescription"},"type":"array"},"hospiceEmployeeIndicator":{"description":"The hospice employee indicator.","type":"boolean"},"immunizationBatchNumber":{"description":"The immunization batch number.","type":"string"},"initialTreatmentDate":{"description":"The initial treatment date.","format":"date","type":"string"},"lastCertificationDate":{"description":"The last certification date.","format":"date","type":"string"},"lastXrayDate":{"description":"The last x-ray date.","format":"date","type":"string"},"latestVisitOrConsultationDate":{"description":"The latest visit or consultation date.","format":"date","type":"string"},"linkSequenceNumber":{"description":"The link sequence number.","type":"string"},"mammographyCertificationNumber":{"description":"The mammography certification number.","type":"string"},"messages":{"description":"A list of messages for this line.","items":{"$ref":"#/definitions/ItemDescription"},"type":"string"},"modifierCode1":{"description":"The first modifier code for the procedure.","type":"string"},"modifierCode2":{"description":"The second modifier code for the procedure.","type":"string"},"modifierCode3":{"description":"The third modifier code for the procedure.","type":"string"},"modifierCode4":{"description":"The fourth modifier code for the procedure.","type":"string"},"mostRecentHemoglobinOrHematocritTestPerformedDate":{"description":"The most recent hemoglobin or hematocrit test performed date.","format":"date","type":"string"},"mostRecentSerumCreatineTestPerformedDate":{"description":"The most recent serum creatine test performed date.","format":"date","type":"string"},"nationalDrugCode":{"description":"The national drug code.","type":"string"},"nationalDrugUnitCodeQualifer":{"description":"The national drug unit code qualifier.","type":"string"},"nationalDrugUnitCount":{"description":"The national drug unit count.","type":"string"},"notCovered":{"$ref":"#/definitions/ItemDescription"},"obstetricAdditionalUnits":{"description":"Obstetric additional units.","type":"string"},"orderingProvider":{"$ref":"#/definitions/Provider"},"pharmacyPrescriptionNumber":{"description":"The pharmacy prescription number.","type":"string"},"placeOfServiceCode":{"description":"The place of service for this service line if different than the overall claim place of service.","type":"string"},"postageClaimedAmount":{"description":"The postage claimed amount.","type":"string"},"prescriptionDate":{"description":"The prescription date.","format":"date","type":"string"},"primaryCareProvider":{"$ref":"#/definitions/Provider"},"priorAuthorizationNumber":{"description":"The prior authorization number.","type":"string"},"procedure":{"description":"The procedure.","type":"string"},"procedureCode":{"description":"The procedure that this service line describes.","type":"string"},"procedureDescription":{"description":"A description of the procedure.","type":"string"},"providerInitiated":{"$ref":"#/definitions/ItemDescription"},"providerResponsibility":{"$ref":"#/definitions/ItemDescription"},"purchasedServiceChargeAmount":{"description":"The purchases service charge amount.","type":"string"},"purchasedServiceProvider":{"$ref":"#/definitions/Provider"},"purchasedServiceProviderIdentifier":{"description":"The purchased service provider identifier.","type":"string"},"quantity":{"description":"The quantity of the service.","type":"string"},"quantityTypeCode":{"description":"The type code of the quantity of the service.","type":"string"},"referralNumber":{"description":"The referral number.","type":"string"},"referringClinicalLaboratoryImprovementAmendmentNumber":{"description":"The referring clinical laboratory improvement amendment number.","type":"string"},"referringProvider":{"$ref":"#/definitions/Provider"},"remarks":{"description":"A list of remarks for this line.","items":{"properties":{"description":{"description":"The description.","type":"string"},"remarkCode":{"description":"The remark code.","type":"string"}},"type":"object"},"type":"array"},"renderingProvider":{"$ref":"#/definitions/Provider"},"repricedLineItemReferenceNumber":{"description":"The repriced line item reference number.","type":"string"},"salesTaxAmount":{"description":"The sales tax amount.","type":"string"},"serviceFacility":{"$ref":"#/definitions/Provider"},"shippedDate":{"description":"The shipped date.","format":"date","type":"string"},"supervisingProvider":{"$ref":"#/definitions/Provider"},"supplementalInformation":{"description":"A list of supplemental information (attachments) for this service line","items":{"$ref":"#/definitions/SupplementalInformation"},"type":"array"},"testResults":{"description":"A list of test results.","items":{"properties":{"qualifier":{"description":"The qualifier.","type":"string"},"referenceIdCode":{"description":"The reference id code.","type":"string"},"value":{"description":"The value.","type":"string"}},"type":"object"},"type":"array"},"thirdPartyOrganizationNote":{"description":"A third party organization note.","type":"string"},"toDate":{"description":"The service to date.","format":"date","type":"string"}},"type":"object"},"type":"array"},"serviceTypeCode":{"description":"The service type code.","type":"string"},"specialProgramCode":{"description":"The special program code.","type":"string"},"spinalManipulationServicePatientConditionCode":{"description":"The splinal manipulation service patient condition code.","type":"string"},"spinalManipulationServicePatientConditionDescription1":{"description":"The first spinal manipulation service patient condition description.","type":"string"},"spinalManipulationServicePatientConditionDescription2":{"description":"The second spinal manipulation service patient condition description.","type":"string"},"supervisingProvider":{"$ref":"#/definitions/Provider"},"supplementalInformation":{"description":"A list of supplemental information (attachments) for the claim.","items":{"$ref":"#/definitions/SupplementalInformation"},"type":"array"},"totalAllowed":{"$ref":"#/definitions/ItemDescription"},"totalCharges":{"$ref":"#/definitions/ItemDescription"},"totalCoInsurance":{"$ref":"#/definitions/ItemDescription"},"totalCoPay":{"$ref":"#/definitions/ItemDescription"},"totalContractual":{"$ref":"#/definitions/ItemDescription"},"totalDeductible":{"$ref":"#/definitions/ItemDescription"},"totalEstimated":{"$ref":"#/definitions/ItemDescription"},"totalNotCovered":{"$ref":"#/definitions/ItemDescription"},"totalPatientLiability":{"$ref":"#/definitions/ItemDescription"},"totalProviderInitiated":{"$ref":"#/definitions/ItemDescription"},"totalProviderResponsibility":{"$ref":"#/definitions/ItemDescription"},"visionConditions":{"description":"A list of vision conditions.","items":{"properties":{"certificationConditionIndicator":{"description":"The certification condition indicator.","type":"boolean"},"codeCategory":{"description":"The code category.","type":"string"},"conditionCode1":{"description":"The first condition code.","type":"string"},"conditionCode2":{"description":"The second condition code.","type":"string"},"conditionCode3":{"description":"The third condition code.","type":"string"},"conditionCode4":{"description":"The fourth condition code.","type":"string"},"conditionCode5":{"description":"The fifth condition code.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"createdDate":{"description":"The date and time when the professional claim was created.","format":"date-time","type":"string"},"customerId":{"description":"The id of the customer that owns this professional claim.","type":"string"},"expirationDate":{"description":"The date and time when the professional claim will expire from our system.","format":"date-time","type":"string"},"id":{"description":"The id of the professional claim.","type":"string"},"message":{"description":"A message about the claim.","type":"string"},"patient":{"properties":{"addressLine1":{"description":"The address of the patient.","type":"string"},"addressLine2":{"description":"The address of the patient.","type":"string"},"agencyClaimNumber":{"description":"The agency claim number of the patient.","type":"string"},"birthDate":{"description":"The birth date of the patient.","format":"date","type":"string"},"city":{"description":"The city of the patient.","type":"string"},"contactName":{"description":"The contact name of the patient.","type":"string"},"countryCode":{"description":"The country code of the patient.","enum":["US","CA"],"type":"string"},"deathDate":{"description":"The death date of the patient.","format":"date","type":"string"},"extension":{"description":"The phone number extension of the patient.","type":"string"},"firstName":{"description":"The first name of the patient.","type":"string"},"gender":{"description":"The gender of the patient.","enum":["Female","Male","Unknown"],"type":"string"},"genderCode":{"description":"The gender code of the patient.","enum":["F","M","U"],"type":"string"},"lastName":{"description":"The last name of the patient.","type":"string"},"middleName":{"description":"The middle name of the patient.","type":"string"},"phone":{"description":"The phone number of the patient.","type":"string"},"pregnancyIndicator":{"description":"Indicates whether or not the patient is pregnant.","type":"boolean"},"ssn":{"description":"The SSN of the patient.","type":"string"},"stateCode":{"description":"The state code of the patient.","type":"string"},"subscriberRelationship":{"description":"The relationship of the patient to the subscriber.","enum":["Self","Spouse","Child","Employee","Unknown","Organ Donor","Cadaver Donor","Life Partner","Other Relationship","Other Adult"],"type":"string"},"subscriberRelationshipCode":{"description":"The relationship code of the patient to the subscriber.","enum":[18,1,19,20,21,39,40,53,"G8",34],"type":"string"},"suffix":{"description":"The suffix of the patient.","type":"string"},"weight":{"description":"The weight of the patient.","type":"string"},"zipCode":{"description":"The ZIP code of the patient.","type":"string"}},"type":"object"},"payer":{"properties":{"addressLine1":{"description":"The address of the payer.","type":"string"},"addressLine2":{"description":"The address of the payer.","type":"string"},"city":{"description":"The city of the payer.","type":"string"},"claimFilingIndicatorCode":{"description":"The claim filing indicator code of the payer.","type":"string"},"claimOfficeNumber":{"description":"The claim office number of the payer.","type":"string"},"countryCode":{"description":"The country code of the payer.","enum":["US","CA"],"type":"string"},"disclaimer":{"description":"A disclaimer from the payer.","type":"string"},"ein":{"description":"The EIN of the payer.","type":"string"},"id":{"description":"The id of the payer.","type":"string"},"insuranceTypeCode":{"description":"The insurance type code of the payer.","type":"string"},"naicCode":{"description":"The NAIC code of the payer.","type":"string"},"name":{"description":"The name of the payer.","type":"string"},"responsibilitySequenceCode":{"description":"The responsibility sequence code of the payer.","enum":["P","S","T"],"type":"string"},"stateCode":{"description":"The state code of the payer.","type":"string"},"zipCode":{"description":"The ZIP code of the payer.","type":"string"}},"type":"object"},"payerSpecificFlags":{"items":{"properties":{"name":{"description":"A payer specific flag name.","type":"string"},"value":{"description":"A payer specific flag value.","type":"string"}},"type":"object"},"type":"array"},"requestTypeCode":{"description":"The type of professional claim.","enum":["PRE_DETERMINATION"],"type":"string"},"submitter":{"properties":{"contactName":{"description":"The contact name of the submitter.","type":"string"},"email":{"description":"The email address of the submitter.","type":"string"},"extension":{"description":"The phone number extension of the submitter.","type":"string"},"fax":{"description":"The fax number of the submitter.","type":"string"},"firstName":{"description":"The first name of the submitter.","type":"string"},"id":{"description":"The id of the submitter.","type":"string"},"lastName":{"description":"The last or business name of the submitter.","type":"string"},"middleName":{"description":"The middle name of the submitter.","type":"string"},"phone":{"description":"The phone number of the submitter.","type":"string"}},"type":"object"},"subscriber":{"$ref":"#/definitions/Subscriber"},"updatedDate":{"description":"The date and time when the professional claim was last updated.","format":"date-time","type":"string"}},"type":"object"},"Provider":{"properties":{"addressLine1":{"description":"The provider's address.","type":"string"},"addressLine2":{"description":"The provider's address.","type":"string"},"city":{"description":"The provider's city.","type":"string"},"contactName":{"description":"The provider's contact name.","type":"string"},"countryCode":{"description":"The provider's country code.","enum":["US","CA"],"type":"string"},"email":{"description":"The provider's email address.","type":"string"},"extension":{"description":"The provider's phone number extension.","type":"string"},"fax":{"description":"The provider's fax number.","type":"string"},"firstName":{"description":"The provider's first name.","type":"string"},"lastName":{"description":"The provider's last or business name.","type":"string"},"locationNumber":{"description":"The provider's location number.","type":"string"},"middleName":{"description":"The provider's middle name.","type":"string"},"npi":{"description":"The provider's national provider id.","type":"string"},"payerAssignedProviderId":{"description":"The provider's payer assigned provider id.","type":"string"},"phone":{"description":"The provider's phone number.","type":"string"},"specialtyCode":{"description":"The provider's specialty code.","type":"string"},"stateCode":{"description":"The provider's state code.","type":"string"},"stateLicenseNumber":{"description":"The provider's state license number.","type":"string"},"suffix":{"description":"The provider's suffix.","type":"string"},"upin":{"description":"The provider's UPIN.","type":"string"},"zipCode":{"description":"The provider's ZIP code.","type":"string"}},"type":"object"},"Subscriber":{"properties":{"accumulatedDeductible":{"description":"The accumulated deductible of the subscriber.","type":"string"},"addressLine1":{"description":"The address of the subscriber.","type":"string"},"addressLine2":{"description":"The address of the subscriber.","type":"string"},"city":{"description":"The city of the subscriber.","type":"string"},"countryCode":{"description":"The country code of the subscriber.","enum":["US","CA"],"type":"string"},"firstName":{"description":"The first name of the subscriber.","type":"string"},"groupName":{"description":"The group name of the subscriber.","type":"string"},"groupNumber":{"description":"The group number of the subscriber.","type":"string"},"holdReasons":{"description":"Subscriber hold reasons.","items":{"$ref":"#/definitions/ItemDescription"},"type":"array"},"lastName":{"description":"The last name of the subscriber.","type":"string"},"memberId":{"description":"The member id of the subscriber.","type":"string"},"middleName":{"description":"The middle name of the subscriber.","type":"string"},"onHold":{"description":"Indicates whether or not the subscriber is on hold.","type":"boolean"},"remainingDeductible":{"description":"The remaining deductible of the subscriber.","type":"string"},"ssn":{"description":"The SSN of the subscriber.","type":"string"},"stateCode":{"description":"The state code of the subscriber.","type":"string"},"suffix":{"description":"The suffix of the subscriber.","type":"string"},"totalDeductible":{"description":"The total deductible of the subscriber.","type":"string"},"zipCode":{"description":"The ZIP code of the subscriber.","type":"string"}},"type":"object"},"SupplementalInformation":{"properties":{"controlNumber":{"description":"The control number of the supplemental information.","type":"string"},"reportTransmissionCode":{"description":"The report transmission code of the supplemental information.","type":"string"},"reportTypeCode":{"description":"The report type code of the supplemental information.","type":"string"}},"type":"object"}},"host":"api.availity.com","info":{"description":"The Availity Patient Cost Estimator – Professional 1.0.0 API is designed to help healthcare providers estimate the cost of professional medical services before they are rendered. This supports transparency and helps patients understand their financial responsibility upfront.","title":"Patient Cost Estimator 1.0.0 - Professional","version":"1.0.0","x-custom-api-description":"The Availity Patient Cost Estimator – Professional 1.0.0 API is designed to help healthcare providers estimate the cost of professional medical services before they are rendered. This supports transparency and helps patients understand their financial responsibility upfront."},"paths":{"/professional-claims":{"post":{"consumes":["application/json","application/xml"],"operationId":"createProfessionalClaim","parameters":[{"in":"body","name":"professionalclaim","schema":{"$ref":"#/definitions/ProfessionalClaim"}}],"produces":["application/json","application/xml"],"responses":{"202":{"description":"Accepted","headers":{"Location":{"description":"Location of the professional claim.","type":"string"},"X-Status-Message":{"description":"Current status of the pending request.","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Not Authorized","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResponse"}}},"summary":"Create a new professional claims."}},"/professional-claims/{id}":{"get":{"operationId":"getProfessionalClaim","parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"produces":["application/json","application/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ProfessionalClaim"}},"202":{"description":"Accepted","headers":{"Location":{"description":"Location of the professional claim.","type":"string"},"X-Status-Message":{"description":"Current status of the pending request.","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Not Authorized","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Not Found","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResponse"}},"504":{"description":"Gateway Timeout","schema":{"$ref":"#/definitions/ErrorResponse"}}},"summary":"Get a professional claim by its id."},"parameters":[{"description":"A professional claim id","in":"path","name":"id","required":true,"type":"string"}]}},"schemes":["https"],"security":[{"oauth2":["hipaa"]}],"securityDefinitions":{"oauth2":{"description":"","flow":"application","scopes":{"healthcare-hipaa-transactions":"Healthcare HIPAA Transactions","healthcare-hipaa-transactions-demo":"Demo","healthcare-hipaa-transactions-highvolume":"Healthcare HIPAA Transactions High Volume","healthcare-hipaa-transactions-highvolume-standard":"Standard","healthcare-hipaa-transactions-highvolume-unlimited":"Unlimited","healthcare-hipaa-transactions-standard":"Standard"},"tokenUrl":"https://api.availity.com/v1/token","type":"oauth2"}},"swagger":"2.0"}