SEO.JSONLD.HealthInsurancePlan (SEO v0.3.0-rc.0)

View Source

A US-style health insurance plan, including PPOs, EPOs, and HMOs.

Helper for building a Schema.org HealthInsurancePlan JSON-LD structure.

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "HealthInsurancePlan", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a HealthInsurancePlan JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:benefits_summary_url) => URI.t() | String.t(),
    optional(:contact_point) => SEO.JSONLD.ContactPoint.t() | map(),
    optional(:health_plan_drug_option) => String.t(),
    optional(:health_plan_drug_tier) => String.t(),
    optional(:health_plan_id) => String.t(),
    optional(:health_plan_marketing_url) => URI.t() | String.t(),
    optional(:includes_health_plan_formulary) =>
      SEO.JSONLD.HealthPlanFormulary.t() | map(),
    optional(:includes_health_plan_network) =>
      SEO.JSONLD.HealthPlanNetwork.t() | map(),
    optional(:uses_health_plan_id_standard) => String.t() | URI.t(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      benefits_summary_url: URI.t() | String.t(),
      contact_point: SEO.JSONLD.ContactPoint.t() | map(),
      health_plan_drug_option: String.t(),
      health_plan_drug_tier: String.t(),
      health_plan_id: String.t(),
      health_plan_marketing_url: URI.t() | String.t(),
      includes_health_plan_formulary:
        SEO.JSONLD.HealthPlanFormulary.t() | map(),
      includes_health_plan_network: SEO.JSONLD.HealthPlanNetwork.t() | map(),
      uses_health_plan_id_standard: String.t() | URI.t(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "HealthInsurancePlan", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a HealthInsurancePlan JSON-LD map.

Fields

  • :benefits_summary_url - The URL that goes directly to the summary of benefits and coverage for the specific standard plan or plan variation.
  • :contact_point - A contact point for a person or organization.
  • :health_plan_drug_option - TODO.
  • :health_plan_drug_tier - The tier(s) of drugs offered by this formulary or insurance plan.
  • :health_plan_id - The 14-character, HIOS-generated Plan ID number. (Plan IDs must be unique, even across different markets.)
  • :health_plan_marketing_url - The URL that goes directly to the plan brochure for the specific standard plan or plan variation.
  • :includes_health_plan_formulary - Formularies covered by this plan.
  • :includes_health_plan_network - Networks covered by this plan.
  • :uses_health_plan_id_standard - The standard for interpreting the Plan ID. The preferred is "HIOS". See the Centers for Medicare & Medicaid Services for more details.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties: