Data Model Libraries
    Preparing search index...

    Class InsurancePlan

    InsurancePlan Class

    Details of a Health Insurance product/plan provided by an organization.

    FHIR Specification

    • Short: Details of a Health Insurance product/plan provided by an organization
    • Definition: Details of a Health Insurance product/plan provided by an organization.
    • FHIR Version: 4.3.0

    FHIR InsurancePlan

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? publicationStatusEnum status? type_? name? alias? period? ownedBy? administeredBy? coverageArea? contact? endpoint? network? coverage? plan?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getType setType addType hasType getNameElement setNameElement hasNameElement getName setName hasName getAliasElement setAliasElement addAliasElement hasAliasElement getAlias setAlias addAlias hasAlias getPeriod setPeriod hasPeriod getOwnedBy setOwnedBy hasOwnedBy getAdministeredBy setAdministeredBy hasAdministeredBy getCoverageArea setCoverageArea addCoverageArea hasCoverageArea getContact setContact addContact hasContact getEndpoint setEndpoint addEndpoint hasEndpoint getNetwork setNetwork addNetwork hasNetwork getCoverage setCoverage addCoverage hasCoverage getPlan setPlan addPlan hasPlan fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initType initAlias initCoverageArea initContact initEndpoint initNetwork initCoverage initPlan

    Constructors

    Properties

    identifier?: Identifier[]

    InsurancePlan.identifier Element

    FHIR Specification

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

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status?: EnumCodeType

    InsurancePlan.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The current state of the health insurance product.
    • Requirements: Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains codes which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    Private Optionaltype_

    type_?: CodeableConcept[]

    InsurancePlan.type Element

    FHIR Specification

    • Short: Kind of product
    • Definition: The kind of health insurance product.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    name?: StringType

    InsurancePlan.name Element

    FHIR Specification

    • Short: Official name
    • Definition: Official name of the health insurance product as designated by the owner.
    • Comment: If the name of the product/plan changes, consider putting the old name in the alias column so that it can still be located through searches.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    alias?: StringType[]

    InsurancePlan.alias Element

    FHIR Specification

    • Short: Alternate names
    • Definition: A list of alternate names that the product is known as, or was known as in the past.
    • Comment: There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the product/plan.
    • Requirements: Over time products/plans go through many changes and can be known by different names. For searching knowing previous names that the product/plan was known by can be very useful.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    period?: Period

    InsurancePlan.period Element

    FHIR Specification

    • Short: When the product is available
    • Definition: The period of time that the health insurance product is available.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    ownedBy?: Reference

    InsurancePlan.ownedBy Element

    FHIR Specification

    • Short: Plan issuer
    • Definition: The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    administeredBy?: Reference

    InsurancePlan.administeredBy Element

    FHIR Specification

    • Short: Product administrator
    • Definition: An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    coverageArea?: Reference[]

    InsurancePlan.coverageArea Element

    FHIR Specification

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

    InsurancePlan.contact Element

    FHIR Specification

    • Short: Contact for the product
    • Definition: The contact for the health insurance product for a certain purpose.
    • Comment: Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
    • Requirements: Need to keep track of assigned contact points within bigger organization.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endpoint?: Reference[]

    InsurancePlan.endpoint Element

    FHIR Specification

    • Short: Technical endpoint
    • Definition: The technical endpoints providing access to services operated for the health insurance product.
    • Requirements: Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    network?: Reference[]

    InsurancePlan.network Element

    FHIR Specification

    • Short: What networks are Included
    • Definition: Reference to the network included in the health insurance product.
    • Comment: Networks are represented as a hierarchy of organization resources.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    coverage?: InsurancePlanCoverageComponent[]

    InsurancePlan.coverage Element

    FHIR Specification

    • Short: Coverage details
    • Definition: Details about the coverage offered by the insurance product.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    plan?: InsurancePlanPlanComponent[]

    InsurancePlan.plan Element

    FHIR Specification

    • Short: Plan details
    • Definition: Details about an insurance plan.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR InsurancePlan

      • OptionaloptSourceField: string

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

      Returns undefined | InsurancePlan

      InsurancePlan data model or undefined for InsurancePlan

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetTypesetTypeaddTypehasTypegetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetAliasElementsetAliasElementaddAliasElementhasAliasElementgetAliassetAliasaddAliashasAliasgetPeriodsetPeriodhasPeriodgetOwnedBysetOwnedByhasOwnedBygetAdministeredBysetAdministeredByhasAdministeredBygetCoverageAreasetCoverageAreaaddCoverageAreahasCoverageAreagetContactsetContactaddContacthasContactgetEndpointsetEndpointaddEndpointhasEndpointgetNetworksetNetworkaddNetworkhasNetworkgetCoveragesetCoverageaddCoveragehasCoveragegetPlansetPlanaddPlanhasPlanfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitTypeinitAliasinitCoverageAreainitContactinitEndpointinitNetworkinitCoverageinitPlan