Medicare Product List Result

The response representation containing ranked Medicare products that match the request filters.

Properties 

Property NameTypeDescription
is​SuccessBooleanIndicates whether the request succeeded (true) or failed (false).
messageStringError or status message returned when isSuccess is false.
offsetIntegerZero-based offset of the first product on this page.
page​SizeIntegerNumber of products returned on this page.
productsList<MedicareProduct>List of Medicare products sorted by match score, with the highest score first.
totalIntegerTotal number of products that match the request across all pages.

Medicare Product 

Medicare product enriched with medications and providers.

Property NameTypeDescription
contri​bution​Cost​AttributesList<AttributeNameValue>Dynamic contribution cost attributes, such as premium cost, deductibles, and employer contribution.
descriptionStringProduct description.
idStringProduct2 ID.
match​ScoreIntegerRanking score based on matched medications and providers. Providers are weighted 2x.
matched​Medication​CountIntegerCount of input medications covered by this product.
matched​Provider​CountIntegerCount of input providers in this product’s network.
medication​Coverage​DetailsList<MedicationCoverageDetail>Medication coverage details for all requested medications when a medicationIds filter is provided. Shows whether each medication is covered by this product.
nameStringProduct name.
pricesList<MedicareProductPriceDetail>Pricing information for this product.
product​CodeStringProduct code.
providersList<HealthcareProviderDetail>Associated healthcare providers that match the input criteria.

Attribute Name Value 

Attribute name and value for contribution cost or another product attribute.

Property NameTypeDescription
nameStringAttribute name, such as Premium Cost, Deductibles, or Employer Contribution.
valueStringAttribute value.

Medication Coverage Detail 

Medication coverage detail that indicates whether a requested medication is covered by the product.

Property NameTypeDescription
formulary​Item​IdStringFormularyItem ID requested by the user.
idStringPlanMedications record ID. Null if the medication isn’t covered.
is​CoveredBooleanIndicates whether the medication is covered by this product (true) or not covered (false).
medication​IdStringMedication ID. Null if the medication isn’t covered.
nameStringFormulary item name. Null if the medication isn’t covered.

Medicare Product Price Detail 

Pricing details for a Medicare product.

Property NameTypeDescription
currency​Iso​CodeStringCurrency ISO code for the price.
is​DefaultBooleanIndicates whether this is the default price.
is​DerivedBooleanIndicates whether this price was derived.
is​SelectedBooleanIndicates whether this price is currently selected.
priceDoubleList price of the product.
price​Book​Entry​IdStringPrice book entry ID.
price​Book​IdStringPrice book ID.
pricing​ModelMedicareProductPricingModelDetailPricing model details.

Medicare Product Pricing Model Detail 

Pricing model details.

Property NameTypeDescription
idStringPricing model ID (ProductSellingModel ID).
nameStringPricing model name, such as One Time or Monthly.
pricing​Model​TypeStringPricing model type, such as OneTime, TermDefined, or Evergreen.

Healthcare Provider Detail 

Healthcare provider detail associated with a product.

Property NameTypeDescription
healthcare​Provider​IdStringHealthcareProvider ID.
idStringPlanHlthCareFacilityNtwrk record ID.
nameStringHealthcare provider name.
network​IdStringHealthcare facility network ID.
provider​TypeStringProvider type or specialty.