List Estimates

GET 
/api/v1/gfe/

Retrieves a list of all Good Faith Estimate associated with your account.

Request

Query Parameters

page integer

A page number within the paginated result set.

Responses

200

application/json

Schema

Schema

countintegerrequired
Example: 123
nexturinullable
Example: http://api.example.org/accounts/?page=4
previousurinullable
Example: http://api.example.org/accounts/?page=2

results

object[]

required

Array [

uuiduuidrequired

statusPatientEstimateStatusEnum (string)

• draft - Draft
• pending - Pending
• finalized - Finalized
• re-opened - Re-Opened
• archived - Archived
• deleted - Deleted

Possible values: [draft, pending, finalized, re-opened, archived, deleted]

payment_typePaymentTypeEnum (string)

• cash - Cash
• insurance - Insurance

Possible values: [cash, insurance]

additional_services

object[]

Array [

uuiduuidrequired

nameService/Item Name (string)required

Possible values: <= 255 characters

provider_infoProvider/Facility Information (string)required

Instructions for obtaining a good faith estimate for the service/item, such as provider/facility name, address, phone number, and email

]

providers

object[]

required

Array [

uuiduuidrequired

namestring

type

object

nullable

oneOf

TypeEnum

string

Possible values: [convening_provider, co_provider, facility_provider]

npiNational Provider ID (NPI) (string)nullable

Possible values: <= 120 characters

tinTax ID Number (TIN) (string)nullable

Possible values: <= 120 characters

address

object

address1Address 1 (string)nullable

address2Address 2 (string)nullable

citystringnullable

Possible values: <= 255 characters

state

object

nullable

oneOf

StateEnum

string

Possible values: [AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY]

zip_codestringnullable

Possible values: <= 20 characters

contact_namestringnullable

Possible values: <= 255 characters

phonePhone Number (string)nullable

Possible values: <= 10 characters

faxFax Number (string)nullable

Possible values: <= 10 characters

emailemailnullable

Possible values: <= 254 characters

additional_notesstringnullable

items

object[]

required

Array [

uuiduuidrequired

service_descriptionService Name (string)

typeService type (string)nullable

Possible values: <= 120 characters

billing_codeService/Procedure Code (string)required

Possible values: <= 30 characters

code_typestringrequired

Possible values: <= 255 characters

diagnosis_codestringnullable

ICD Code, if required for calculation.

Possible values: <= 255 characters

address_being_performedstringnullable

quantityQty. (integer)

Possible values: >= -2147483648 and <= 2147483647

estimated_costdecimalnullable

Actual cost

Possible values: Value must match regular expression ^-?\d{0,12}(?:\.\d{0,2})?$

subtotal_coststringrequired

statusServiceRequestStatusEnum (string)

• draft - Draft
• negotiating - Negotiating
• rejected - Rejected
• accepted - Accepted
• finalized - Finalized

Possible values: [draft, negotiating, rejected, accepted, finalized]

]

created_atdate-timerequired

updated_atdate-timerequired

]

insurance_namestring

patient

object

required

first_namestringrequired

Possible values: <= 150 characters

mistringnullable

Possible values: <= 150 characters

last_namestringrequired

Possible values: <= 150 characters

date_of_birthdaterequired

Date of birth in the format YYYY-MM-DD

phone_numberstringnullable

Possible values: <= 10 characters

email_addressemailnullable

Possible values: <= 254 characters

account_numberstringnullable

Last four digits.

Possible values: <= 4 characters

address

object

streetstringnullable

citystringnullable

Possible values: <= 255 characters

state

object

nullable

oneOf

StateEnum

string

Possible values: [AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY]

zip_codestringnullable

Possible values: <= 20 characters

insurance_namestringnullable

Possible values: <= 255 characters

member_idstringnullable

Possible values: <= 50 characters

request_datedatenullable

contact_preferenceContactPreferenceEnum (string)

• email - Email
• phone - Phone
• mail - Mail

Possible values: [email, phone, mail]

created_atdate-timerequired

updated_atdate-timerequired

]

Example (from schema)

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "draft",
      "payment_type": "cash",
      "additional_services": [
        {
          "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "provider_info": "string"
        }
      ],
      "providers": [
        {
          "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "type": "convening_provider",
          "npi": "string",
          "tin": "string",
          "address": {
            "address1": "string",
            "address2": "string",
            "city": "string",
            "state": "AL",
            "zip_code": "string"
          },
          "contact_name": "string",
          "phone": "string",
          "fax": "string",
          "email": "user@example.com",
          "additional_notes": "string",
          "items": [
            {
              "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "service_description": "string",
              "type": "string",
              "billing_code": "string",
              "code_type": "string",
              "diagnosis_code": "string",
              "address_being_performed": "string",
              "quantity": 0,
              "estimated_cost": "string",
              "subtotal_cost": "string",
              "status": "draft"
            }
          ],
          "created_at": "2024-09-20T22:06:01.844Z",
          "updated_at": "2024-09-20T22:06:01.844Z"
        }
      ],
      "insurance_name": "string",
      "patient": {
        "first_name": "string",
        "mi": "string",
        "last_name": "string",
        "date_of_birth": "2024-09-20",
        "phone_number": "string",
        "email_address": "user@example.com",
        "account_number": "string",
        "address": {
          "street": "string",
          "city": "string",
          "state": "AL",
          "zip_code": "string"
        },
        "insurance_name": "string",
        "member_id": "string",
        "request_date": "2024-09-20",
        "contact_preference": "email"
      },
      "created_at": "2024-09-20T22:06:01.844Z",
      "updated_at": "2024-09-20T22:06:01.844Z"
    }
  ]
}