Class AppointmentParticipantComponent

AppointmentParticipantComponent Class

Remarks

FHIR Specification

Short: Participants involved in appointment
Definition: List of participants involved in the appointment.

See

FHIR Appointment

Hierarchy (View Summary)

BackboneElement
- AppointmentParticipantComponent

Implements

IBackboneElement

Index

Constructors

constructor

Properties

type_? period? actor? required? participationstatusEnum status

Constructors

constructor

new AppointmentParticipantComponent(
status?: null | string | CodeType | EnumCodeType,
): AppointmentParticipantComponent
Parameters
- status: null | string | CodeType | EnumCodeType = null
Returns AppointmentParticipantComponent
Overrides BackboneElement.constructor
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3227

Properties

`Private` `Optional`type_

type_?: CodeableConcept[]

Appointment.participant.type Element

Remarks

FHIR Specification

Short: Role of participant in the appointment
Definition: Role of participant in the appointment.
Comment: The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
FHIR Type: CodeableConcept
Cardinality: 0..*
isModifier: false
isSummary: true

`Private` `Optional`period

period?: Period

Appointment.participant.period Element

Remarks

FHIR Specification

Short: Participation period of the actor
Definition: Participation period of the actor.
FHIR Type: Period
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`actor

actor?: Reference

Appointment.participant.actor Element

Remarks

FHIR Specification

Short: The individual, device, location, or service participating in the appointment
Definition: The individual, device, location, or service participating in the appointment.
Comment: Where a CareTeam is provided, this does not imply that the entire team is included, just a single member from the group with the appropriate role. Where multiple members are required, please include the CareTeam the required number of times.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Location', ]
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`required

required?: BooleanType

Appointment.participant.required Element

Remarks

FHIR Specification

Short: The participant is required to attend (optional when false)
Definition: Whether this participant is required to be present at the meeting. If false, the participant is optional.
Comment: For the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.
FHIR Type: boolean
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Readonly`participationstatusEnum

participationstatusEnum: ParticipationstatusEnum

FHIR CodeSystem: Participationstatus

See

ParticipationstatusEnum

`Private`status

status: null | EnumCodeType

Appointment.participant.status Element

Remarks

FHIR Specification

Short: accepted | declined | tentative | needs-action
Definition: Participation status of the actor.
FHIR Type: code
Cardinality: 1..1
isModifier: false
isSummary: true

See

CodeSystem Enumeration: ParticipationstatusEnum

Methods

`Static`parse

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

Throws
JsonError if the provided JSON is not a valid JSON object
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3248

getType

getType(): CodeableConcept[]
Returns CodeableConcept[]
the type_ property value as a CodeableConcept array
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3420

setType

setType(value: undefined | CodeableConcept[]): this
Assigns the provided CodeableConcept array value to the type_ property.
Parameters
- value: undefined | CodeableConcept[]
  the type_ array value
Returns this
this

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

addType

addType(value: undefined | CodeableConcept): this
Add the provided CodeableConcept value to the type_ array property.
Parameters
- value: undefined | CodeableConcept
  the type_ value
Returns this
this

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

hasType

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

getPeriod

getPeriod(): Period
Returns Period
the period property value as a Period object if defined; else an empty Period object
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3478

setPeriod

setPeriod(value: undefined | Period): this
Assigns the provided Period object value to the period property.
Parameters
- value: undefined | Period
  the period object value
Returns this
this

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

hasPeriod

hasPeriod(): boolean
Returns boolean
true if the period property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3503

getActor

getActor(): Reference
Returns Reference
the actor property value as a Reference object; else an empty Reference object
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3510

setActor

setActor(value: undefined | Reference): this
Assigns the provided Actor object value to the actor property.
Parameters
- value: undefined | Reference
  the actor object value
Returns this
this

Decorator
@ReferenceTargets('Appointment.participant.actor', ['Patient','Group','Practitioner','PractitionerRole','CareTeam','RelatedPerson','Device','HealthcareService','Location',])

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

hasActor

hasActor(): boolean
Returns boolean
true if the actor property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3555

getRequiredElement

getRequiredElement(): BooleanType
Returns BooleanType
the required property value as a BooleanType object if defined; else an empty BooleanType object
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3562

setRequiredElement

setRequiredElement(element: undefined | BooleanType): this
Assigns the provided PrimitiveType value to the required property.
Parameters
- element: undefined | BooleanType
  the required value
Returns this
this

Throws
InvalidTypeError for invalid data types

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

hasRequiredElement

hasRequiredElement(): boolean
Returns boolean
true if the required property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3588

getRequired

getRequired(): undefined | boolean
Returns undefined | boolean
the required property value as a fhirBoolean if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3595

setRequired

setRequired(value: undefined | boolean): this
Assigns the provided primitive value to the required property.
Parameters
- value: undefined | boolean
  the required value
Returns this
this

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

hasRequired

hasRequired(): boolean
Returns boolean
true if the required property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3619

getStatusEnumType

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

See
CodeSystem Enumeration: ParticipationstatusEnum
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3628

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: ParticipationstatusEnum
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3642

hasStatusEnumType

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

getStatusElement

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

See
CodeSystem Enumeration: ParticipationstatusEnum
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3665

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: ParticipationstatusEnum
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3682

hasStatusElement

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

getStatus

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

See
CodeSystem Enumeration: ParticipationstatusEnum
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3705

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: ParticipationstatusEnum
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3722

hasStatus

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

fhirType

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

isEmpty

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

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
Overrides BackboneElement.isRequiredFieldsEmpty
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3765

copy

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

Returns AppointmentParticipantComponent
the a new instance copied from the current instance
Implementation of IBackboneElement.copy
Overrides BackboneElement.copy
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3776

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/r5-datamodels/src/resources/Appointment.ts:3801

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

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: AppointmentParticipantComponent): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: AppointmentParticipantComponent
  the copied instance
Returns void
Overrides BackboneElement.copyValues
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3788

`Private`initType

initType(): void
Initialize the type_ property

Returns void
- Defined in packages/r5-datamodels/src/resources/Appointment.ts:3469

Class AppointmentParticipantComponent

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AppointmentParticipantComponent

Properties

Private Optionaltype_

Remarks

Private Optionalperiod

Remarks

Private Optionalactor

Remarks

Private Optionalrequired

Remarks

Private ReadonlyparticipationstatusEnum

See

Privatestatus

Remarks

See

Methods

Staticparse

Parameters

Returns undefined | AppointmentParticipantComponent

Throws

getType

Returns CodeableConcept[]

setType

Parameters

Returns this

Throws

addType

Parameters

Returns this

Throws

hasType

Returns boolean

getPeriod

Returns Period

setPeriod

Parameters

Returns this

Throws

hasPeriod

Returns boolean

getActor

Returns Reference

setActor

Parameters

Returns this

Decorator

Throws

hasActor

Returns boolean

getRequiredElement

Returns BooleanType

setRequiredElement

Parameters

Returns this

Throws

Throws

hasRequiredElement

Returns boolean

getRequired

Returns undefined | boolean

setRequired

Parameters

Returns this

Throws

hasRequired

Returns boolean

getStatusEnumType

Returns null | EnumCodeType

`Private` `Optional`type_

`Private` `Optional`period

`Private` `Optional`actor

`Private` `Optional`required

`Private` `Readonly`participationstatusEnum

`Private`status

`Static`parse