{"basePath":"/v2/patient-cost-estimates/prof","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 from the X12 CARC list.","type":"string"},"reasonCodeDescription":{"description":"Human-readable description of the claim adjustment reason code from the X12 CARC list.","type":"string"}},"type":"object"},"type":"array"},"groupCode":{"description":"The group code of the claim adjustment group.","enum":["CO","PR","OA","PI","CR"],"type":"string"},"groupCodeDescription":{"description":"Human-readable description of the group code (e.g., 'Contractual Obligation', 'Patient Responsibility').","type":"string"}},"type":"object"},"CoveragePlanCandidates":{"properties":{"error":{"properties":{"code":{"description":"The Availity code associated with the error.","type":"string"},"developerMessage":{"description":"A technical explanation of the error with guidance for resolution.","type":"string"},"groupName":{"description":"The group name of the subscriber.","type":"string"},"groupNumber":{"description":"The group number of the subscriber.","type":"string"},"message":{"description":"A high level message associated with the error.","type":"string"}},"type":"object"}},"type":"object"},"ErrorResponse":{"properties":{"candidates":{"description":"A list of coverage plans evaluated for the member that were not eligible for predetermination, with per-plan error details explaining the reason for rejection.","items":{"$ref":"#/definitions/CoveragePlanCandidates"},"type":"array"},"errors":{"description":"A list of detailed user friendly messages.","items":{"properties":{"actionable":{"description":"Indicates whether the consumer can take action to fix the issue (e.g., correct data and resubmit).","type":"boolean"},"code":{"description":"The Availity code associated with the error (e.g., PCE-5010, PCE-5011, PCE-5012).","type":"string"},"developerMessage":{"description":"A technical explanation of the error with guidance for resolution.","type":"string"},"groupName":{"description":"The group name of the subscriber.","type":"string"},"groupNumber":{"description":"The group number of the subscriber.","type":"string"},"message":{"description":"A high level message associated with the error.","type":"string"},"payerMessage":{"description":"The payer's original error message explaining why the request was rejected or could not be processed. Present when the error originates from the payer.","type":"string"},"retryable":{"description":"Indicates whether the request may succeed if retried later without changes.","type":"boolean"}},"type":"object"},"type":"array"},"id":{"description":"The location ID for the professional predetermination.","type":"string"}},"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"},"PollingResponse":{"properties":{"id":{"description":"UUID generated for tracking.","type":"string"},"stage":{"description":"The stage of processing the service is at within the Availity system. Stages are: configuring, submitting-coverage, awaiting-coverage, selecting-plan, submitting-claim, awaiting-claim.","type":"string"}},"type":"object"},"ProfessionalClaimBase":{"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"},"networkStatus":{"description":"The network status 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"},"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 note text.","type":"string"},"claimNumber":{"description":"The claim number.","type":"string"},"claimTotalCharges":{"$ref":"#/definitions/ItemDescription"},"claimTotalEstimated":{"$ref":"#/definitions/ItemDescription"},"claimTotalPatientLiability":{"$ref":"#/definitions/ItemDescription"},"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":"string"},"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"},"claimFilingIndicatorCode":{"description":"The claim filing 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 certificate 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"},"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.","properties":{"amount":{"description":"The estimated patient responsibility amount.","type":"string"}},"type":"object"},"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"},"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":"array"},"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"},"patientHeight":{"description":"The height of the patient.","type":"string"},"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"},"priorAuthRequired":{"description":"Indicates whether prior authorization is required.","type":"boolean"},"priorAuthVendorInfo":{"description":"The prior authorization vendor information.","type":"string"},"priorAuthorizationNumber":{"description":"The prior authorization number.","type":"string"},"priorAuthorizationOtherPayerId":{"description":"The prior authorization other payer id.","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 purchased 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"},"thirdPartyOrganizationNote":{"description":"A third party organization note.","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 spinal 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"},"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"},"subscriber":{"$ref":"#/definitions/Subscriber"}},"type":"object"},"ProfessionalPCERequest":{"allOf":[{"properties":{"coverageId":{"description":"The id of the eligibility verification call for the member.","type":"string"},"payerId":{"description":"The id of the payer.","type":"string"}},"type":"object"},{"$ref":"#/definitions/ProfessionalClaimBase"}]},"ProfessionalPCEResponse":{"properties":{"createdDt":{"description":"The date and time when the professional predetermination was created.","format":"date-time","type":"string"},"error":{"properties":{"schema":{"$ref":"#/definitions/ErrorResponse"}},"type":"object"},"id":{"description":"The id of the professional predetermination.","type":"string"},"result":{"allOf":[{"properties":{"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"}},"type":"object"},{"$ref":"#/definitions/ProfessionalClaimBase"}]}},"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 2.0.0 API validates and queues a predetermination request for asynchronous processing through a multi-stage pipeline that handles health plan configuration validation and payer submission.","title":"Patient Cost Estimator 2.0.0 - Professional","version":"2.0.0","x-custom-api-description":"The Availity Patient Cost Estimator – Professional 2.0.0 API validates and queues a predetermination request for asynchronous processing through a multi-stage pipeline that handles health plan configuration validation and payer submission."},"paths":{"/":{"post":{"consumes":["application/json"],"operationId":"submitProfPredetermination","parameters":[{"in":"body","name":"professionalclaim","schema":{"$ref":"#/definitions/ProfessionalPCERequest"}}],"produces":["application/json"],"responses":{"202":{"description":"Accepted","headers":{"Location":{"description":"Location of the submitted 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"}},"422":{"description":"Unprocessable Content","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResponse"}}},"summary":"Submits a professional predetermination request to an async pipeline, which orchestrates request validation and multi-stage processing"}},"/{id}":{"get":{"operationId":"getProfessionalClaim","parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ProfessionalPCEResponse"}},"202":{"description":"Accepted","headers":{"Location":{"description":"Location of the submitted professional claim.","type":"string"},"X-Status-Message":{"description":"Current status of the pending request.","type":"string"}},"schema":{"$ref":"#/definitions/PollingResponse"}},"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"}},"422":{"description":"Unprocessable Content — The payer rejected this predetermination request. See payerMessage for details.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResponse"}},"502":{"description":"Bad Gateway — Infrastructure failure communicating with upstream services.","schema":{"$ref":"#/definitions/ErrorResponse"}},"503":{"description":"Service Unavailable — The payer returned a transient error. Retry later.","schema":{"$ref":"#/definitions/ErrorResponse"}},"504":{"description":"Gateway Timeout — The payer system is unavailable or did not respond in time.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"summary":"Polls for the status and result of a previously submitted professional predetermination request"},"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"}