{"basePath":"/v1","definitions":{"ClaimStatus":{"properties":{"claimAmount":{"description":"The claim charge amount specified in the initial claim status inquiry request.","type":"string"},"claimCount":{"description":"The number of distinct claims included in the status response.","type":"string"},"claimNumber":{"description":"The claim number specified in the initial claim status inquiry request.","type":"string"},"claimStatuses":{"description":"The claim statuses.","items":{"$ref":"#/definitions/ClaimStatusResult"},"type":"array"},"controlNumber":{"description":"The control number of the X12 request that this claim status was created from.","type":"string"},"createdDate":{"description":"The date this claim status entry was created.","format":"date-time","type":"string"},"customerId":{"description":"The Availity Customer ID of the customer that owns this claim status.","type":"string"},"expirationDate":{"description":"The date when this claim status entry expires.","format":"date-time","type":"string"},"facilityType":{"description":"The facility type description.","type":"string"},"facilityTypeCode":{"description":"The facility type code specified in the initial claim status inquiry request.","type":"string"},"frequencyType":{"description":"The frequency type description.","type":"string"},"frequencyTypeCode":{"description":"The frequency type code specified in the initial claim status inquiry request.","type":"string"},"fromDate":{"description":"The from date specified in the initial claim status inquiry request.","format":"date","type":"string"},"id":{"description":"The id of the claim status.","type":"string"},"patient":{"$ref":"#/definitions/Patient"},"payer":{"$ref":"#/definitions/Payer"},"providers":{"description":"Provider of services from the original claim.","items":{"$ref":"#/definitions/Provider"},"type":"array"},"status":{"description":"The status of the claim status lookup.","type":"string"},"statusCode":{"description":"The status code of the claim status lookup.","type":"string"},"submitter":{"$ref":"#/definitions/Submitter"},"subscriber":{"$ref":"#/definitions/Subscriber"},"toDate":{"description":"The to date specified in the initial claim status inquiry request.","format":"date","type":"string"},"updatedDate":{"description":"The date when this claim status entry was last updated.","format":"date-time","type":"string"},"userId":{"description":"The User ID of the customer that owns this claim status.","type":"string"}},"type":"object"},"ClaimStatusDetail":{"properties":{"category":{"description":"The decode of the category of the claim status.\")","type":"string"},"categoryCode":{"description":"The category code of the claim status.\")","type":"string"},"checkNumber":{"description":"The check or EFT Trace Number that paid the original claim.\")","type":"string"},"claimAmount":{"description":"The charge amount of the original claim.\")","type":"string"},"claimAmountUnits":{"description":"The units describing the cliam amount.\")","type":"string"},"effectiveDate":{"description":"The date this status was effective.\")","format":"date","type":"string"},"entity":{"description":"The decode of the entity of the claim status.\")","type":"string"},"entityCode":{"description":"The entity code of the claim status.\")","type":"string"},"finalizedDate":{"description":"The date the original claim was finalized/adjudicated.\")","format":"date","type":"string"},"paymentAmount":{"description":"The amount paid by the health plan from the original claim.\")","type":"string"},"paymentAmountUnits":{"description":"The units describing the paid amount.\")","type":"string"},"remittanceDate":{"description":"The date the original claim was paid by the health plan.\")","format":"date","type":"string"},"status":{"description":"The decode of the status of the claim status.\")","type":"string"},"statusCode":{"description":"The status code of the claim status.\")","type":"string"}},"type":"object"},"ClaimStatusResult":{"properties":{"claimControlNumber":{"description":"The payer’s assigned control number, also known as, Internal Control Number (ICN), Document Control Number (DCN), or Claim Control Number (CCN).","type":"string"},"claimIdentificationNumber":{"description":"The clearinghouse assigned trace number of the original claim.","type":"string"},"facilityType":{"description":"The facility type description.","type":"string"},"facilityTypeCode":{"description":"The facility type code of the original institutional claim.","type":"string"},"frequencyType":{"description":"The frequency type description.","type":"string"},"frequencyTypeCode":{"description":"The frequency type code of the original institutional claim.","type":"string"},"fromDate":{"description":"The claim service from date.","format":"date","type":"string"},"patientControlNumber":{"description":"The patient contorl number.","type":"string"},"pharmacyPrescriptionNumber":{"description":"The pharmacy prescription number.","type":"string"},"serviceLines":{"description":"Reports the status, required action, and paid information for a service line.","items":{"$ref":"#/definitions/ServiceLine"},"type":"array"},"statusDetails":{"description":"Reports the status, required action, and paid information of a claim.","items":{"$ref":"#/definitions/ClaimStatusDetail"},"type":"array"},"toDate":{"description":"The claim service to date.","format":"date","type":"string"},"traceId":{"description":"Referenced transaction trace identifier.","type":"string"},"voucherNumber":{"description":"The payer assigned voucher identifier.","type":"string"}},"type":"object"},"ClaimStatusSummary":{"properties":{"claimAmount":{"description":"The claim amount.","type":"string"},"claimCount":{"description":"The claim count.","type":"string"},"claimNumber":{"description":"The claim number.","type":"string"},"controlNumber":{"description":"A tracking number we assigned to the transaction with the payer.","type":"string"},"createdDate":{"description":"The date and time when this claim status was added to our system.","format":"date-time","type":"string"},"customerId":{"description":"The id of the customer that owns this claim status.","type":"string"},"expirationDate":{"description":"The date and time when this claim status will expire from our system.","format":"date-time","type":"string"},"facilityType":{"description":"The facility type.","type":"string"},"facilityTypeCode":{"description":"The facility type code.","type":"string"},"frequencyType":{"description":"The frequency type.","type":"string"},"frequencyTypeCode":{"description":"The frequency type code.","type":"string"},"fromDate":{"description":"The service from date.","format":"date","type":"string"},"id":{"description":"The id of the claim status.","type":"string"},"patient":{"description":"The patient.","properties":{"accountNumber":{"description":"The patient's account number.","type":"string"},"birthDate":{"description":"The patient's birth date.","format":"date","type":"string"},"firstName":{"description":"The patient's first name.","type":"string"},"gender":{"description":"The patient's gender.","type":"string"},"genderCode":{"description":"The patient's gender code.","type":"string"},"lastName":{"description":"The patient's last name.","type":"string"},"middleName":{"description":"The patient's middle name.","type":"string"},"subscriberRelationship":{"description":"The patient's relationship to subscriber.","type":"string"},"subscriberRelationshipCode":{"description":"The patient's relationship to subscriber code.","type":"string"},"suffix":{"description":"The patient's suffix.","type":"string"}},"type":"object"},"payer":{"description":"The claim payer.","properties":{"id":{"description":"The payer's id.","type":"string"}},"type":"object"},"providers":{"description":"The claim providers.","items":{"properties":{"firstName":{"description":"The provider's first name.","type":"string"},"lastName":{"description":"The provider's last or business name.","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"},"suffix":{"description":"The provider's suffix.","type":"string"},"taxId":{"description":"The provider's tax id.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The current status of the claim status request.","type":"string"},"statusCode":{"description":"The current status code of the claim status request.","type":"string"},"submitter":{"description":"The claim submitter.","properties":{"firstName":{"description":"The submitter's first name.","type":"string"},"id":{"description":"The submitter's id.","type":"string"},"lastName":{"description":"The submitter's last name.","type":"string"},"middleName":{"description":"The submitter's middle name.","type":"string"},"suffix":{"description":"The submitter's suffix.","type":"string"}},"type":"object"},"subscriber":{"description":"The subscriber.","properties":{"firstName":{"description":"The subscriber's first name.","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"},"suffix":{"description":"The subscriber's suffix.","type":"string"}},"type":"string"},"toDate":{"description":"The service to date.","format":"date","type":"string"},"updatedDate":{"description":"The date and time when this claim status was last updated in our system.","format":"date-time","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"},"Link":{"properties":{"href":{"description":"The URL.","type":"string"}},"type":"object"},"Patient":{"properties":{"accountNumber":{"description":"The service provider's patient identifier.","type":"string"},"birthDate":{"description":"The patient's date of birth.","format":"date","type":"string"},"firstName":{"description":"The patient's first name.","type":"string"},"gender":{"description":"The patient's gender.","type":"string"},"genderCode":{"description":"The patient's gender code.","type":"string"},"lastName":{"description":"The patient's last name.","type":"string"},"middleName":{"description":"The patient's middle name.","type":"string"},"subscriberRelationship":{"description":"The patient's relationship to the subscriber or policy holder.","type":"string"},"subscriberRelationshipCode":{"description":"The patient's relationship code to the subscriber or policy holder.","type":"string"},"suffix":{"description":"The patient's suffix.","type":"string"}},"type":"object"},"Payer":{"properties":{"contactName":{"description":"Full Name","type":"string"},"ediAccessNumber":{"description":"Electronic Data Interchange Access Number","type":"string"},"emailAddress":{"description":"E-mail Address","type":"string"},"extension":{"description":"Extension","type":"string"},"fax":{"description":"Fax","type":"string"},"id":{"description":"Claim status payer id","type":"string"},"name":{"description":"Claim status payer name","type":"string"},"phone":{"description":"Phone Number","type":"string"}},"type":"object"},"Provider":{"properties":{"firstName":{"description":"The first name of an individual provider.","type":"string"},"lastName":{"description":"The last name of an individual or the name of an organization that provided services on the original claim.","type":"string"},"middleName":{"description":"The middle name of an individual provider.","type":"string"},"npi":{"description":"The NPI of a provider.","type":"string"},"payerAssignedProviderId":{"description":"The payer assigned provider id of a provider.","type":"string"},"statusDetails":{"description":"Reports the status, required action, and paid information of a claim or service line.","items":{"$ref":"#/definitions/ClaimStatusDetail"},"type":"array"},"suffix":{"description":"The suffix of an individual provider.","type":"string"},"taxId":{"description":"The tax id of a provider.","type":"string"},"traceId":{"description":"Referenced transaction trace identifier.","type":"string"}},"type":"object"},"ResultSet":{"properties":{"claimStatuses":{"description":"list of claim statuses","items":{"$ref":"#/definitions/ClaimStatusSummary"},"type":"array"},"count":{"description":"Number of assets in the result set.","type":"integer"},"limit":{"description":"Paging limit.","type":"integer"},"links":{"additionalProperties":{"$ref":"#/definitions/Link"},"description":"Links.","type":"object"},"offset":{"description":"Paging offset.","type":"integer"},"totalCount":{"description":"Total number of assets.","type":"integer"}},"type":"object"},"ServiceLine":{"properties":{"chargeAmount":{"description":"The line item total on the current claim service status.","type":"string"},"chargeAmountUnits":{"description":"The units of the charge amount.","type":"string"},"controlNumber":{"description":"The service line control number.","type":"string"},"fromDate":{"description":"The service line service from date.","format":"date","type":"string"},"modifier1":{"description":"Description of a modification related to the performance of the service.","type":"string"},"modifier1Code":{"description":"Identifier code of a modification related to the performance of the service.","type":"string"},"modifier2":{"description":"Description of a modification related to the performance of the service.","type":"string"},"modifier2Code":{"description":"Identifier code of a modification related to the performance of the service.","type":"string"},"modifier3":{"description":"Description of a modification related to the performance of the service.","type":"string"},"modifier3Code":{"description":"Identifier code of a modification related to the performance of the service.","type":"string"},"modifier4":{"description":"Description of a modification related to the performance of the service.","type":"string"},"modifier4Code":{"description":"Identifier code of a modification related to the performance of the service.","type":"string"},"paymentAmount":{"description":"The line item paid amount.","type":"string"},"paymentAmountUnits":{"description":"The units of the paid amount.","type":"string"},"procedure":{"description":"Description of the procedure performed.","type":"string"},"procedureCode":{"description":"The procedure code.","type":"string"},"procedureQualifier":{"description":"Description of the product or service id qualifier.","type":"string"},"procedureQualifierCode":{"description":"The product or service qualifier code.","type":"string"},"quantity":{"description":"The quantity of the product or service.","type":"string"},"service":{"description":"The description of a product or service.","type":"string"},"serviceCode":{"description":"The identifying number for a product or service.","type":"string"},"statusDetails":{"description":"Reports the status, required action, and paid information of a claim or service line.","items":{"$ref":"#/definitions/ClaimStatusDetail"},"type":"array"},"toDate":{"description":"The service line service to date.","format":"date","type":"string"}},"type":"object"},"Submitter":{"properties":{"firstName":{"description":"The first name of an individual submitter.","type":"string"},"id":{"description":"The submitter's identification number.","type":"string"},"lastName":{"description":"The last name of an individual or the name of an organization submitting the claim status inquiry.","type":"string"},"middleName":{"description":"The middle name of an individual submitter.","type":"string"},"statusDetails":{"description":"Reports the status, required action, and paid information of a claim or service line.","items":{"$ref":"#/definitions/ClaimStatusDetail"},"type":"array"},"suffix":{"description":"The suffix of an individual submitter.","type":"string"},"traceId":{"description":"Referenced transaction trace identifier.","type":"string"}},"type":"object"},"Subscriber":{"properties":{"firstName":{"description":"The subscriber's first name.","type":"string"},"lastName":{"description":"The subscriber's last name.","type":"string"},"memberId":{"description":"The health plan member id of the subscriber.","type":"string"},"middleName":{"description":"The subscriber's middle name.","type":"string"},"suffix":{"description":"The subscriber's suffix.","type":"string"},"taxId":{"description":"The subscriber's tax id.","type":"string"}},"type":"object"}},"host":"api.availity.com","info":{"description":"The Availity Claim Statuses 1.0.0 API enables healthcare providers and systems to check the status of submitted claims in real time using standardized HIPAA transactions.","title":"Claim Statuses","version":"1.0.0","x-custom-api-description":"The Availity Claim Statuses 1.0.0 API enables healthcare providers and systems to check the status of submitted claims in real time using standardized HIPAA transactions."},"paths":{"/claim-statuses":{"post":{"consumes":["application/x-www-form-urlencoded"],"operationId":"findClaimStatus","parameters":[{"description":"The HTTP method to override the POST with. The value must be GET.","in":"header","name":"X-HTTP-Method-Override","required":true,"type":"string"},{"description":"The Availity payer id of the member.","in":"formData","name":"payer.id","type":"string"},{"description":"The submitter's last or business name.","in":"formData","name":"submitter.lastName","type":"string"},{"description":"The submitter's first name.","in":"formData","name":"submitter.firstName","type":"string"},{"description":"The submitter's middle name.","in":"formData","name":"submitter.middleName","type":"string"},{"description":"The submitter's suffix.","in":"formData","name":"submitter.suffix","type":"string"},{"description":"The submitter's id.","in":"formData","name":"submitter.id","type":"string"},{"description":"The provider's last name.","in":"formData","name":"providers.lastName","type":"string"},{"description":"The provider's first name.","in":"formData","name":"providers.firstName","type":"string"},{"description":"The provider's middle name.","in":"formData","name":"providers.middleName","type":"string"},{"description":"The provider's suffix.","in":"formData","name":"providers.suffix","type":"string"},{"description":"The provider's national provider id.","in":"formData","name":"providers.npi","type":"string"},{"description":"The provider's tax id.","in":"formData","name":"providers.taxId","type":"string"},{"description":"The provider's payer assigned provider id.","in":"formData","name":"providers.payerAssignedProviderId","type":"string"},{"description":"The subscriber's member id.","in":"formData","name":"subscriber.memberId","type":"string"},{"description":"The subscriber's last name.","in":"formData","name":"subscriber.lastName","type":"string"},{"description":"The subscriber's first name.","in":"formData","name":"subscriber.firstName","type":"string"},{"description":"The subscriber's middle name.","in":"formData","name":"subscriber.middleName","type":"string"},{"description":"The subscriber's suffix.","in":"formData","name":"subscriber.suffix","type":"string"},{"description":"The patient's last name.","in":"formData","name":"patient.lastName","type":"string"},{"description":"The patient's first name.","in":"formData","name":"patient.firstName","type":"string"},{"description":"The patient's middle name.","in":"formData","name":"patient.middleName","type":"string"},{"description":"The patient's suffix.","in":"formData","name":"patient.suffix","type":"string"},{"description":"The patient's birth date.","format":"date","in":"formData","name":"patient.birthDate","type":"string"},{"description":"The patient's gender code.","in":"formData","name":"patient.genderCode","type":"string"},{"description":"The patient's account number.","in":"formData","name":"patient.accountNumber","type":"string"},{"description":"The patient's relationship to subscriber code.","in":"formData","name":"patient.subscriberRelationshipCode","type":"string"},{"description":"The service from date.","format":"date","in":"formData","name":"fromDate","type":"string"},{"description":"The service to date.","format":"date","in":"formData","name":"toDate","type":"string"},{"description":"The health plan's claim tracking number assigned when the original claim was received and processed.","in":"formData","name":"claimNumber","type":"string"},{"description":"The total claim charge amount of the original claim processed by the health plan.","in":"formData","name":"claimAmount","type":"string"},{"description":"The code identifying where services were, or may have been, performed for institutional claims.","in":"formData","name":"facilityTypeCode","type":"string"},{"description":"The code identifying the frequency of an institutional claim.","in":"formData","name":"frequencyTypeCode","type":"string"}],"produces":["application/json","application/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResultSet"}},"202":{"description":"Accepted","headers":{"Location":{"description":"Location of the claim status.","type":"string"},"X-Status-Message":{"description":"Current status of the pending request.","type":"string"}},"schema":{"$ref":"#/definitions/ResultSet"}},"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":"Initiate a new claim status request or view an existing request."}},"/claim-statuses/{id}":{"delete":{"responses":{"200":{"description":"200 OK"}}},"get":{"operationId":"getClaimStatusById","parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"produces":["application/json","application/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClaimStatus"}},"202":{"description":"Accepted","headers":{"Location":{"description":"Location of the claim status.","type":"string"},"X-Status-Message":{"description":"Current status of the pending request.","type":"string"}},"schema":{"$ref":"#/definitions/ClaimStatus"}},"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"}}},"summary":"Get the full claim status information by id."},"parameters":[{"description":"A claim status 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"}