Data Model Libraries
    Preparing search index...

    InsurancePlanPlanComponent Class

    FHIR Specification

    • Short: Plan details
    • Definition: Details about an insurance plan.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    identifier?: Identifier[]

    InsurancePlan.plan.identifier Element

    FHIR Specification

    • Short: Business Identifier for Product
    • Definition: Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    InsurancePlan.plan.type Element

    FHIR Specification

    • Short: Type of plan
    • Definition: Type of plan. For example, "Platinum" or "High Deductable".
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    coverageArea?: Reference[]

    InsurancePlan.plan.coverageArea Element

    FHIR Specification

    • Short: Where product applies
    • Definition: The geographic region in which a health insurance plan's benefits apply.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    network?: Reference[]

    InsurancePlan.plan.network Element

    FHIR Specification

    • Short: What networks provide coverage
    • Definition: Reference to the network that providing the type of coverage.
    • Comment: Networks are represented as a hierarchy of organization resources.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    InsurancePlan.plan.generalCost Element

    FHIR Specification

    • Short: Overall costs
    • Definition: Overall costs associated with the plan.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    InsurancePlan.plan.specificCost Element

    FHIR Specification

    • Short: Specific costs
    • Definition: Costs associated with the coverage provided by the product.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided InsurancePlanPlanComponent JSON to instantiate the InsurancePlanPlanComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR InsurancePlanPlanComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to InsurancePlanPlanComponent

      Returns undefined | InsurancePlanPlanComponent

      InsurancePlanPlanComponent data model or undefined for InsurancePlanPlanComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise