> ## Documentation Index > Fetch the complete documentation index at: https://docs.haau3.com/llms.txt > Use this file to discover all available pages before exploring further. # Read a plan > Read one plan by its id. A Medicare Advantage plan's id is CMS's plan id with the segment in three digits (`H2406-013-000`); a Marketplace plan's is its HIOS plan id with the variant (`19898FL0340001-01`). The plan conforms to the haau3 Plan Benefits profile and to the SBC InsurancePlan profile of the CARIN Digital Insurance Card guide, 2.0.0-ballot, and names the CMS release it was read from. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/fhir/r4/InsurancePlan/{id} openapi: 3.1.0 info: title: haau3 Platform API version: 1.0.0-preview.4 description: >- The haau3 platform API is in preview: it may change as we build, usually to add features or improve performance. Endpoints require an API key, sent as `Authorization: Bearer `. Requests without a valid key return 401. Create a key in the dashboard at https://platform.haau3.com; a new organization starts on the free Developer plan. From 2026-11-01 a request past one of its plan's limits (requests a minute on every plan, requests a month on Developer) returns 429 with `Retry-After`. Every error under `/v1/fhir` is a FHIR `OperationOutcome` and every other error an RFC 9457 problem; https://docs.haau3.com/errors lists every status, whether to retry it, and what a method a path does not take answers. servers: - url: https://api.haau3.com description: Production security: - bearerAuth: [] tags: - name: Scheduling description: 'Provider availability (SMART Scheduling Links): slots and publishers.' - name: FHIR base description: >- What the FHIR R4 base at `/v1/fhir/r4` answers for every service on it: the `CapabilityStatement` that lists them all, and batch Bundles that carry several requests to any of them in one round trip. - name: Terminology description: >- FHIR terminology operations over the code systems listed in TerminologyCapabilities. Some are resolved from their own source when you ask; others are held here at a named release, which that resource also names. - name: Provider directory description: >- CMS's National Provider Directory as FHIR R4: practitioners and their roles, organizations, payers and insurance networks, network membership, healthcare services, locations and endpoints. Every parameter the service serves is declared here, and any other is refused by name rather than ignored. - name: Questionnaires description: >- FHIR Questionnaire, served as its source publishes it. This service holds copies of a curated set and reaches any other questionnaire its source publishes by canonical URL, as well as forms published at their own address under places this service is set up to reach. Read one by id, and build the QuestionnaireResponse in your own application. - name: Plan Benefits description: >- FHIR InsurancePlan: what a Medicare Advantage or ACA Marketplace plan covers and what a member pays, read from the files CMS publishes. Every plan names the CMS release it was read from. Read a plan by its id, or search by identifier, name, state or county, and check whether the CMS National Provider Directory lists providers in a plan's network. - name: MedList description: >- One reconciled medication list from one patient's FHIR medication records, as US Core MedicationRequests with a Provenance for each. This operation receives patient data, so send it only under an executed agreement. paths: /v1/fhir/r4/InsurancePlan/{id}: get: tags: - Plan Benefits summary: Read a plan description: >- Read one plan by its id. A Medicare Advantage plan's id is CMS's plan id with the segment in three digits (`H2406-013-000`); a Marketplace plan's is its HIOS plan id with the variant (`19898FL0340001-01`). The plan conforms to the haau3 Plan Benefits profile and to the SBC InsurancePlan profile of the CARIN Digital Insurance Card guide, 2.0.0-ballot, and names the CMS release it was read from. operationId: readInsurancePlan parameters: - name: id in: path required: true schema: type: string pattern: ^[A-Za-z0-9\-.]{1,64}$ description: 'The plan''s id: `H2406-013-000` or `19898FL0340001-01`.' example: H2406-013-000 - $ref: '#/components/parameters/XRequestId' responses: '200': description: The `InsurancePlan`. content: application/fhir+json: schema: $ref: '#/components/schemas/InsurancePlan' examples: A Medicare Advantage plan: summary: A Medicare Advantage plan value: resourceType: InsurancePlan id: H2406-013-000 meta: profile: - >- https://haau3.com/fhir/StructureDefinition/haau3-insurance-plan - >- http://hl7.org/fhir/us/insurance-card/StructureDefinition/sbc-insurance-plan|2.0.0-ballot contained: - resourceType: Organization id: issuer identifier: - type: coding: - system: >- https://haau3.com/fhir/CodeSystem/payor-identifier-types-cs code: cms-contract-id display: CMS Contract ID system: >- https://haau3.com/fhir/NamingSystem/cms-ma-contract-id value: H2406 name: UnitedHealthcare alias: - CARE IMPROVEMENT PLUS SOUTH CENTRAL INSURANCE CO. - resourceType: Location id: state-FL physicalType: coding: - system: >- http://terminology.hl7.org/CodeSystem/location-physical-type code: jdn display: Jurisdiction address: state: FL extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-source-release extension: - url: release valueString: ma-2027-2026-10-01 - url: file extension: - url: downloadUrl valueUri: >- https://www.cms.gov/files/zip/pbp-benefits-2027.zip - url: lastModified valueDate: '2026-10-01' - url: sha256 valueString: >- 6d8430e2ecb51acf3cc8547f12dd73506aa73f0dccf034cc3c3393868576ff47 - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-plan-facts extension: - url: specialNeeds valueBoolean: false - url: employerOnly valueBoolean: false - url: partBOnly valueBoolean: false - url: filesCostData valueBoolean: true - url: outOfNetworkBenefit valueBoolean: true - url: pointOfService valueBoolean: false identifier: - system: http://cms.gov/medicare/ma-plan-id value: H2406-013-000 - system: https://haau3.com/fhir/NamingSystem/cms-ma-bid-id value: H2406_013_0 type: - coding: - system: >- http://terminology.hl7.org/CodeSystem/insurance-product-type code: mediadv display: Medicare Advantage status: active name: AARP Medicare Advantage from UHC FL-0021 (PPO) period: start: '2027' end: '2027' ownedBy: reference: '#issuer' display: UnitedHealthcare contact: - purpose: text: General Questions telecom: - system: phone value: (866)627-7806 - system: url value: AARPMedicarePlans.com - purpose: text: Provider directory telecom: - system: url value: AARPMedicarePlans.com coverageArea: - reference: '#state-FL' coverage: - type: coding: - system: http://terminology.hl7.org/CodeSystem/v3-ActCode code: HIP display: health insurance plan policy benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: primary-care-visit display: Primary Care Visit - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 7a display: Primary Care Physician Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: specialist-visit display: Specialist Visit - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 7d display: Physician Specialist Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: urgent-care display: Urgent Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 4b display: Urgently Needed Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: emergency-room-care display: Emergency Room Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 4a display: Emergency Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: hospital-inpatient display: Hospital Inpatient Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 1a display: Inpatient Hospital-Acute - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: hospital-outpatient display: Hospital Outpatient Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 9a1 display: Outpatient Hospital Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: facility-fee display: Facility Fee - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 9b display: Ambulatory Surgical Center (ASC) Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: imaging display: Imaging (CT/PET/MRI) - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 8b1 display: Diagnostic Radiological Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: rehabilitation display: Rehabilitation Services - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 7i display: >- Physical Therapy and Speech-Language Pathology Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: mental-health-outpatient display: Mental/Behavioral Health Outpatient Services - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: '7e1' display: >- Individual Sessions for Mental Health Specialty Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: emergency-medical-transport display: Emergency Medical Transportation - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 10a1 display: Ground Ambulance Services - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: skilled-nursing display: Skilled Nursing Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: '2' display: Skilled Nursing Facility (SNF) plan: - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-additional-benefit extension: - url: category valueCodeableConcept: coding: - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 8a2 display: Lab Services - url: cost extension: - url: type valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment - url: applicability valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network - url: amount valueQuantity: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD - url: cost extension: - url: type valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment - url: applicability valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network - url: amount valueQuantity: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-additional-benefit extension: - url: category valueCodeableConcept: coding: - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 9a2 display: Observation Services - url: cost extension: - url: type valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment - url: applicability valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network - url: qualifier valueCodeableConcept: coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: per-day display: Per day - url: amount valueQuantity: value: 550 code: USD system: urn:iso:std:iso:4217 unit: USD - url: cost extension: - url: type valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay-percent display: Copayment Percent per service text: Coinsurance - url: applicability valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network - url: amount valueQuantity: value: 40 code: '%' system: http://unitsofmeasure.org unit: '%' - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-additional-benefit extension: - url: category valueCodeableConcept: coding: - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: '6' display: Home Health Services - url: cost extension: - url: type valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment - url: applicability valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network - url: amount valueQuantity: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD - url: cost extension: - url: type valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay-percent display: Copayment Percent per service text: Coinsurance - url: applicability valueCodeableConcept: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network - url: amount valueQuantity: value: 50 code: '%' system: http://unitsofmeasure.org unit: '%' type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-plan-type code: PPO display: Preferred Provider Organization (PPO) text: Local PPO coverageArea: - reference: '#state-FL' generalCost: - type: coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-general-cost-type code: monthly-premium display: Monthly premium text: Monthly premium cost: value: 0 currency: USD - type: coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-general-cost-type code: part-b-premium-reduction display: Part B premium reduction text: Part B premium reduction comment: None - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope extension: - url: network valueCoding: system: >- http://terminology.hl7.org/CodeSystem/benefit-network code: out display: Out of Network - url: member valueCoding: system: >- http://terminology.hl7.org/CodeSystem/benefit-unit code: individual display: Individual - url: appliesTo valueCoding: system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope code: medical display: Medical type: coding: - system: >- http://terminology.hl7.org/CodeSystem/coverage-copay-type code: deductible display: Deductible text: Individual Deductible cost: value: 1000 currency: USD comment: Out of network, for medical care - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope extension: - url: network valueCoding: system: >- http://terminology.hl7.org/CodeSystem/benefit-network code: in display: In Network - url: member valueCoding: system: >- http://terminology.hl7.org/CodeSystem/benefit-unit code: individual display: Individual - url: appliesTo valueCoding: system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope code: medical display: Medical type: coding: - system: >- http://terminology.hl7.org/CodeSystem/coverage-copay-type code: maxoutofpocket display: Maximum out of pocket text: Individual Out-of-Pocket Maximum cost: value: 7150 currency: USD comment: In network, for medical care - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope extension: - url: network valueCoding: system: >- http://terminology.hl7.org/CodeSystem/benefit-network code: out display: Out of Network - url: member valueCoding: system: >- http://terminology.hl7.org/CodeSystem/benefit-unit code: individual display: Individual - url: appliesTo valueCoding: system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope code: medical display: Medical type: coding: - system: >- http://terminology.hl7.org/CodeSystem/coverage-copay-type code: maxoutofpocket display: Maximum out of pocket text: Individual Out-of-Pocket Maximum comment: 'Out of network, for medical care: none' - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope extension: - url: network valueCoding: system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope code: combined display: In and out of network combined - url: member valueCoding: system: >- http://terminology.hl7.org/CodeSystem/benefit-unit code: individual display: Individual - url: appliesTo valueCoding: system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope code: medical display: Medical type: coding: - system: >- http://terminology.hl7.org/CodeSystem/coverage-copay-type code: maxoutofpocket display: Maximum out of pocket text: Individual Out-of-Pocket Maximum cost: value: 10750 currency: USD comment: In and out of network combined, for medical care specificCost: - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: primary-care-visit display: Primary Care Visit - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 7a display: Primary Care Physician Services benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: primary-care-visit display: Primary Care Visit - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 7a display: Primary Care Physician Services cost: - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 45 code: USD system: urn:iso:std:iso:4217 unit: USD - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: specialist-visit display: Specialist Visit - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 7d display: Physician Specialist Services benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: specialist-visit display: Specialist Visit - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 7d display: Physician Specialist Services cost: - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range valueRange: low: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD high: value: 65 code: USD system: urn:iso:std:iso:4217 unit: USD type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 65 code: USD system: urn:iso:std:iso:4217 unit: USD comparator: <= - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 100 code: USD system: urn:iso:std:iso:4217 unit: USD - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: urgent-care display: Urgent Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 4b display: Urgently Needed Services benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: urgent-care display: Urgent Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 4b display: Urgently Needed Services cost: - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range valueRange: low: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD high: value: 50 code: USD system: urn:iso:std:iso:4217 unit: USD type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: one-price-both-networks display: One price in and out of network applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 50 code: USD system: urn:iso:std:iso:4217 unit: USD comparator: <= - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range valueRange: low: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD high: value: 50 code: USD system: urn:iso:std:iso:4217 unit: USD type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: one-price-both-networks display: One price in and out of network applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 50 code: USD system: urn:iso:std:iso:4217 unit: USD comparator: <= - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: emergency-room-care display: Emergency Room Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 4a display: Emergency Services benefit: - extension: - url: >- http://hl7.org/fhir/us/insurance-card/StructureDefinition/benefit-limitation extension: - url: limitText valueString: >- Copay waived if admitted to the hospital within 24 hours type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: emergency-room-care display: Emergency Room Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 4a display: Emergency Services cost: - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: one-price-both-networks display: One price in and out of network applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 130 code: USD system: urn:iso:std:iso:4217 unit: USD - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: one-price-both-networks display: One price in and out of network applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 130 code: USD system: urn:iso:std:iso:4217 unit: USD - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: hospital-inpatient display: Hospital Inpatient Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 1a display: Inpatient Hospital-Acute benefit: - extension: - url: >- http://hl7.org/fhir/us/insurance-card/StructureDefinition/benefit-limitation extension: - url: limitText valueString: >- Benefit period (in network): Per Admission or Per Stay type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: hospital-inpatient display: Hospital Inpatient Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 1a display: Inpatient Hospital-Acute cost: - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range valueRange: low: value: 1 code: d system: http://unitsofmeasure.org unit: d high: value: 5 code: d system: http://unitsofmeasure.org unit: d type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: per-day display: Per day applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 550 code: USD system: urn:iso:std:iso:4217 unit: USD - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range valueRange: low: value: 6 code: d system: http://unitsofmeasure.org unit: d high: value: 90 code: d system: http://unitsofmeasure.org unit: d type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: per-day display: Per day applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: per-stay display: Per stay applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay-percent display: Copayment Percent per service text: Coinsurance qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: per-stay display: Per stay applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 40 code: '%' system: http://unitsofmeasure.org unit: '%' - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: hospital-outpatient display: Hospital Outpatient Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 9a1 display: Outpatient Hospital Services benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: hospital-outpatient display: Hospital Outpatient Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 9a1 display: Outpatient Hospital Services cost: - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range valueRange: low: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD high: value: 550 code: USD system: urn:iso:std:iso:4217 unit: USD type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 550 code: USD system: urn:iso:std:iso:4217 unit: USD comparator: <= - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay-percent display: Copayment Percent per service text: Coinsurance applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 40 code: '%' system: http://unitsofmeasure.org unit: '%' - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: facility-fee display: Facility Fee - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 9b display: Ambulatory Surgical Center (ASC) Services benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: facility-fee display: Facility Fee - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 9b display: >- Ambulatory Surgical Center (ASC) Services cost: - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range valueRange: low: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD high: value: 500 code: USD system: urn:iso:std:iso:4217 unit: USD type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 500 code: USD system: urn:iso:std:iso:4217 unit: USD comparator: <= - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay-percent display: Copayment Percent per service text: Coinsurance applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 40 code: '%' system: http://unitsofmeasure.org unit: '%' - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: imaging display: Imaging (CT/PET/MRI) - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 8b1 display: Diagnostic Radiological Services benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: imaging display: Imaging (CT/PET/MRI) - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 8b1 display: Diagnostic Radiological Services cost: - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range valueRange: low: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD high: value: 320 code: USD system: urn:iso:std:iso:4217 unit: USD type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 320 code: USD system: urn:iso:std:iso:4217 unit: USD comparator: <= - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay-percent display: Copayment Percent per service text: Coinsurance applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 40 code: '%' system: http://unitsofmeasure.org unit: '%' - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: rehabilitation display: Rehabilitation Services - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 7i display: >- Physical Therapy and Speech-Language Pathology Services benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: rehabilitation display: Rehabilitation Services - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 7i display: >- Physical Therapy and Speech-Language Pathology Services cost: - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 65 code: USD system: urn:iso:std:iso:4217 unit: USD - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 100 code: USD system: urn:iso:std:iso:4217 unit: USD - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: mental-health-outpatient display: Mental/Behavioral Health Outpatient Services - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: '7e1' display: >- Individual Sessions for Mental Health Specialty Services benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: mental-health-outpatient display: >- Mental/Behavioral Health Outpatient Services - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: '7e1' display: >- Individual Sessions for Mental Health Specialty Services cost: - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range valueRange: low: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD high: value: 25 code: USD system: urn:iso:std:iso:4217 unit: USD type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 25 code: USD system: urn:iso:std:iso:4217 unit: USD comparator: <= - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 40 code: USD system: urn:iso:std:iso:4217 unit: USD - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: emergency-medical-transport display: Emergency Medical Transportation - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 10a1 display: Ground Ambulance Services benefit: - type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: emergency-medical-transport display: Emergency Medical Transportation - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: 10a1 display: Ground Ambulance Services cost: - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 380 code: USD system: urn:iso:std:iso:4217 unit: USD - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 380 code: USD system: urn:iso:std:iso:4217 unit: USD - category: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: skilled-nursing display: Skilled Nursing Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: '2' display: Skilled Nursing Facility (SNF) benefit: - extension: - url: >- http://hl7.org/fhir/us/insurance-card/StructureDefinition/benefit-limitation extension: - url: limitText valueString: >- Benefit period (in network): Original Medicare type: coding: - system: >- http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category code: skilled-nursing display: Skilled Nursing Care - system: >- https://haau3.com/fhir/CodeSystem/cms-pbp-service-category code: '2' display: Skilled Nursing Facility (SNF) cost: - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range valueRange: low: value: 1 code: d system: http://unitsofmeasure.org unit: d high: value: 20 code: d system: http://unitsofmeasure.org unit: d type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: per-day display: Per day applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range valueRange: low: value: 21 code: d system: http://unitsofmeasure.org unit: d high: value: 100 code: d system: http://unitsofmeasure.org unit: d type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: per-day display: Per day applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: in-network display: In Network value: value: 221 code: USD system: urn:iso:std:iso:4217 unit: USD - extension: - url: >- https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range valueRange: low: value: 1 code: d system: http://unitsofmeasure.org unit: d high: value: 100 code: d system: http://unitsofmeasure.org unit: d type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: per-day display: Per day applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 250 code: USD system: urn:iso:std:iso:4217 unit: USD - type: coding: - system: >- http://terminology.hl7.org/CodeSystem/benefit-type code: copay display: Copayment per service text: Copayment qualifiers: - coding: - system: >- https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier code: per-stay display: Per stay applicability: coding: - system: >- http://terminology.hl7.org/CodeSystem/applicability code: out-of-network display: Out of Network value: value: 0 code: USD system: urn:iso:std:iso:4217 unit: USD headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '400': description: >- The request could not be read: the id is not a valid FHIR id, or a query parameter was sent, and a read takes none. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '401': $ref: '#/components/responses/FhirUnauthorized' '404': description: >- No plan with that id is in the releases being served, or the plan is held but is not a medical plan. The `OperationOutcome` says which. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '406': $ref: '#/components/responses/FhirNotAcceptable' '429': $ref: '#/components/responses/FhirTooManyRequests' '500': $ref: '#/components/responses/FhirServerError' '502': description: >- The plan store could not be read. No answer is given: this is never reported as an empty result or a missing plan. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '503': description: >- No release of the plan files this request needs is being served on this deployment, and the `OperationOutcome` names the program. The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: Retry-After: description: >- Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. How many seconds to wait before sending the request again. schema: type: integer minimum: 0 X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '504': description: The plan store did not respond in time. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' x-codeSamples: - lang: bash label: cURL source: > curl "https://api.haau3.com/v1/fhir/r4/InsurancePlan/H2406-013-000" \ -H "Authorization: Bearer $HAAU3_API_KEY" - lang: typescript label: TypeScript source: > import { Haau3 } from "@haau3/sdk"; const haau3 = new Haau3(); // reads HAAU3_API_KEY const insurancePlan = await haau3.readInsurancePlan("H2406-013-000"); console.log(insurancePlan.id); - lang: python label: Python source: | from haau3 import Haau3 client = Haau3() # reads HAAU3_API_KEY insurance_plan = client.read_insurance_plan("H2406-013-000") print(insurance_plan.get("id")) - lang: go label: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\t\"github.com/haau3/haau3-go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient, err := haau3.NewClient() // reads HAAU3_API_KEY\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tinsurancePlan, err := client.ReadInsurancePlan(ctx, \"H2406-013-000\")\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tif insurancePlan.ID != nil {\n\t\tfmt.Println(*insurancePlan.ID)\n\t}\n}\n" components: parameters: XRequestId: name: X-Request-Id in: header required: false schema: type: string format: uuid description: >- 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. schemas: InsurancePlan: type: object description: A FHIR R4 [InsurancePlan](https://hl7.org/fhir/R4/insuranceplan.html). properties: resourceType: type: string const: InsurancePlan required: - resourceType additionalProperties: true OperationOutcome: type: object description: >- A FHIR R4 [OperationOutcome](https://hl7.org/fhir/R4/operationoutcome.html). properties: resourceType: type: string const: OperationOutcome issue: type: array items: type: object properties: severity: type: string enum: - fatal - error - warning - information code: type: string details: type: object properties: text: type: string additionalProperties: true diagnostics: type: string expression: type: array items: type: string required: - severity - code additionalProperties: true required: - resourceType - issue headers: XRequestId: description: >- The id haau3 gave this request, a UUID, on every response. Quote it in a question about the response. A problem carries the same id as its `instance`. schema: type: string format: uuid XCorrelationId: description: The `X-Request-Id` you sent, when it was a UUID. schema: type: string format: uuid responses: FhirUnauthorized: description: Missing or invalid API key. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: WWW-Authenticate: description: >- The scheme to authenticate with: `Bearer realm="api.haau3.com"`, with `error="invalid_token"` when a key was sent and not recognised. schema: type: string X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirNotAcceptable: description: >- The request asked for a format other than JSON (`Accept` or `_format`), or for a FHIR release this endpoint does not serve (the `fhirVersion` media-type parameter). content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirTooManyRequests: description: >- A limit of the organization's plan was reached: its requests a minute, or the Developer plan's requests a month. Send the request again after `Retry-After`, which for the monthly limit runs to the 1st of the next month (UTC). content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: Retry-After: description: How many seconds to wait before sending the request again. schema: type: integer minimum: 0 X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirServerError: description: The server failed to process this request. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your platform API key (`haau3_sk_…`), sent as `Authorization: Bearer `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.