Class CoverageEligibilityResponse

CoverageEligibilityResponse Class

Remarks

This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

FHIR Specification

Short: CoverageEligibilityResponse resource
Definition: This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
FHIR Version: 5.0.0

See

FHIR CoverageEligibilityResponse

Hierarchy (View Summary)

DomainResource
- CoverageEligibilityResponse

Implements

IDomainResource

Index

Constructors

constructor

new CoverageEligibilityResponse(
    status?: null | string | CodeType | EnumCodeType,
    purpose?: null | string[] | EnumCodeType[] | CodeType[],
    patient?: null | Reference,
    created?: null | string | DateTimeType,
    request?: null | Reference,
    outcome?: null | string | CodeType | EnumCodeType,
    insurer?: null | Reference,
): CoverageEligibilityResponse
Parameters
- status: null | string | CodeType | EnumCodeType = null
- purpose: null | string[] | EnumCodeType[] | CodeType[] = null
- patient: null | Reference = null
- created: null | string | DateTimeType = null
- request: null | Reference = null
- outcome: null | string | CodeType | EnumCodeType = null
- insurer: null | Reference = null
Returns CoverageEligibilityResponse
Overrides DomainResource.constructor
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:119

Properties

`Private` `Optional`identifier

identifier?: Identifier[]

CoverageEligibilityResponse.identifier Element

Remarks

FHIR Specification

Short: Business Identifier for coverage eligiblity request
Definition: A unique identifier assigned to this coverage eligiblity request.
Requirements: Allows coverage eligibility requests to be distinguished and referenced.
FHIR Type: Identifier
Cardinality: 0..*
isModifier: false
isSummary: false

`Private` `Readonly`fmStatusEnum

fmStatusEnum: FmStatusEnum

FHIR CodeSystem: FmStatus

See

FmStatusEnum

`Private`status

status: null | EnumCodeType

CoverageEligibilityResponse.status Element

Remarks

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 resource as not currently valid.
Requirements: Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.
FHIR Type: code
Cardinality: 1..1
isModifier: true
isModifierReason: This element is labeled 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

See

CodeSystem Enumeration: FmStatusEnum

`Private` `Readonly`eligibilityresponsePurposeEnum

eligibilityresponsePurposeEnum: EligibilityresponsePurposeEnum

FHIR CodeSystem: EligibilityresponsePurpose

See

EligibilityresponsePurposeEnum

`Private`purpose

purpose: null | EnumCodeType[]

CoverageEligibilityResponse.purpose Element

Remarks

FHIR Specification

Short: auth-requirements | benefits | discovery | validation
Definition: Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.
Requirements: To indicate the processing actions requested.
FHIR Type: code
Cardinality: 1..*
isModifier: false
isSummary: true

See

CodeSystem Enumeration: EligibilityresponsePurposeEnum

`Private`patient

patient: null | Reference

CoverageEligibilityResponse.patient Element

Remarks

FHIR Specification

Short: Intended recipient of products and services
Definition: The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.
Requirements: Required to provide context and coverage validation.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Patient', ]
Cardinality: 1..1
isModifier: false
isSummary: true

`Private` `Optional`event

event?: CoverageEligibilityResponseEventComponent[]

CoverageEligibilityResponse.event Element

Remarks

FHIR Specification

Short: Event information
Definition: Information code for an event with a corresponding date or period.
FHIR Type: BackboneElement
Cardinality: 0..*
isModifier: false
isSummary: false

`Private` `Optional`serviced

serviced?: IDataType

CoverageEligibilityResponse.serviced[x] Element

Decorator

@ChoiceDataTypesMeta('CoverageEligibilityResponse.serviced[x]', ['date','Period',]

Remarks

FHIR Specification

Short: Estimated date or dates of service
Definition: The date or dates when the enclosed suite of services were performed or completed.
Requirements: Required to provide time context for the request.
FHIR Types: 'date', 'Period',
Cardinality: 0..1
isModifier: false
isSummary: false

`Private`created

created: null | DateTimeType

CoverageEligibilityResponse.created Element

Remarks

FHIR Specification

Short: Response creation date
Definition: The date this resource was created.
Requirements: Need to record a timestamp for use by both the recipient and the issuer.
FHIR Type: dateTime
Cardinality: 1..1
isModifier: false
isSummary: true

`Private` `Optional`requestor

requestor?: Reference

CoverageEligibilityResponse.requestor Element

Remarks

FHIR Specification

Short: Party responsible for the request
Definition: The provider which is responsible for the request.
Comment: This party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below. This field is the Billing Provider, for example, a facility, provider group, lab or practitioner.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/Organization', ]
Cardinality: 0..1
isModifier: false
isSummary: false

`Private`request

request: null | Reference

CoverageEligibilityResponse.request Element

Remarks

FHIR Specification

Short: Eligibility request reference
Definition: Reference to the original request resource.
Requirements: Needed to allow the response to be linked to the request.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest', ]
Cardinality: 1..1
isModifier: false
isSummary: true

`Private` `Readonly`eligibilityOutcomeEnum

eligibilityOutcomeEnum: EligibilityOutcomeEnum

FHIR CodeSystem: EligibilityOutcome

See

EligibilityOutcomeEnum

`Private`outcome

outcome: null | EnumCodeType

CoverageEligibilityResponse.outcome Element

Remarks

FHIR Specification

Short: queued | complete | error | partial
Definition: The outcome of the request processing.
Comment: The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).
Requirements: To advise the requestor of an overall processing outcome.
FHIR Type: code
Cardinality: 1..1
isModifier: false
isSummary: true

See

CodeSystem Enumeration: EligibilityOutcomeEnum

`Private` `Optional`disposition

disposition?: StringType

CoverageEligibilityResponse.disposition Element

Remarks

FHIR Specification

Short: Disposition Message
Definition: A human readable description of the status of the adjudication.
Requirements: Provided for user display.
FHIR Type: string
Cardinality: 0..1
isModifier: false
isSummary: false

`Private`insurer

insurer: null | Reference

CoverageEligibilityResponse.insurer Element

Remarks

FHIR Specification

Short: Coverage issuer
Definition: The Insurer who issued the coverage in question and is the author of the response.
Requirements: Need to identify the author.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Organization', ]
Cardinality: 1..1
isModifier: false
isSummary: true

`Private` `Optional`insurance

insurance?: CoverageEligibilityResponseInsuranceComponent[]

CoverageEligibilityResponse.insurance Element

Remarks

FHIR Specification

Short: Patient insurance information
Definition: Financial instruments for reimbursement for the health care products and services.
Comment: All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.
Requirements: There must be at least one coverage for which eligibility is requested.
FHIR Type: BackboneElement
Cardinality: 0..*
isModifier: false
isSummary: false

`Private` `Optional`preAuthRef

preAuthRef?: StringType

CoverageEligibilityResponse.preAuthRef Element

Remarks

FHIR Specification

Short: Preauthorization reference
Definition: A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.
Requirements: To provide any preauthorization reference for provider use.
FHIR Type: string
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`form

form?: CodeableConcept

CoverageEligibilityResponse.form Element

Remarks

FHIR Specification

Short: Printed form identifier
Definition: A code for the form to be used for printing the content.
Comment: May be needed to identify specific jurisdictional forms.
Requirements: Needed to specify the specific form used for producing output for this response.
FHIR Type: CodeableConcept
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`error

error?: CoverageEligibilityResponseErrorComponent[]

CoverageEligibilityResponse.error Element

Remarks

FHIR Specification

Short: Processing errors
Definition: Errors encountered during the processing of the request.
Requirements: Need to communicate processing issues to the requestor.
FHIR Type: BackboneElement
Cardinality: 0..*
isModifier: false
isSummary: false

Methods

`Static`parse

parse(
sourceJson: Value,
optSourceField?: string,
): undefined | CoverageEligibilityResponse
Parse the provided CoverageEligibilityResponse JSON to instantiate the CoverageEligibilityResponse data model.
Parameters
- sourceJson: Value
  JSON representing FHIR CoverageEligibilityResponse
- OptionaloptSourceField: string
  Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CoverageEligibilityResponse
Returns undefined | CoverageEligibilityResponse
CoverageEligibilityResponse data model or undefined for CoverageEligibilityResponse

Throws
JsonError if the provided JSON is not a valid JSON object
Overrides DomainResource.parse
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:180

getIdentifier

getIdentifier(): Identifier[]
Returns Identifier[]
the identifier property value as a Identifier array
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:719

setIdentifier

setIdentifier(value: undefined | Identifier[]): this
Assigns the provided Identifier array value to the identifier property.
Parameters
- value: undefined | Identifier[]
  the identifier array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:730

addIdentifier

addIdentifier(value: undefined | Identifier): this
Add the provided Identifier value to the identifier array property.
Parameters
- value: undefined | Identifier
  the identifier value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:748

hasIdentifier

hasIdentifier(): boolean
Returns boolean
true if the identifier property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:761

getStatusEnumType

getStatusEnumType(): null | EnumCodeType
Returns null | EnumCodeType
the status property value as a EnumCodeType if defined; else null

See
CodeSystem Enumeration: FmStatusEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:779

setStatusEnumType

setStatusEnumType(enumType: undefined | null | EnumCodeType): this
Assigns the provided EnumCodeType value to the status property.
Parameters
- enumType: undefined | null | EnumCodeType
  the status value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: FmStatusEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:793

hasStatusEnumType

hasStatusEnumType(): boolean
Returns boolean
true if the status property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:807

getStatusElement

getStatusElement(): null | CodeType
Returns null | CodeType
the status property value as a CodeType if defined; else null

See
CodeSystem Enumeration: FmStatusEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:816

setStatusElement

setStatusElement(element: undefined | null | CodeType): this
Assigns the provided PrimitiveType value to the status property.
Parameters
- element: undefined | null | CodeType
  the status value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: FmStatusEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:833

hasStatusElement

hasStatusElement(): boolean
Returns boolean
true if the status property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:847

getStatus

getStatus(): null | string
Returns null | string
the status property value as a fhirCode if defined; else null

See
CodeSystem Enumeration: FmStatusEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:856

setStatus

setStatus(value: undefined | null | string): this
Assigns the provided primitive value to the status property.
Parameters
- value: undefined | null | string
  the status value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: FmStatusEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:873

hasStatus

hasStatus(): boolean
Returns boolean
true if the status property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:886

getPurposeEnumType

getPurposeEnumType(): EnumCodeType[]
Returns EnumCodeType[]
the purpose property value as a EnumCodeType array

See
CodeSystem Enumeration: EligibilityresponsePurposeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:895

setPurposeEnumType

setPurposeEnumType(enumType: undefined | null | EnumCodeType[]): this
Assigns the provided EnumCodeType array value to the purpose property.
Parameters
- enumType: undefined | null | EnumCodeType[]
  the purpose array value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: EligibilityresponsePurposeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:909

addPurposeEnumType

addPurposeEnumType(enumType: EnumCodeType): this
Add the provided EnumCodeType value to the purpose array property.
Parameters
- enumType: EnumCodeType
  the purpose value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: EligibilityresponsePurposeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:930

hasPurposeEnumType

hasPurposeEnumType(): boolean
Returns boolean
true if the purpose property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:943

getPurposeElement

getPurposeElement(): CodeType[]
Returns CodeType[]
the purpose property value as a CodeType array

See
CodeSystem Enumeration: EligibilityresponsePurposeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:952

setPurposeElement

setPurposeElement(element: undefined | null | CodeType[]): this
Assigns the provided PrimitiveType array value to the purpose property.
Parameters
- element: undefined | null | CodeType[]
  the purpose array value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: EligibilityresponsePurposeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:969

addPurposeElement

addPurposeElement(element: CodeType): this
Add the provided PrimitiveType value to the purpose array property.
Parameters
- element: CodeType
  the purpose value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: EligibilityresponsePurposeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:994

hasPurposeElement

hasPurposeElement(): boolean
Returns boolean
true if the purpose property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1007

getPurpose

getPurpose(): string[]
Returns string[]
the purpose property value as a fhirCode array

See
CodeSystem Enumeration: EligibilityresponsePurposeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1016

setPurpose

setPurpose(value: undefined | null | string[]): this
Assigns the provided primitive value array to the purpose property.
Parameters
- value: undefined | null | string[]
  the purpose value array
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: EligibilityresponsePurposeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1037

addPurpose

addPurpose(value: string): this
Add the provided primitive value to the purpose array property.
Parameters
- value: string
  the purpose value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: EligibilityresponsePurposeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1061

hasPurpose

hasPurpose(): boolean
Returns boolean
true if the purpose property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1073

getPatient

getPatient(): Reference
Returns Reference
the patient property value as a Reference object if defined; else an empty Reference object
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1089

setPatient

setPatient(value: undefined | null | Reference): this
Assigns the provided Patient object value to the patient property.
Parameters
- value: undefined | null | Reference
  the patient object value
Returns this
this

Decorator
@ReferenceTargets('CoverageEligibilityResponse.patient', ['Patient',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1105

hasPatient

hasPatient(): boolean
Returns boolean
true if the patient property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1118

getEvent

getEvent(): CoverageEligibilityResponseEventComponent[]
Returns CoverageEligibilityResponseEventComponent[]
the event property value as a CoverageEligibilityResponseEventComponent array
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1125

setEvent

setEvent(value: undefined | CoverageEligibilityResponseEventComponent[]): this
Assigns the provided CoverageEligibilityResponseEventComponent array value to the event property.
Parameters
- value: undefined | CoverageEligibilityResponseEventComponent[]
  the event array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1136

addEvent

addEvent(value: undefined | CoverageEligibilityResponseEventComponent): this
Add the provided CoverageEligibilityResponseEventComponent value to the event array property.
Parameters
- value: undefined | CoverageEligibilityResponseEventComponent
  the event value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1154

hasEvent

hasEvent(): boolean
Returns boolean
true if the event property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1167

getServiced

getServiced(): undefined | IDataType
Returns undefined | IDataType
the serviced property value as a DataType object if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1183

setServiced

setServiced(value: undefined | IDataType): this
Assigns the provided DataType object value to the serviced property.
Parameters
- value: undefined | IDataType
  the serviced object value
Returns this
this

Decorator
@ChoiceDataTypes('CoverageEligibilityResponse.serviced[x]')

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1197

hasServiced

hasServiced(): boolean
Returns boolean
true if the serviced property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1210

getServicedDateType

getServicedDateType(): undefined | DateType
Returns undefined | DateType
the serviced property value as a DateType object if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1220

hasServicedDateType

hasServicedDateType(): boolean
Returns boolean
true if the serviced property exists as a DateType and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1235

getServicedPeriod

getServicedPeriod(): undefined | Period
Returns undefined | Period
the serviced property value as a Period object if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1242

hasServicedPeriod

hasServicedPeriod(): boolean
Returns boolean
true if the serviced property exists as a Period and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1257

getCreatedElement

getCreatedElement(): DateTimeType
Returns DateTimeType
the created property value as a DateTimeType object if defined; else an empty DateTimeType object
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1266

setCreatedElement

setCreatedElement(element: undefined | null | DateTimeType): this
Assigns the provided PrimitiveType value to the created property.
Parameters
- element: undefined | null | DateTimeType
  the created value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1278

hasCreatedElement

hasCreatedElement(): boolean
Returns boolean
true if the created property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1292

getCreated

getCreated(): null | string
Returns null | string
the created property value as a fhirDateTime if defined; else null
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1299

setCreated

setCreated(value: undefined | null | string): this
Assigns the provided primitive value to the created property.
Parameters
- value: undefined | null | string
  the created value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1314

hasCreated

hasCreated(): boolean
Returns boolean
true if the created property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1327

getRequestor

getRequestor(): Reference
Returns Reference
the requestor property value as a Reference object; else an empty Reference object
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1334

setRequestor

setRequestor(value: undefined | Reference): this
Assigns the provided Requestor object value to the requestor property.
Parameters
- value: undefined | Reference
  the requestor object value
Returns this
this

Decorator
@ReferenceTargets('CoverageEligibilityResponse.requestor', ['Practitioner','PractitionerRole','Organization',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1354

hasRequestor

hasRequestor(): boolean
Returns boolean
true if the requestor property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1367

getRequest

getRequest(): Reference
Returns Reference
the request property value as a Reference object if defined; else an empty Reference object
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1374

setRequest

setRequest(value: undefined | null | Reference): this
Assigns the provided Request object value to the request property.
Parameters
- value: undefined | null | Reference
  the request object value
Returns this
this

Decorator
@ReferenceTargets('CoverageEligibilityResponse.request', ['CoverageEligibilityRequest',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1390

hasRequest

hasRequest(): boolean
Returns boolean
true if the request property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1403

getOutcomeEnumType

getOutcomeEnumType(): null | EnumCodeType
Returns null | EnumCodeType
the outcome property value as a EnumCodeType if defined; else null

See
CodeSystem Enumeration: EligibilityOutcomeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1412

setOutcomeEnumType

setOutcomeEnumType(enumType: undefined | null | EnumCodeType): this
Assigns the provided EnumCodeType value to the outcome property.
Parameters
- enumType: undefined | null | EnumCodeType
  the outcome value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: EligibilityOutcomeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1426

hasOutcomeEnumType

hasOutcomeEnumType(): boolean
Returns boolean
true if the outcome property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1440

getOutcomeElement

getOutcomeElement(): null | CodeType
Returns null | CodeType
the outcome property value as a CodeType if defined; else null

See
CodeSystem Enumeration: EligibilityOutcomeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1449

setOutcomeElement

setOutcomeElement(element: undefined | null | CodeType): this
Assigns the provided PrimitiveType value to the outcome property.
Parameters
- element: undefined | null | CodeType
  the outcome value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: EligibilityOutcomeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1466

hasOutcomeElement

hasOutcomeElement(): boolean
Returns boolean
true if the outcome property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1480

getOutcome

getOutcome(): null | string
Returns null | string
the outcome property value as a fhirCode if defined; else null

See
CodeSystem Enumeration: EligibilityOutcomeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1489

setOutcome

setOutcome(value: undefined | null | string): this
Assigns the provided primitive value to the outcome property.
Parameters
- value: undefined | null | string
  the outcome value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: EligibilityOutcomeEnum
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1506

hasOutcome

hasOutcome(): boolean
Returns boolean
true if the outcome property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1519

getDispositionElement

getDispositionElement(): StringType
Returns StringType
the disposition property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1526

setDispositionElement

setDispositionElement(element: undefined | StringType): this
Assigns the provided PrimitiveType value to the disposition property.
Parameters
- element: undefined | StringType
  the disposition value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1538

hasDispositionElement

hasDispositionElement(): boolean
Returns boolean
true if the disposition property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1552

getDisposition

getDisposition(): undefined | string
Returns undefined | string
the disposition property value as a fhirString if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1559

setDisposition

setDisposition(value: undefined | string): this
Assigns the provided primitive value to the disposition property.
Parameters
- value: undefined | string
  the disposition value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1570

hasDisposition

hasDisposition(): boolean
Returns boolean
true if the disposition property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1583

getInsurer

getInsurer(): Reference
Returns Reference
the insurer property value as a Reference object if defined; else an empty Reference object
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1590

setInsurer

setInsurer(value: undefined | null | Reference): this
Assigns the provided Insurer object value to the insurer property.
Parameters
- value: undefined | null | Reference
  the insurer object value
Returns this
this

Decorator
@ReferenceTargets('CoverageEligibilityResponse.insurer', ['Organization',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1606

hasInsurer

hasInsurer(): boolean
Returns boolean
true if the insurer property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1619

getInsurance

getInsurance(): CoverageEligibilityResponseInsuranceComponent[]
Returns CoverageEligibilityResponseInsuranceComponent[]
the insurance property value as a CoverageEligibilityResponseInsuranceComponent array
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1626

setInsurance

setInsurance(
value: undefined | CoverageEligibilityResponseInsuranceComponent[],
): this
Assigns the provided CoverageEligibilityResponseInsuranceComponent array value to the insurance property.
Parameters
- value: undefined | CoverageEligibilityResponseInsuranceComponent[]
  the insurance array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1637

addInsurance

addInsurance(
value: undefined | CoverageEligibilityResponseInsuranceComponent,
): this
Add the provided CoverageEligibilityResponseInsuranceComponent value to the insurance array property.
Parameters
- value: undefined | CoverageEligibilityResponseInsuranceComponent
  the insurance value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1655

hasInsurance

hasInsurance(): boolean
Returns boolean
true if the insurance property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1668

getPreAuthRefElement

getPreAuthRefElement(): StringType
Returns StringType
the preAuthRef property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1684

setPreAuthRefElement

setPreAuthRefElement(element: undefined | StringType): this
Assigns the provided PrimitiveType value to the preAuthRef property.
Parameters
- element: undefined | StringType
  the preAuthRef value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1696

hasPreAuthRefElement

hasPreAuthRefElement(): boolean
Returns boolean
true if the preAuthRef property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1710

getPreAuthRef

getPreAuthRef(): undefined | string
Returns undefined | string
the preAuthRef property value as a fhirString if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1717

setPreAuthRef

setPreAuthRef(value: undefined | string): this
Assigns the provided primitive value to the preAuthRef property.
Parameters
- value: undefined | string
  the preAuthRef value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1728

hasPreAuthRef

hasPreAuthRef(): boolean
Returns boolean
true if the preAuthRef property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1741

getForm

getForm(): CodeableConcept
Returns CodeableConcept
the form property value as a CodeableConcept object if defined; else an empty CodeableConcept object
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1748

setForm

setForm(value: undefined | CodeableConcept): this
Assigns the provided Form object value to the form property.
Parameters
- value: undefined | CodeableConcept
  the form object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1759

hasForm

hasForm(): boolean
Returns boolean
true if the form property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1773

getError

getError(): CoverageEligibilityResponseErrorComponent[]
Returns CoverageEligibilityResponseErrorComponent[]
the error property value as a CoverageEligibilityResponseErrorComponent array
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1780

setError

setError(value: undefined | CoverageEligibilityResponseErrorComponent[]): this
Assigns the provided CoverageEligibilityResponseErrorComponent array value to the error property.
Parameters
- value: undefined | CoverageEligibilityResponseErrorComponent[]
  the error array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1791

addError

addError(value: undefined | CoverageEligibilityResponseErrorComponent): this
Add the provided CoverageEligibilityResponseErrorComponent value to the error array property.
Parameters
- value: undefined | CoverageEligibilityResponseErrorComponent
  the error value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1809

hasError

hasError(): boolean
Returns boolean
true if the error property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1822

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IDomainResource.fhirType
Overrides DomainResource.fhirType
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1840

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IDomainResource.isEmpty
Overrides DomainResource.isEmpty
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1847

isRequiredFieldsEmpty

isRequiredFieldsEmpty(): boolean
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
Implementation of IDomainResource.isRequiredFieldsEmpty
Overrides DomainResource.isRequiredFieldsEmpty
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1872

copy

copy(): CoverageEligibilityResponse
Creates a copy of the current instance.

Returns CoverageEligibilityResponse
the a new instance copied from the current instance
Implementation of IDomainResource.copy
Overrides DomainResource.copy
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1883

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IDomainResource.toJSON
Overrides DomainResource.toJSON
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1923

getText

getText(): Narrative
Returns Narrative
the text property value as a Narrative
Implementation of IDomainResource.getText
Inherited from DomainResource.getText
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:86

setText

setText(value: undefined | Narrative): this
Assigns the provided value to the text property.
Parameters
- value: undefined | Narrative
  the text value
Returns this
this
Implementation of IDomainResource.setText
Inherited from DomainResource.setText
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:93

hasText

hasText(): boolean
Returns boolean
true if the text property exists and has a value; false otherwise
Implementation of IDomainResource.hasText
Inherited from DomainResource.hasText
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:97

getContained

getContained(): IResource[]
Returns IResource[]
the contained property value as a Resource array
Implementation of IDomainResource.getContained
Inherited from DomainResource.getContained
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:101

setContained

setContained(value: undefined | IResource[]): this
Assigns the provided Resource array value to the contained property.
Parameters
- value: undefined | IResource[]
  the contained array value
Returns this
this
Implementation of IDomainResource.setContained
Inherited from DomainResource.setContained
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:108

addContained

addContained(value: undefined | IResource): this
Add the provided Resource value to the contained array property.
Parameters
- value: undefined | IResource
  the contained value
Returns this
this
Implementation of IDomainResource.addContained
Inherited from DomainResource.addContained
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:115

hasContained

hasContained(): boolean
Returns boolean
true if the contained property exists and has a value; false otherwise
Implementation of IDomainResource.hasContained
Inherited from DomainResource.hasContained
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:119

getExtension

getExtension(): IExtension[]
Returns IExtension[]
the array of extension values
Implementation of IDomainResource.getExtension
Inherited from DomainResource.getExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:127

setExtension

setExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the extension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IDomainResource.setExtension
Inherited from DomainResource.setExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:134

hasExtension

hasExtension(url?: string): boolean
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

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

Throws
AssertionError for invalid url
Implementation of IDomainResource.hasExtension
Inherited from DomainResource.hasExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:146

getExtensionByUrl

getExtensionByUrl(url: string): undefined | IExtension
Returns the Extension having the provided url.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
the Extension having the provided url

Throws
AssertionError for invalid url
Implementation of IDomainResource.getExtensionByUrl
Inherited from DomainResource.getExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:154

addExtension

addExtension(extension: undefined | IExtension): this
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
Implementation of IDomainResource.addExtension
Inherited from DomainResource.addExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:161

removeExtension

removeExtension(url: string): void
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
Throws
AssertionError for invalid url
Implementation of IDomainResource.removeExtension
Inherited from DomainResource.removeExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:168

getModifierExtension

getModifierExtension(): IExtension[]
Returns IExtension[]
the array of modifierExtension values
Implementation of IDomainResource.getModifierExtension
Inherited from DomainResource.getModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:182

setModifierExtension

setModifierExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the modifierExtension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IDomainResource.setModifierExtension
Inherited from DomainResource.setModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:189

hasModifierExtension

hasModifierExtension(url?: string): boolean
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

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

Throws
AssertionError for invalid url
Implementation of IDomainResource.hasModifierExtension
Inherited from DomainResource.hasModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:201

getModifierExtensionByUrl

getModifierExtensionByUrl(url: string): undefined | IExtension
Returns the Extension having the provided url.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
the Extension having the provided url

Throws
AssertionError for invalid url
Implementation of IDomainResource.getModifierExtensionByUrl
Inherited from DomainResource.getModifierExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:209

addModifierExtension

addModifierExtension(extension: undefined | IExtension): this
Adds the provided Extension to the modifierExtension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the modifierExtension property array
Returns this
this
Implementation of IDomainResource.addModifierExtension
Inherited from DomainResource.addModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:216

removeModifierExtension

removeModifierExtension(url: string): void
Removes the Extension having the provided url from the modifierExtension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IDomainResource.removeModifierExtension
Inherited from DomainResource.removeModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:223

resourceType

resourceType(): string
Returns string
the FHIR resource type as defined by the FHIR specification
Implementation of IDomainResource.resourceType
Inherited from DomainResource.resourceType
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:67

getIdElement

getIdElement(): IdType
Returns IdType
the id property value as a PrimitiveType
Implementation of IDomainResource.getIdElement
Inherited from DomainResource.getIdElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:127

setIdElement

setIdElement(element: undefined | IdType): this
Assigns the provided PrimitiveType value to the id property.
Parameters
- element: undefined | IdType
  the id value
Returns this
this
Implementation of IDomainResource.setIdElement
Inherited from DomainResource.setIdElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:134

hasIdElement

hasIdElement(): boolean
Returns boolean
true if the id property exists and has a value; false otherwise
Implementation of IDomainResource.hasIdElement
Inherited from DomainResource.hasIdElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:138

getId

getId(): undefined | string
Returns undefined | string
the id property value as a primitive value
Implementation of IDomainResource.getId
Inherited from DomainResource.getId
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:142

setId

setId(value: undefined | string): this
Assigns the provided primitive value to the id property.
Parameters
- value: undefined | string
  the id value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
Implementation of IDomainResource.setId
Inherited from DomainResource.setId
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:150

hasId

hasId(): boolean
Returns boolean
true if the id property exists and has a value; false otherwise
Implementation of IDomainResource.hasId
Inherited from DomainResource.hasId
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:154

getMeta

getMeta(): Meta
Returns Meta
the meta property value as a Meta
Implementation of IDomainResource.getMeta
Inherited from DomainResource.getMeta
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:158

setMeta

setMeta(value: undefined | Meta): this
Assigns the provided value to the meta property.
Parameters
- value: undefined | Meta
  the meta value
Returns this
this
Implementation of IDomainResource.setMeta
Inherited from DomainResource.setMeta
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:165

hasMeta

hasMeta(): boolean
Returns boolean
true if the meta property exists and has a value; false otherwise
Implementation of IDomainResource.hasMeta
Inherited from DomainResource.hasMeta
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:169

getImplicitRulesElement

getImplicitRulesElement(): UriType
Returns UriType
the implicitRules property value as a PrimitiveType
Implementation of IDomainResource.getImplicitRulesElement
Inherited from DomainResource.getImplicitRulesElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:173

setImplicitRulesElement

setImplicitRulesElement(element: undefined | UriType): this
Assigns the provided PrimitiveType value to the implicitRules property.
Parameters
- element: undefined | UriType
  the implicitRules value
Returns this
this
Implementation of IDomainResource.setImplicitRulesElement
Inherited from DomainResource.setImplicitRulesElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:180

hasImplicitRulesElement

hasImplicitRulesElement(): boolean
Returns boolean
true if the implicitRules property exists and has a value; false otherwise
Implementation of IDomainResource.hasImplicitRulesElement
Inherited from DomainResource.hasImplicitRulesElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:184

getImplicitRules

getImplicitRules(): undefined | string
Returns undefined | string
the implicitRules property value as a primitive value
Implementation of IDomainResource.getImplicitRules
Inherited from DomainResource.getImplicitRules
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:188

setImplicitRules

setImplicitRules(value: undefined | string): this
Assigns the provided primitive value to the implicitRules property.
Parameters
- value: undefined | string
  the implicitRules value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
Implementation of IDomainResource.setImplicitRules
Inherited from DomainResource.setImplicitRules
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:196

hasImplicitRules

hasImplicitRules(): boolean
Returns boolean
true if the system property exists and has a value; false otherwise
Implementation of IDomainResource.hasImplicitRules
Inherited from DomainResource.hasImplicitRules
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:200

getLanguageElement

getLanguageElement(): CodeType
Returns CodeType
the language property value as a PrimitiveType
Implementation of IDomainResource.getLanguageElement
Inherited from DomainResource.getLanguageElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:204

setLanguageElement

setLanguageElement(element: undefined | CodeType): this
Assigns the provided PrimitiveType value to the language property.
Parameters
- element: undefined | CodeType
  the language value
Returns this
this
Implementation of IDomainResource.setLanguageElement
Inherited from DomainResource.setLanguageElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:211

hasLanguageElement

hasLanguageElement(): boolean
Returns boolean
true if the language property exists and has a value; false otherwise
Implementation of IDomainResource.hasLanguageElement
Inherited from DomainResource.hasLanguageElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:215

getLanguage

getLanguage(): undefined | string
Returns undefined | string
the language property value as a primitive value
Implementation of IDomainResource.getLanguage
Inherited from DomainResource.getLanguage
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:219

setLanguage

setLanguage(value: undefined | string): this
Assigns the provided primitive value to the language property.
Parameters
- value: undefined | string
  the language value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
Implementation of IDomainResource.setLanguage
Inherited from DomainResource.setLanguage
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:227

hasLanguage

hasLanguage(): boolean
Returns boolean
true if the language property exists and has a value; false otherwise
Implementation of IDomainResource.hasLanguage
Inherited from DomainResource.hasLanguage
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:231

isResource

isResource(): boolean
Returns boolean
true if the instance is a FHIR resource; false otherwise
Implementation of IDomainResource.isResource
Inherited from DomainResource.isResource
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:256

isDataType

isDataType(): boolean
Returns boolean
true if the instance is a FHIR complex or primitive datatype; false otherwise
Implementation of IDomainResource.isDataType
Inherited from DomainResource.isDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:71

isComplexDataType

isComplexDataType(): boolean
Returns boolean
true if the instance is a FHIR complex datatype; false otherwise
Implementation of IDomainResource.isComplexDataType
Inherited from DomainResource.isComplexDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:75

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datatype; false otherwise
Implementation of IDomainResource.isPrimitive
Inherited from DomainResource.isPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:79

isBooleanPrimitive

isBooleanPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive boolean datatype; false otherwise
Implementation of IDomainResource.isBooleanPrimitive
Inherited from DomainResource.isBooleanPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:83

isStringPrimitive

isStringPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive string-based datatype; false otherwise
Implementation of IDomainResource.isStringPrimitive
Inherited from DomainResource.isStringPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:87

isNumberPrimitive

isNumberPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive number-based datatype; false otherwise
Implementation of IDomainResource.isNumberPrimitive
Inherited from DomainResource.isNumberPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:91

isBigIntPrimitive

isBigIntPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
Implementation of IDomainResource.isBigIntPrimitive
Inherited from DomainResource.isBigIntPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:95

isDateTimePrimitive

isDateTimePrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
Implementation of IDomainResource.isDateTimePrimitive
Inherited from DomainResource.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: CoverageEligibilityResponse): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: CoverageEligibilityResponse
  the copied instance
Returns void
Overrides DomainResource.copyValues
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1895

`Private`initIdentifier

initIdentifier(): void
Initialize the identifier property

Returns void
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:768

`Private`initPurpose

initPurpose(): void
Initialize the purpose property

Returns void
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1080

`Private`initEvent

initEvent(): void
Initialize the event property

Returns void
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1174

`Private`initInsurance

initInsurance(): void
Initialize the insurance property

Returns void
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1675

`Private`initError

initError(): void
Initialize the error property

Returns void
- Defined in packages/r5-datamodels/src/resources/CoverageEligibilityResponse.ts:1829

Class CoverageEligibilityResponse

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CoverageEligibilityResponse

Properties

Private Optionalidentifier

Remarks

Private ReadonlyfmStatusEnum

See

Privatestatus

Remarks

See

Private ReadonlyeligibilityresponsePurposeEnum

See

Privatepurpose

Remarks

See

Privatepatient

Remarks

Private Optionalevent

Remarks

Private Optionalserviced

Decorator

Remarks

Privatecreated

Remarks

Private Optionalrequestor

Remarks

Privaterequest

Remarks

Private ReadonlyeligibilityOutcomeEnum

See

Privateoutcome

Remarks

See

Private Optionaldisposition

Remarks

Privateinsurer

Remarks

Private Optionalinsurance

Remarks

Private OptionalpreAuthRef

Remarks

Private Optionalform

Remarks

Private Optionalerror

Remarks

Methods

Staticparse

Parameters

Returns undefined | CoverageEligibilityResponse

Throws

getIdentifier

Returns Identifier[]

setIdentifier

Parameters

Returns this

Throws

addIdentifier

Parameters

Returns this

Throws

hasIdentifier

Returns boolean

getStatusEnumType

Returns null | EnumCodeType

See

setStatusEnumType

Parameters

Returns this

Throws

`Private` `Optional`identifier

`Private` `Readonly`fmStatusEnum

`Private`status

`Private` `Readonly`eligibilityresponsePurposeEnum

`Private`purpose

`Private`patient

`Private` `Optional`event

`Private` `Optional`serviced

`Private`created

`Private` `Optional`requestor

`Private`request

`Private` `Readonly`eligibilityOutcomeEnum

`Private`outcome

`Private` `Optional`disposition

`Private`insurer

`Private` `Optional`insurance

`Private` `Optional`preAuthRef

`Private` `Optional`form

`Private` `Optional`error

`Static`parse