{
  "opencollection": "1.0.0",
  "info": {
    "name": "NexHealth Adjustment Types Insurance API",
    "version": "v20240412"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Insurance",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View insurance plans",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/insurance_plans",
            "headers": [
              {
                "name": "Nex-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subdomain",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified institution"
              },
              {
                "name": "start_cursor",
                "value": "",
                "type": "query",
                "description": "First item of the current page. Starts empty"
              },
              {
                "name": "end_cursor",
                "value": "",
                "type": "query",
                "description": "Last item of the current page. Starts empty"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page. Maximum allowed amount is 1000."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n"
              },
              {
                "name": "updated_since",
                "value": "2024-04-12T10:30:00Z",
                "type": "query",
                "description": "Insurance plans updated at or after the specified time (UTC). The comparison is inclusive, so a record whose updated_at exactly equals the given value is returned"
              },
              {
                "name": "payer_id",
                "value": "87726",
                "type": "query",
                "description": "A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically"
              },
              {
                "name": "group_num",
                "value": "12345",
                "type": "query",
                "description": "Filter for plans with the specified group number"
              },
              {
                "name": "include_deleted",
                "value": "",
                "type": "query",
                "description": "Include soft-deleted insurance plans in the results"
              }
            ]
          },
          "docs": "This endpoint returns a list of insurance plans. All filters are optional: without any filters, every insurance plan for the institution is returned. You can narrow the results by payer_id, group_num or updated_since. Soft-deleted plans are excluded unless include_deleted is true."
        },
        {
          "info": {
            "name": "View insurance plan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/insurance_plans/:id",
            "headers": [
              {
                "name": "Nex-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the insurance plan"
              },
              {
                "name": "subdomain",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified institution"
              },
              {
                "name": "include[]",
                "value": "",
                "type": "query",
                "description": "Resources to be included in the response"
              }
            ]
          },
          "docs": "This endpoint returns a single insurance plan by its NexHealth id. Use the include parameter to embed related resources: patient_coverages, subscribers and/or fee_schedule. Responds with a 404 when no plan with the given id exists for the institution."
        },
        {
          "info": {
            "name": "View insurance coverages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/insurance_coverages",
            "headers": [
              {
                "name": "Nex-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subdomain",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified institution"
              },
              {
                "name": "start_cursor",
                "value": "",
                "type": "query",
                "description": "First item of the current page. Starts empty"
              },
              {
                "name": "end_cursor",
                "value": "",
                "type": "query",
                "description": "Last item of the current page. Starts empty"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page. Maximum allowed amount is 1000."
              },
              {
                "name": "updated_since",
                "value": "2024-04-12T10:30:00Z",
                "type": "query",
                "description": "Insurance coverages updated at or after the specified time (UTC). The comparison is inclusive and matches when either the coverage or its subscription was updated since the given time"
              },
              {
                "name": "patient_id",
                "value": "162",
                "type": "query",
                "description": "Filter for coverages of a specific patient. Responds with a 404 when no patient with this id exists"
              },
              {
                "name": "active",
                "value": "",
                "type": "query",
                "description": "Filter active (true) or inactive (false) insurance coverages. Defaults to true, so inactive coverages are only returned when this is explicitly set to false"
              }
            ]
          },
          "docs": "This endpoint returns a list of insurance coverages. All filters are optional: without any filters, every active insurance coverage for the institution is returned. Only active coverages are included by default; pass active=false to list inactive coverages instead."
        },
        {
          "info": {
            "name": "View insurance coverage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/insurance_coverages/:id",
            "headers": [
              {
                "name": "Nex-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Insurance coverage ID"
              },
              {
                "name": "subdomain",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified institution"
              }
            ]
          },
          "docs": "This endpoint returns a single insurance coverage by its NexHealth id, including details of the subscriber who holds the coverage. Responds with a 404 when no coverage with this id exists for the institution."
        }
      ]
    }
  ],
  "bundled": true
}