Data Model Libraries
    Preparing search index...

    Class ImmunizationProgramEligibilityComponent

    ImmunizationProgramEligibilityComponent Class

    FHIR Specification

    • Short: Patient eligibility for a specific vaccination program
    • Definition: Indicates a patient's eligibility for a funding program.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    program: null | CodeableConcept

    Immunization.programEligibility.program Element

    FHIR Specification

    • Short: The program that eligibility is declared for
    • Definition: Indicates which program the patient had their eligility evaluated for.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    programStatus: null | CodeableConcept

    Immunization.programEligibility.programStatus Element

    FHIR Specification

    • Short: The patient's eligibility status for the program
    • Definition: Indicates the patient's eligility status for for a specific payment program.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImmunizationProgramEligibilityComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImmunizationProgramEligibilityComponent

      ImmunizationProgramEligibilityComponent data model or undefined for ImmunizationProgramEligibilityComponent

      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