{"basePath":"/v1","definitions":{"AdjudicationInformation":{"properties":{"claimAdjustmentGroups":{"description":"Claim line adjustments.","items":{"$ref":"#/definitions/AdjustmentGroup"},"type":"array"},"claimPaidDate":{"description":"The claim paid date.","format":"date","type":"string"},"lineNumber":{"description":"The line number.","type":"string"},"modifierCode1":{"description":"A procedure modifier.","type":"string"},"modifierCode2":{"description":"A procedure modifier.","type":"string"},"modifierCode3":{"description":"A procedure modifier.","type":"string"},"modifierCode4":{"description":"A procedure modifier.","type":"string"},"paidAmount":{"description":"The amount this payer paid.","type":"string"},"payerId":{"description":"The payer id for this adjudication information.","type":"string"},"procedureCode":{"description":"The procedure performed.","type":"string"},"procedureDescription":{"description":"A procedure description.","type":"string"},"quantity":{"description":"The quantity.","type":"string"},"remainingPatientLiabilityAmount":{"description":"The remaining patient liability amount.","type":"string"}},"type":"object"},"Adjustment":{"properties":{"amount":{"description":"The adjustment amount.","type":"string"},"quantity":{"description":"The adjustment quantity.","type":"string"},"reasonCode":{"description":"The adjustment reason code.","type":"string"}},"type":"object"},"AdjustmentGroup":{"properties":{"adjustments":{"description":"A list of adjustments to this claim.","items":{"$ref":"#/definitions/Adjustment"},"type":"array"},"groupCode":{"description":"The adjustment group.","type":"string"}},"type":"object"},"BillingProvider":{"properties":{"addressLine1":{"description":"The billing provider's address (line one).","type":"string"},"addressLine2":{"description":"The billing provider's address (line two).","type":"string"},"city":{"description":"The billing provider's city.","type":"string"},"contactName":{"description":"The billing provider's contact name.","type":"string"},"countryCode":{"description":"The billing provider's country code (US or CA).","type":"string"},"ein":{"description":"The billing provider's EIN.","type":"string"},"email":{"description":"The billing provider's email address.","type":"string"},"extension":{"description":"The billing provider's phone extension.","type":"string"},"fax":{"description":"The billing provider's fax number.","type":"string"},"firstName":{"description":"The billing provider's first name.","type":"string"},"lastName":{"description":"The billing provider's last name or organization name.","type":"string"},"locationNumber":{"description":"The billing provider's location number.","type":"string"},"middleName":{"description":"The billing provider's middle name.","type":"string"},"npi":{"description":"The billing provider's NPI.","type":"string"},"payTo":{"description":"The billing provider's pay-to address (if different from their physical address).","properties":{"addressLine1":{"description":"The billing provider's pay-to address (line one).","type":"string"},"addressLine2":{"description":"The billing provider's pay-to address (line two).","type":"string"},"city":{"description":"The billing provider's pay-to city.","type":"string"},"countryCode":{"description":"The billing provider's country code (US or CA).","type":"string"},"stateCode":{"description":"The billing provider's pay-to state (two character code).","type":"string"},"zipCode":{"description":"The billing provider's ZIP code.","type":"string"}},"type":"object"},"payerAssignedProviderId":{"description":"The billing provider's payer assigned provider id.","type":"string"},"phone":{"description":"The billing provider's phone number.","type":"string"},"specialtyCode":{"description":"The billing provider's specialty type code.","type":"string"},"ssn":{"description":"The billing provider's SSN.","type":"string"},"stateCode":{"description":"The billing provider's state (two character code).","type":"string"},"stateLicenseNumber":{"description":"The billing provider's state license number.","type":"string"},"suffix":{"description":"The billing provider's suffix.","type":"string"},"upin":{"description":"The billing provider's UPIN.","type":"string"},"zipCode":{"description":"The billing provider's ZIP code.","type":"string"}},"type":"object"},"ClaimInformation":{"properties":{"accidentCauseCode1":{"description":"Related/accident cause code.","type":"string"},"accidentCauseCode2":{"description":"Related/accident cause code.","type":"string"},"accidentDate":{"description":"The date the accident occurred on.","format":"date","type":"string"},"accidentStateCode":{"description":"The state the accident happened in.","type":"string"},"appliancePlacementDate":{"description":"The date the appliance was placed.","type":"string"},"assistantSurgeon":{"$ref":"#/definitions/Provider"},"benefitsAssignmentCertification":{"description":"The benefits assignment certification indicator.","type":"boolean"},"claimIdentifier":{"description":"Trace number for this claim.","type":"string"},"contractAmount":{"description":"The contracted amount.","type":"string"},"contractCode":{"description":"The contract code.","type":"string"},"contractPercentage":{"description":"The contracted percentage.","type":"string"},"contractTermsDiscountPercentage":{"description":"The contract terms discount percentage.","type":"string"},"contractTypeCode":{"description":"The type of contract.","type":"string"},"contractVersion":{"description":"The contract version.","type":"string"},"controlNumber":{"description":"A control number of patient account number to use on this claim.","type":"string"},"delayReasonCode":{"description":"The delay reason.","type":"string"},"diagnoses":{"description":"Diagnoses related to this claim.","items":{"$ref":"#/definitions/Diagnosis"},"type":"array"},"frequencyTypeCode":{"description":"The claim frequency type.","type":"string"},"informationReleaseCode":{"description":"The release of information code.","type":"string"},"notes":{"description":"Notes about this claim.","items":{"$ref":"#/definitions/Note"},"type":"array"},"orthodonticClaim":{"description":"Indicate whether or not this was an orthodontic claim.","type":"boolean"},"orthodonticTreatmentMonths":{"description":"The estimated number of orthodontic treatment months.","type":"string"},"orthodonticTreatmentRemainingMonths":{"description":"The number of orthodontic treatment months remaining.","type":"string"},"otherPayers":{"description":"Information about other payers.","items":{"$ref":"#/definitions/OtherPayer"},"type":"array"},"patientPaidAmount":{"description":"The amount the patient has paid.","type":"string"},"payerClaimControlNumber":{"description":"The payer claim control number for this claim.","type":"string"},"placeOfServiceCode":{"description":"The place of service type.","type":"string"},"primaryCareProvider":{"$ref":"#/definitions/Provider"},"priorAuthorizationNumber":{"description":"The prior authorization number for this claim.","type":"string"},"providerAcceptAssignmentCode":{"description":"Assignment or plan participation code.","type":"string"},"providerSignatureOnFile":{"description":"Indicate whether or not the provider's signature is on file.","type":"boolean"},"referringProvider":{"$ref":"#/definitions/Provider"},"renderingProvider":{"$ref":"#/definitions/Provider"},"serviceAuthorizationExceptionCode":{"description":"The service authorization exception code for this claim.","type":"string"},"serviceFacility":{"$ref":"#/definitions/Provider"},"serviceFromDate":{"description":"The service date (begin).","format":"date","type":"string"},"serviceLines":{"description":"Information about the services performed.","items":{"$ref":"#/definitions/ServiceLine"},"type":"array"},"serviceToDate":{"description":"The service date (end).","format":"date","type":"string"},"specialProgramCode":{"description":"The special dental program.","type":"string"},"supervisingProvider":{"$ref":"#/definitions/Provider"},"supplementalInformation":{"description":"Supplemental information (additional paperwork).","items":{"$ref":"#/definitions/SupplementalInformation"},"type":"array"},"toothStatuses":{"description":"Status information about teeth.","items":{"$ref":"#/definitions/ToothStatus"},"type":"array"}},"type":"object"},"DentalClaim":{"properties":{"billingProvider":{"$ref":"#/definitions/BillingProvider"},"claimInformation":{"$ref":"#/definitions/ClaimInformation"},"createdDate":{"description":"The date and time when this dental claim was created in our system.","format":"date-time","type":"string"},"customerId":{"description":"The id of the customer that owns this dental claim.","type":"string"},"expirationDate":{"description":"The date and time when this dental claim will expire from our system.","format":"date-time","type":"string"},"id":{"description":"The id of the dental claim.","type":"string"},"message":{"description":"A message.","type":"string"},"patient":{"$ref":"#/definitions/Patient"},"payer":{"$ref":"#/definitions/Payer"},"requestTypeCode":{"description":"The requested type of claim. CLAIM, ENCOUNTER, etc.","type":"string"},"submitter":{"$ref":"#/definitions/Submitter"},"subscriber":{"$ref":"#/definitions/Subscriber"},"updatedDate":{"description":"The date and time when this dental claim was last updated in our system.","format":"date-time","type":"string"}},"type":"object"},"Diagnosis":{"properties":{"code":{"description":"The code for this diagnosis.","type":"string"},"qualifierCode":{"description":"The qualifier for this diagnosis.","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"},"Note":{"properties":{"message":{"description":"A message about this claim.","type":"string"}},"type":"object"},"OtherPayer":{"properties":{"addressLine1":{"description":"This payer's address (line one).","type":"string"},"addressLine2":{"description":"This payer's address (line two).","type":"string"},"benefitsAssignmentCertification":{"description":"The benefits assignment certification indicator for this payer.","type":"boolean"},"city":{"description":"This payer's city.","type":"string"},"claimAdjustmentGroups":{"description":"Claim level adjustments for this payer.","items":{"$ref":"#/definitions/AdjustmentGroup"},"type":"array"},"claimControlNumber":{"description":"This payer's claim control number.","type":"string"},"claimFilingIndicatorCode":{"description":"The claim filing indicator code of this payer.","type":"string"},"claimOfficeNumber":{"description":"This payer's claim office number.","type":"string"},"claimPaidDate":{"description":"The date this payer paid the claim.","format":"date","type":"string"},"countryCode":{"description":"This payer's country (US or CA).","type":"string"},"ein":{"description":"This payer's EIN.","type":"string"},"id":{"description":"The id of this payer.","type":"string"},"informationReleaseCode":{"description":"The information release code for this payer.","type":"string"},"insuranceTypeCode":{"description":"The insurance type of this payer.","type":"string"},"medicareOutpatientAdjudicationInformation":{"description":"Information about medicare outpatient adjudication.","properties":{"claimPaymentRemarkCode1":{"description":"A medicare outpatient adjudication claim remark code.","type":"string"},"claimPaymentRemarkCode2":{"description":"A medicare outpatient adjudication claim remark code.","type":"string"},"claimPaymentRemarkCode3":{"description":"A medicare outpatient adjudication claim remark code.","type":"string"},"claimPaymentRemarkCode4":{"description":"A medicare outpatient adjudication claim remark code.","type":"string"},"claimPaymentRemarkCode5":{"description":"A medicare outpatient adjudication claim remark code.","type":"string"},"nonPayableProfessionalComponentBilledAmount":{"description":"The medicare outpatient adjudication non-payable professional component billed amount.","type":"string"},"payableAmount":{"description":"The medicare outpatient adjudication payable amount.","type":"string"},"reimburseRate":{"description":"The medicare outpatient adjudication reimburse rate.","type":"string"}},"type":"object"},"naicCode":{"description":"This payer's NAIC.","type":"string"},"name":{"description":"The name of this payer.","type":"string"},"nonCoveredAmount":{"description":"The amount that this payer did not cover.","type":"string"},"paidAmount":{"description":"The amount paid by this payer.","type":"string"},"priorAuthorizationNumber":{"description":"The prior authorization number assigned by this payer.","type":"string"},"referralNumber":{"description":"The referral number assigned by this payer.","type":"string"},"remainingPatientLiabilityAmount":{"description":"The remaining patient liability.","type":"string"},"responsibilitySequenceCode":{"description":"The responsibility sequence of this payer (P, S, or T).","type":"string"},"stateCode":{"description":"This payer's state (two character code).","type":"string"},"subscriber":{"$ref":"#/definitions/Subscriber"},"subscriberRelationshipCode":{"description":"The patient's relationship to this payer's subscriber.","type":"string"},"zipCode":{"description":"This payer's ZIP code.","type":"string"}},"type":"object"},"Patient":{"properties":{"addressLine1":{"description":"The patient's address (line one).","type":"string"},"addressLine2":{"description":"The patient's address (line two).","type":"string"},"agencyClaimNumber":{"description":"The patient's agency claim number.","type":"string"},"birthDate":{"description":"The patient's birth date.","format":"date","type":"string"},"city":{"description":"The patient's city.","type":"string"},"countryCode":{"description":"The patient's country (US or CA).","type":"string"},"firstName":{"description":"The patient's first name.","type":"string"},"genderCode":{"description":"The patient's gender.","type":"string"},"lastName":{"description":"The patient's last name.","type":"string"},"middleName":{"description":"The patient's middle name.","type":"string"},"stateCode":{"description":"The patient's state (two character code).","type":"string"},"subscriberRelationshipCode":{"description":"The patient's relationship to the subscriber.","type":"string"},"suffix":{"description":"The patient's suffix.","type":"string"},"zipCode":{"description":"The patient's ZIP code.","type":"string"}},"type":"object"},"Payer":{"properties":{"addressLine1":{"description":"The payer's address (line one).","type":"string"},"addressLine2":{"description":"The payer's address (line two).","type":"string"},"city":{"description":"The payer's city.","type":"string"},"claimFilingIndicatorCode":{"description":"The claim filing indicator code of the payer.","type":"string"},"claimOfficeNumber":{"description":"The payer's claim office number.","type":"string"},"countryCode":{"description":"The payer's country code (US or CA).","type":"string"},"ein":{"description":"The payer's EIN.","type":"string"},"id":{"description":"The payer's id.","type":"string"},"insuranceTypeCode":{"description":"The insurance type code of the payer.","type":"string"},"naicCode":{"description":"The payer's NAIC.","type":"string"},"name":{"description":"The payer's name.","type":"string"},"responsibilitySequenceCode":{"description":"The responsibility sequence of the payer (P, S, or T).","type":"string"},"stateCode":{"description":"The payer's state (two character code).","type":"string"},"zipCode":{"description":"The payer's ZIP code.","type":"string"}},"type":"object"},"Provider":{"properties":{"addressLine1":{"description":"This provider's address (line one).","type":"string"},"addressLine2":{"description":"This provider's address (line two).","type":"string"},"city":{"description":"This provider's city.","type":"string"},"countryCode":{"description":"This provider's country (US or CA).","type":"string"},"firstName":{"description":"This provider's first name.","type":"string"},"lastName":{"description":"This provider's last name or organization name.","type":"string"},"locationNumber":{"description":"This provider's location number.","type":"string"},"middleName":{"description":"This provider's middle name.","type":"string"},"npi":{"description":"This provider's NPI.","type":"string"},"payerAssignedProviderId":{"description":"This provider's payer assigned provider id.","type":"string"},"referralNumber":{"description":"The referral number.","type":"string"},"specialtyCode":{"description":"This provider's specialty code.","type":"string"},"stateCode":{"description":"This provider's state (two character code).","type":"string"},"stateLicenseNumber":{"description":"This provider's state license number.","type":"string"},"suffix":{"description":"This provider's suffix.","type":"string"},"upin":{"description":"This provider's UPIN.","type":"string"},"zipCode":{"description":"This provider's ZIP code.","type":"string"}},"type":"object"},"ServiceLine":{"properties":{"adjudicationInformation":{"description":"Adjudication information for this service line.","items":{"$ref":"#/definitions/AdjudicationInformation"},"type":"array"},"amount":{"description":"The charge amount for this service.","type":"string"},"appliancePlacementDate":{"description":"The appliance placement date.","format":"date","type":"string"},"assistantSurgeon":{"$ref":"#/definitions/Provider"},"cavityDesignationCode1":{"description":"A cavity designation code.","type":"string"},"cavityDesignationCode2":{"description":"A cavity designation code.","type":"string"},"cavityDesignationCode3":{"description":"A cavity designation code.","type":"string"},"cavityDesignationCode4":{"description":"A cavity designation code.","type":"string"},"cavityDesignationCode5":{"description":"A cavity designation code.","type":"string"},"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.","type":"string"},"contractVersion":{"description":"The contract version.","type":"string"},"controlNumber":{"description":"The control number for this service line.","type":"string"},"diagnosisCodePointer1":{"description":"A diagnosis code pointer.","type":"string"},"diagnosisCodePointer2":{"description":"A diagnosis code pointer.","type":"string"},"diagnosisCodePointer3":{"description":"A diagnosis code pointer.","type":"string"},"diagnosisCodePointer4":{"description":"A diagnosis code pointer.","type":"string"},"modifierCode1":{"description":"A procedure modifier.","type":"string"},"modifierCode2":{"description":"A procedure modifier.","type":"string"},"modifierCode3":{"description":"A procedure modifier.","type":"string"},"modifierCode4":{"description":"A procedure modifier.","type":"string"},"placeOfServiceCode":{"description":"The place where this service was performed.","type":"string"},"priorAuthorizationNumber":{"description":"The prior authorization number for this service.","type":"string"},"priorPlacementDate":{"description":"The prior placement date.","format":"date","type":"string"},"procedureCode":{"description":"The procedure performed.","type":"string"},"procedureDescription":{"description":"A procedure description.","type":"string"},"prostheticCode":{"description":"The presthetic code.","type":"string"},"quantity":{"description":"The quantity.","type":"string"},"referralNumber":{"description":"The referral number for this service..","type":"string"},"renderingProvider":{"$ref":"#/definitions/Provider"},"replacementDate":{"description":"The replacement date.","format":"date","type":"string"},"salesTax":{"description":"The sales tax for this service.","type":"string"},"serviceDate":{"description":"The date that this service was performed.","format":"date","type":"string"},"serviceFacility":{"$ref":"#/definitions/Provider"},"supervisingProvider":{"$ref":"#/definitions/Provider"},"toothInformation":{"description":"Information about the teeth involved in this service.","items":{"$ref":"#/definitions/ToothInformation"},"type":"array"},"treatmentEndDate":{"description":"The date treatment ended.","format":"date","type":"string"},"treatmentStartDate":{"description":"The date treatment started.","format":"date","type":"string"}},"type":"object"},"Submitter":{"properties":{"contactName":{"description":"The submitter's contact name,","type":"string"},"email":{"description":"The submitter's email address.","type":"string"},"extension":{"description":"The submitter's phone number extension.","type":"string"},"fax":{"description":"The submitter's fax number.","type":"string"},"firstName":{"description":"The submitter's first name.","type":"string"},"id":{"description":"The submitter's ETIN.","type":"string"},"lastName":{"description":"The submitter's last name or organization name.","type":"string"},"middleName":{"description":"The submitter's middle name.","type":"string"},"phone":{"description":"The submitter's phone number.","type":"string"}},"type":"object"},"Subscriber":{"properties":{"addressLine1":{"description":"The subscriber's address (line one).","type":"string"},"addressLine2":{"description":"The subscriber's address (line two).","type":"string"},"city":{"description":"The subscriber's city.","type":"string"},"countryCode":{"description":"The subscriber's country (US or CA).","type":"string"},"firstName":{"description":"The subscriber's first name.","type":"string"},"groupName":{"description":"The subscriber's group name.","type":"string"},"groupNumber":{"description":"The subscriber's group number.","type":"string"},"lastName":{"description":"The subscriber's last name.","type":"string"},"memberId":{"description":"The subscriber's member id.","type":"string"},"middleName":{"description":"The subscriber's middle name.","type":"string"},"ssn":{"description":"The subscriber's SSN.","type":"string"},"stateCode":{"description":"The subscriber's state (two character code).","type":"string"},"suffix":{"description":"The subscriber's suffix.","type":"string"},"zipCode":{"description":"The subscriber's ZIP code.","type":"string"}},"type":"object"},"SupplementalInformation":{"properties":{"controlNumber":{"description":"The control number.","type":"string"},"reportTransmissionCode":{"description":"The report transmission method.","type":"string"},"reportTypeCode":{"description":"The report type.","type":"string"}},"type":"object"},"ToothInformation":{"properties":{"toothCode":{"description":"The tooth.","type":"string"},"toothSurfaceCode1":{"description":"A tooth surface.","type":"string"},"toothSurfaceCode2":{"description":"A tooth surface.","type":"string"},"toothSurfaceCode3":{"description":"A tooth surface.","type":"string"},"toothSurfaceCode4":{"description":"A tooth surface.","type":"string"},"toothSurfaceCode5":{"description":"A tooth surface.","type":"string"}},"type":"object"},"ToothStatus":{"properties":{"toothCode":{"description":"A tooth.","type":"string"},"toothStatusCode":{"description":"A tooth status.","type":"string"}},"type":"object"}},"host":"api.availity.com","info":{"description":"The Availity Dental Claims 1.0.0 API is designed to support the submission and processing of dental healthcare claims in a HIPAA-compliant manner.","title":"Dental Claims","version":"1.0.0","x-custom-api-description":"The Availity Dental Claims 1.0.0 API is designed to support the submission and processing of dental healthcare claims in a HIPAA-compliant manner."},"paths":{"/dental-claims":{"post":{"consumes":["application/json","application/xml"],"operationId":"createDentalClaim","parameters":[{"in":"body","name":"dentalclaim","schema":{"$ref":"#/definitions/DentalClaim"}}],"produces":["application/json","application/xml"],"responses":{"202":{"description":"Accepted","headers":{"Location":{"description":"Location of the dental 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 dental claim."}},"/dental-claims/{id}":{"get":{"operationId":"getDentalClaim","parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"produces":["application/json","application/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DentalClaim"}},"202":{"description":"Accepted","headers":{"Location":{"description":"Location of the dental 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 dental claim by its id."},"parameters":[{"description":"A dental 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"}