Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your platform API key (haau3_sk_…), sent as Authorization: Bearer <key>.

Headers

X-Request-Id
string<uuid>

An id of your own for this request, as a UUID. It comes back in the X-Correlation-Id header and is kept with haau3's record of the request. Any value that is not a UUID is ignored. See https://docs.haau3.com/errors#request-ids.

Query Parameters

identifier
string

A plan id, as value or system|value. A Medicare Advantage plan by CMS's plan id (http://cms.gov/medicare/ma-plan-id, the segment in three digits: H2406-013-000) or its bid_id (https://haau3.com/fhir/NamingSystem/cms-ma-bid-id: H2406_013_0). A Marketplace plan by its HIOS plan id (https://haau3.com/fhir/NamingSystem/hios-plan-id: 19898FL0340001-01) or its standard component (https://haau3.com/fhir/NamingSystem/hios-standard-component-id: 19898FL0340001), which finds every variant.

name
string

The start of the plan's name, ignoring case and accents. name:contains matches anywhere in the name and name:exact the whole name exactly; give one form.

Required string length: 1 - 100
name:contains
string

Part of the plan's name, anywhere in it, ignoring case and accents.

Required string length: 1 - 100
name:exact
string

The plan's whole name, exactly.

Required string length: 1 - 100
coverage-area-state
string

A two-letter state code: the plans sold in that state. Defined by the haau3 implementation guide (https://haau3.com/fhir/SearchParameter/InsurancePlan-coverage-area-state).

Pattern: ^[A-Za-z]{2}$
coverage-area-county
string

A five-digit FIPS state and county code (12086, Miami-Dade County, Florida), bare or as http://terminology.hl7.org/CodeSystem/FIPS64|12086: the plans sold in that county, in whole or in part. A code that names no county is refused. Defined by the haau3 implementation guide (https://haau3.com/fhir/SearchParameter/InsurancePlan-coverage-area-county).

type
string

mediadv for Medicare Advantage or qhp for the Marketplace, from http://terminology.hl7.org/CodeSystem/insurance-product-type.

sold-to
enum<string>

individuals for the plans a person can buy on their own, or employer-groups for the plans sold only to employer and union groups (Medicare Advantage) or to small employers (Marketplace SHOP plans). Narrows a search; it is not one by itself. Defined by the haau3 implementation guide (https://haau3.com/fhir/SearchParameter/InsurancePlan-sold-to).

Available options:
individuals,
employer-groups
_count
integer
default:10

Page size. A larger value is refused rather than quietly reduced.

Required range: 1 <= x <= 50
page
string

The cursor a next link carries. It is opaque and belongs to one search; once the plans are updated a later page answers 410, so start the search again.

Response

A searchset Bundle with total set.

A FHIR R4 Bundle.

resourceType
string
required
Allowed value: "Bundle"
type
string
entry
object[]