core + pending (Pending Extension): these terms are pending wider review. Feedback is welcomed!

HealthPlanCostSharingSpecification

Defined in the pending.schema.org extension.
Canonical URL: http://schema.org/HealthPlanCostSharingSpecification

Thing > Intangible > HealthPlanCostSharingSpecification

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

Usage: Fewer than 10 domains
PropertyExpected TypeDescription
Properties from HealthPlanCostSharingSpecification
healthPlanCoinsuranceOption Text Whether the coinsurance applies before or after deductible, etc. TODO: Is this a closed set?
healthPlanCoinsuranceRate Number Whether The rate of coinsurance expressed as a number between 0.0 and 1.0.
healthPlanCopay PriceSpecification Whether The copay amount.
healthPlanCopayOption Text Whether the copay is before or after deductible, etc. TODO: Is this a closed set?
healthPlanPharmacyCategory Text The category or type of pharmacy associated with this cost sharing.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A description of the item.
disambiguatingDescription Text A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier PropertyValue  or
Text  or
URL 		The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
image ImageObject  or
URL 		An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
URL 		Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
url URL URL of the item.

Source

https://github.com/schemaorg/schemaorg/issues/1062



Examples

Example 1
Without Markup Microdata RDFa JSON-LD 
See JSON example.
Background, https://docs.google.com/document/d/1LNew5OEon4uir2D5Zzp0AkUPA7c9nO8reJ_M1pOy-3s/edit#

TODO

TODO

<script type="application/ld+json">
{
    "@context": "http://health-lifesci.schema.org/",
    "@type": "HealthInsurancePlan",
    "usesHealthPlanIdType": "http://healthplan.schema.org/HealthPlanIdTypeHIOS",
    "healthPlanId": "12345XX9876543",
    "name": "Sample Gold Health Plan",
    "summaryUrl": "http://url/to/summary/benefits/coverage",
    "marketingUrl": "http://url/to/health/plan/information",
    "contactPoint": {
        "@type": "ContactPoint",
        "email": "email@address.com",
    },
    "healthPlanNetworkTiers: ["http://healthplan.schema.org/PreferredNetwork,
                              "http://healthplan.schema.org/NonPreferredNetwork],
    "includesHealthPlanFormulary": [
        {
            "@type": "HealthPlanFormulary",
            "healthPlanDrugTier": "http://healthplan.schema.org/DrugTierGeneric",
            "offersPrescriptionByMail": true,
            "healthPlanCostSharing": [
                {
                    "@type": "HealthPlanCostSharingSpecification",
                    "healthPlanPharmacyType": "1-MONTH-IN-RETAIL",
                    "healthPlanCopay": {
                        "@type": "PriceSpecification",
                        "price": 20,
                        "currency": "USD"
                    },
                    "healthPlanCopayOption": "http://healthplan.schema.org/HealthPlanCopayAfterDeductable",
                    "healthPlanCoinsuranceRate": 0.1,
                    "healthPlanCoinsuranceOption": "http://healthplan.schema.org/HealthPlanCoinsuranceBeforeDeductable"
                },
                {
                   "@type": "HealthPlanCostSharingSpecification",
                    "healthPlanPharmacyType": "1-MONTH-IN-MAIL",
                     "healthPlanCopay": {
                        "@type": "PriceSpecification",
                        "price": 0,
                        "currency": "USD"
                    },
                    "healthPlanCopayOption": "http://healthplan.schema.org/HealthPlanCoPayNoCharge",
                    "healthPlanCoinsuranceRate": 0.2,
                    "healthPlanCoinsuranceOption": "http://healthplan.schema.org/HealthPlanCoinsuranceNone"
                }
            ]
        },
            "healthPlanDrugTier": "http://healthplan.schema.org/DrugTierBrand",
            "offersPrescriptionByMail": true,
            "healthPlanCostSharing": [
                {
                   "@type": "HealthPlanCostSharingSpecification",
                    "healthPlanPharmacyType": "1-MONTH-IN-RETAIL",
                    "healthPlanCopay": {
                        "@type": "PriceSpecification",
                        "price": 15,
                        "currency": "USD"
                    },
                    "healthPlanCopayOption": "http://healthplan.schema.org/HealthPlanCopayNone",
                    "healthPlanCoinsuranceRate": 0,
                    "healthPlanCoinsuranceOption": "http://healthplan.schema.org/HealthPlanCoinsuranceNone"
                },
                {
                   "@type": "HealthPlanCostSharingSpecification",
                    "healthPlanPharmacyType": "1-MONTH-IN-MAIL",
                    "healthPlanCopay": {
                        "@type": "PriceSpecification",
                        "price": 20,
                        "currency": "USD"
                    },
                    "healthPlanCopayOption": "http://healthplan.schema.org/HealthPlanCopayAfterDeductible",
                    "healthPlanCoinsuranceRate": 0.1,
                    "healthPlanCoinsuranceOption": "http://healthplan.schema.org/HealthPlanCoinsuranceBeforeDeductible"
                }
            ]
        }
    ],
}
</script>
Example 2
Without Markup Microdata RDFa JSON-LD 
See JSON example.
Background, https://docs.google.com/document/d/1LNew5OEon4uir2D5Zzp0AkUPA7c9nO8reJ_M1pOy-3s/edit#

TODO

TODO

<script type="application/ld+json">
{
    "@context": "http://health-lifesci.schema.org/",
    "@type": "HealthInsurancePlan",
    "usesHealthPlanIdType": "http://healthplan.schema.org/HealthPlanIdTypeHIOS",
    "healthPlanId": "12345XX9876543",
    "name": "Sample Gold Health Plan",
    "summaryUrl": "http://url/to/summary/benefits/coverage",
    "marketingUrl": "http://url/to/health/plan/information",
    "contactPoint": {
        "@type": "ContactPoint",
        "email": "email@address.com",
    },
    "healthPlanNetworkTiers: ["http://healthplan.schema.org/PreferredNetwork,
                              "http://healthplan.schema.org/NonPreferredNetwork],
    "includesHealthPlanFormulary": [
        {
            "@type": "HealthPlanFormulary",
            "healthPlanDrugTier": "http://healthplan.schema.org/DrugTierGeneric",
            "offersPrescriptionByMail": true,
            "healthPlanCostSharing": [
                {
                    "@type": "HealthPlanCostSharingSpecification",
                    "healthPlanPharmacyType": "1-MONTH-IN-RETAIL",
                    "healthPlanCopay": {
                        "@type": "PriceSpecification",
                        "price": 20,
                        "currency": "USD"
                    },
                    "healthPlanCopayOption": "http://healthplan.schema.org/HealthPlanCopayAfterDeductable",
                    "healthPlanCoinsuranceRate": 0.1,
                    "healthPlanCoinsuranceOption": "http://healthplan.schema.org/HealthPlanCoinsuranceBeforeDeductable"
                },
                {
                   "@type": "HealthPlanCostSharingSpecification",
                    "healthPlanPharmacyType": "1-MONTH-IN-MAIL",
                     "healthPlanCopay": {
                        "@type": "PriceSpecification",
                        "price": 0,
                        "currency": "USD"
                    },
                    "healthPlanCopayOption": "http://healthplan.schema.org/HealthPlanCoPayNoCharge",
                    "healthPlanCoinsuranceRate": 0.2,
                    "healthPlanCoinsuranceOption": "http://healthplan.schema.org/HealthPlanCoinsuranceNone"
                }
            ]
        },
            "healthPlanDrugTier": "http://healthplan.schema.org/DrugTierBrand",
            "offersPrescriptionByMail": true,
            "healthPlanCostSharing": [
                {
                   "@type": "HealthPlanCostSharingSpecification",
                    "healthPlanPharmacyType": "1-MONTH-IN-RETAIL",
                    "healthPlanCopay": {
                        "@type": "PriceSpecification",
                        "price": 15,
                        "currency": "USD"
                    },
                    "healthPlanCopayOption": "http://healthplan.schema.org/HealthPlanCopayNone",
                    "healthPlanCoinsuranceRate": 0,
                    "healthPlanCoinsuranceOption": "http://healthplan.schema.org/HealthPlanCoinsuranceNone"
                },
                {
                   "@type": "HealthPlanCostSharingSpecification",
                    "healthPlanPharmacyType": "1-MONTH-IN-MAIL",
                    "healthPlanCopay": {
                        "@type": "PriceSpecification",
                        "price": 20,
                        "currency": "USD"
                    },
                    "healthPlanCopayOption": "http://healthplan.schema.org/HealthPlanCopayAfterDeductible",
                    "healthPlanCoinsuranceRate": 0.1,
                    "healthPlanCoinsuranceOption": "http://healthplan.schema.org/HealthPlanCoinsuranceBeforeDeductible"
                }
            ]
        }
    ],
}
</script>

Schema Version 3.2