Data Model Libraries
    Preparing search index...

    CoverageClassComponent Class

    FHIR Specification

    • Short: Additional coverage classifications
    • Definition: A suite of underwriter specific classifiers.
    • Comment: For example may be used to identify a class of coverage or employer group, Policy, Plan.
    • Requirements: The codes provided on the health card which identify or confirm the specific policy for the insurer.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_: null | CodeableConcept

    Coverage.class.type Element

    FHIR Specification

    • Short: Type of class such as 'group' or 'plan'
    • Definition: The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.
    • Requirements: The insurer issued label for a specific health card value.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    value: null | StringType

    Coverage.class.value Element

    FHIR Specification

    • Short: Value associated with the type
    • Definition: The alphanumeric string value associated with the insurer issued label.
    • Comment: For example, the Group or Plan number.
    • Requirements: The insurer issued label and value are necessary to identify the specific policy.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    FHIR Specification

    • Short: Human readable description of the type and value
    • Definition: A short description for the class.
    • Requirements: Used to provide a meaningful description in correspondence to the patient.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CoverageClassComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CoverageClassComponent

      CoverageClassComponent data model or undefined for CoverageClassComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise