Class EncounterParticipantComponent

EncounterParticipantComponent Class

Remarks

FHIR Specification

Short: List of participants involved in the encounter
Definition: The list of people responsible for providing the service.
Comment: Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference.

See

FHIR Encounter

Hierarchy (View Summary)

BackboneElement
- EncounterParticipantComponent

Implements

IBackboneElement

Constructors

constructor

new EncounterParticipantComponent(): EncounterParticipantComponent
Returns EncounterParticipantComponent
Overrides BackboneElement.constructor
- Defined in packages/r5-datamodels/src/resources/Encounter.ts:2753

Properties

`Private` `Optional`type_

type_?: CodeableConcept[]

Encounter.participant.type Element

Remarks

FHIR Specification

Short: Role of participant in encounter
Definition: Role of participant in encounter.
Comment: The participant type indicates how an individual actor participates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc.
FHIR Type: CodeableConcept
Cardinality: 0..*
isModifier: false
isSummary: true

`Private` `Optional`period

period?: Period

Encounter.participant.period Element

Remarks

FHIR Specification

Short: Period of time during the encounter that the participant participated
Definition: The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
FHIR Type: Period
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`actor

actor?: Reference

Encounter.participant.actor Element

Remarks

FHIR Specification

Short: The individual, device, or service participating in the encounter
Definition: Person involved in the encounter, the patient/group is also included here to indicate that the patient was actually participating in the encounter. Not including the patient here covers use cases such as a case meeting between practitioners about a patient - non contact times.
Comment: For planning purposes, Appointments may include a CareTeam participant to indicate that one specific person from the CareTeam will be assigned, but that assignment might not happen until the Encounter begins. Hence CareTeam is not included in Encounter.participant, as the specific individual should be assigned and represented as a Practitioner or other person resource. Similarly, Location can be included in Appointment.participant to assist with planning. However, the patient location is tracked on the Encounter in the Encounter.location property to allow for additional metadata and history to be recorded. The role of the participant can be used to declare what the actor will be doing in the scope of this encounter participation. If the individual is not specified during planning, then it is expected that the individual will be filled in at a later stage prior to the encounter commencing.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', ]
Cardinality: 0..1
isModifier: false
isSummary: true

Methods

`Static`parse

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

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

getType

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

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/Encounter.ts:2883

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/Encounter.ts:2901

hasType

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

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/Encounter.ts:2930

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/Encounter.ts:2941

hasPeriod

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

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/Encounter.ts:2962

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('Encounter.participant.actor', ['Patient','Group','RelatedPerson','Practitioner','PractitionerRole','Device','HealthcareService',])

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

hasActor

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

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/Encounter.ts:3012

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/Encounter.ts:3019

copy

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

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

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/Encounter.ts:3055

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

`Private`initType

initType(): void
Initialize the type_ property

Returns void
- Defined in packages/r5-datamodels/src/resources/Encounter.ts:2921

Class EncounterParticipantComponent

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns EncounterParticipantComponent

Properties

Private Optionaltype_

Remarks

Private Optionalperiod

Remarks

Private Optionalactor

Remarks

Methods

Staticparse

Parameters

Returns undefined | EncounterParticipantComponent

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

fhirType

Returns string

isEmpty

Returns boolean

copy

Returns EncounterParticipantComponent

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

`Private` `Optional`type_

`Private` `Optional`period

`Private` `Optional`actor

`Static`parse

`Protected`copyValues

`Private`initType