Class ExplanationOfBenefitPayeeComponent

ExplanationOfBenefitPayeeComponent Class

Remarks

FHIR Specification

Short: Recipient of benefits payable
Definition: The party to be reimbursed for cost of the products and services according to the terms of the policy.
Comment: Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and may choose to pay the subscriber instead.
Requirements: The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.

See

FHIR ExplanationOfBenefit

Hierarchy (View Summary)

BackboneElement
- ExplanationOfBenefitPayeeComponent

Implements

IBackboneElement

Constructors

constructor

new ExplanationOfBenefitPayeeComponent(): ExplanationOfBenefitPayeeComponent
Returns ExplanationOfBenefitPayeeComponent
Overrides BackboneElement.constructor
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4333

Properties

`Private` `Optional`type_

type_?: CodeableConcept

ExplanationOfBenefit.payee.type Element

Remarks

FHIR Specification

Short: Category of recipient
Definition: Type of Party to be reimbursed: Subscriber, provider, other.
Requirements: Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.
FHIR Type: CodeableConcept
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`party

party?: Reference

ExplanationOfBenefit.payee.party Element

Remarks

FHIR Specification

Short: Recipient reference
Definition: Reference to the individual or organization to whom any payment will be made.
Comment: Not required if the payee is 'subscriber' or 'provider'.
Requirements: Need to provide demographics if the payee is not 'subscriber' nor 'provider'.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson', ]
Cardinality: 0..1
isModifier: false
isSummary: false

Methods

`Static`parse

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

Throws
JsonError if the provided JSON is not a valid JSON object
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4345

getType

getType(): CodeableConcept
Returns CodeableConcept
the type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4422

setType

setType(value: undefined | CodeableConcept): this
Assigns the provided Type object value to the type_ property.
Parameters
- value: undefined | CodeableConcept
  the type_ object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4433

hasType

hasType(): boolean
Returns boolean
true if the type_ property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4447

getParty

getParty(): Reference
Returns Reference
the party property value as a Reference object; else an empty Reference object
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4454

setParty

setParty(value: undefined | Reference): this
Assigns the provided Party object value to the party property.
Parameters
- value: undefined | Reference
  the party object value
Returns this
this

Decorator
@ReferenceTargets('ExplanationOfBenefit.payee.party', ['Practitioner','PractitionerRole','Organization','Patient','RelatedPerson',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4478

hasParty

hasParty(): boolean
Returns boolean
true if the party property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4491

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IBackboneElement.fhirType
Overrides BackboneElement.fhirType
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4500

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IBackboneElement.isEmpty
Overrides BackboneElement.isEmpty
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4507

copy

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

Returns ExplanationOfBenefitPayeeComponent
the a new instance copied from the current instance
Implementation of IBackboneElement.copy
Overrides BackboneElement.copy
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4519

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IBackboneElement.toJSON
Overrides BackboneElement.toJSON
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4540

getModifierExtension

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

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 IBackboneElement.setModifierExtension
Inherited from BackboneElement.setModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:202

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; 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 modifierExtension property exists and has any values.

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

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 IBackboneElement.getModifierExtensionByUrl
Inherited from BackboneElement.getModifierExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:222

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 IBackboneElement.addModifierExtension
Inherited from BackboneElement.addModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:229

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 IBackboneElement.removeModifierExtension
Inherited from BackboneElement.removeModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:236

getId

getId(): undefined | string
Returns undefined | string
the id property value
Implementation of IBackboneElement.getId
Inherited from BackboneElement.getId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:59

setId

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

Throws
PrimitiveTypeError for invalid value
Implementation of IBackboneElement.setId
Inherited from BackboneElement.setId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:67

hasId

hasId(): boolean
Returns boolean
true if id exists and has a value; false otherwise
Implementation of IBackboneElement.hasId
Inherited from BackboneElement.hasId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:71

getExtension

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

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 IBackboneElement.setExtension
Inherited from BackboneElement.setExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:82

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 IBackboneElement.hasExtension
Inherited from BackboneElement.hasExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:94

getExtensionByUrl

getExtensionByUrl(url: string): undefined | IExtension
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

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 IBackboneElement.getExtensionByUrl
Inherited from BackboneElement.getExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:106

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 IBackboneElement.addExtension
Inherited from BackboneElement.addExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:113

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 IBackboneElement.removeExtension
Inherited from BackboneElement.removeExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:120

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 IBackboneElement.isRequiredFieldsEmpty
Inherited from BackboneElement.isRequiredFieldsEmpty
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:63

isResource

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

isDataType

isDataType(): boolean
Returns boolean
true if the instance is a FHIR complex or primitive datatype; false otherwise
Implementation of IBackboneElement.isDataType
Inherited from BackboneElement.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 IBackboneElement.isComplexDataType
Inherited from BackboneElement.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 IBackboneElement.isPrimitive
Inherited from BackboneElement.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 IBackboneElement.isBooleanPrimitive
Inherited from BackboneElement.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 IBackboneElement.isStringPrimitive
Inherited from BackboneElement.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 IBackboneElement.isNumberPrimitive
Inherited from BackboneElement.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 IBackboneElement.isBigIntPrimitive
Inherited from BackboneElement.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 IBackboneElement.isDateTimePrimitive
Inherited from BackboneElement.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: ExplanationOfBenefitPayeeComponent): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: ExplanationOfBenefitPayeeComponent
  the copied instance
Returns void
Overrides BackboneElement.copyValues
- Defined in packages/r4b-datamodels/src/resources/ExplanationOfBenefit.ts:4531

Class ExplanationOfBenefitPayeeComponent

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ExplanationOfBenefitPayeeComponent

Properties

Private Optionaltype_

Remarks

Private Optionalparty

Remarks

Methods

Staticparse

Parameters

Returns undefined | ExplanationOfBenefitPayeeComponent

Throws

getType

Returns CodeableConcept

setType

Parameters

Returns this

Throws

hasType

Returns boolean

getParty

Returns Reference

setParty

Parameters

Returns this

Decorator

Throws

hasParty

Returns boolean

fhirType

Returns string

isEmpty

Returns boolean

copy

Returns ExplanationOfBenefitPayeeComponent

toJSON

Returns undefined | Value

getModifierExtension

Returns IExtension[]

setModifierExtension

Parameters

Returns this

hasModifierExtension

Parameters

Returns boolean

Remarks

Throws

getModifierExtensionByUrl

Parameters

Returns undefined | IExtension

Throws

addModifierExtension

Parameters

Returns this

removeModifierExtension

Parameters

Returns void

Throws

getId

Returns undefined | string

setId

Parameters

Returns this

Throws

hasId

Returns boolean

getExtension

Returns IExtension[]

setExtension

Parameters

`Private` `Optional`type_

`Private` `Optional`party

`Static`parse

`Protected`copyValues