Data Model Libraries
    Preparing search index...

    EnrollmentResponse Class

    This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.

    FHIR Specification

    • Short: EnrollmentResponse resource
    • Definition: This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
    • FHIR Version: 4.3.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getRequest setRequest hasRequest getOutcomeEnumType setOutcomeEnumType hasOutcomeEnumType getOutcomeElement setOutcomeElement hasOutcomeElement getOutcome setOutcome hasOutcome getDispositionElement setDispositionElement hasDispositionElement getDisposition setDisposition hasDisposition getCreatedElement setCreatedElement hasCreatedElement getCreated setCreated hasCreated getOrganization setOrganization hasOrganization getRequestProvider setRequestProvider hasRequestProvider 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

    Constructors

    Properties

    identifier?: Identifier[]

    EnrollmentResponse.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

    EnrollmentResponse.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 response 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

    request?: Reference

    EnrollmentResponse.request Element

    FHIR Specification

    remittanceOutcomeEnum: RemittanceOutcomeEnum

    FHIR CodeSystem: RemittanceOutcome

    outcome?: EnumCodeType

    EnrollmentResponse.outcome Element

    FHIR Specification

    • Short: queued | complete | error | partial
    • Definition: Processing status: error, complete.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: RemittanceOutcomeEnum

    disposition?: StringType

    EnrollmentResponse.disposition Element

    FHIR Specification

    • Short: Disposition Message
    • Definition: A description of the status of the adjudication.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    created?: DateTimeType

    EnrollmentResponse.created Element

    FHIR Specification

    • Short: Creation date
    • Definition: The date when the enclosed suite of services were performed or completed.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    organization?: Reference

    EnrollmentResponse.organization Element

    FHIR Specification

    requestProvider?: Reference

    EnrollmentResponse.requestProvider Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EnrollmentResponse

      • OptionaloptSourceField: string

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

      Returns undefined | EnrollmentResponse

      EnrollmentResponse data model or undefined for EnrollmentResponse

      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