Data Model Libraries
    Preparing search index...

    EnrollmentRequest Class

    This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

    FHIR Specification

    • Short: Enroll in coverage
    • Definition: This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    identifier?: Identifier[]

    EnrollmentRequest.identifier Element

    FHIR Specification

    • Short: Business Identifier
    • Definition: The Response business identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    fmStatusEnum: FmStatusEnum

    FHIR CodeSystem: FmStatus

    status?: EnumCodeType

    EnrollmentRequest.status Element

    FHIR Specification

    • Short: active | cancelled | draft | entered-in-error
    • Definition: The status of the resource instance.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the request as not currently valid.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: FmStatusEnum

    created?: DateTimeType

    EnrollmentRequest.created Element

    FHIR Specification

    • Short: Creation date
    • Definition: The date when this resource was created.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    insurer?: Reference

    EnrollmentRequest.insurer Element

    FHIR Specification

    provider?: Reference

    EnrollmentRequest.provider Element

    FHIR Specification

    candidate?: Reference

    EnrollmentRequest.candidate Element

    FHIR Specification

    coverage?: Reference

    EnrollmentRequest.coverage Element

    FHIR Specification

    • Short: Insurance information
    • Definition: Reference to the program or plan identification, underwriter or payor.
    • Requirements: Need to identify the issuer to target for processing and for coordination of benefit processing.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EnrollmentRequest

      • OptionaloptSourceField: string

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

      Returns undefined | EnrollmentRequest

      EnrollmentRequest data model or undefined for EnrollmentRequest

      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