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

View Source

A description of costs to the patient under a given network or formulary.

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

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "HealthPlanCostSharingSpecification", 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 HealthPlanCostSharingSpecification JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:health_plan_coinsurance_option) => String.t(),
    optional(:health_plan_coinsurance_rate) => number(),
    optional(:health_plan_copay) => SEO.JSONLD.PriceSpecification.t() | map(),
    optional(:health_plan_copay_option) => String.t(),
    optional(:health_plan_pharmacy_category) => String.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()
  }
  | [
      health_plan_coinsurance_option: String.t(),
      health_plan_coinsurance_rate: number(),
      health_plan_copay: SEO.JSONLD.PriceSpecification.t() | map(),
      health_plan_copay_option: String.t(),
      health_plan_pharmacy_category: String.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 "HealthPlanCostSharingSpecification", 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 HealthPlanCostSharingSpecification JSON-LD map.

Fields

  • :health_plan_coinsurance_option - Whether the coinsurance applies before or after deductible, etc. TODO: Is this a closed set?
  • :health_plan_coinsurance_rate - The rate of coinsurance expressed as a number between 0.0 and 1.0.
  • :health_plan_copay - The copay amount.
  • :health_plan_copay_option - Whether the copay is before or after deductible, etc. TODO: Is this a closed set?
  • :health_plan_pharmacy_category - The category or type of pharmacy associated with this cost sharing.

Inherited properties

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