Skip to main content

HealthcareProfessional

@icure/medical-device-sdk / HealthcareProfessional

Class: HealthcareProfessional

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new HealthcareProfessional(json)

Parameters​

NameType
jsonIHealthcareProfessional

Defined in​

src/models/HealthcareProfessional.ts:22

Properties​

addresses​

• addresses: Address[]

The list of addresses (with address type).

Defined in​

src/models/HealthcareProfessional.ts:106

civility​

• Optional civility: string

Mr., Ms., Pr., Dr. ...

Defined in​

src/models/HealthcareProfessional.ts:94

codes​

• codes: Set<CodingReference>

A code is an item from a codification system that qualifies the content of this doctor. Example: doctor's specialty

Defined in​

src/models/HealthcareProfessional.ts:66

created​

• Optional created: number

creation timestamp of the object.

Defined in​

src/models/HealthcareProfessional.ts:52

deletionDate​

• Optional deletionDate: number

the soft delete timestamp. When a user is ”deleted“, this is set to a non null value: the moment of the deletion

Defined in​

src/models/HealthcareProfessional.ts:70

firstName​

• Optional firstName: string

the firstname (name) of the healthcare party.

Defined in​

src/models/HealthcareProfessional.ts:82

gender​

• Optional gender: HealthcareProfessionalGenderEnum

the gender of the healthcare party: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown

Defined in​

src/models/HealthcareProfessional.ts:90

id​

• Optional id: string

the Id of the healthcare party. We encourage using either a v4 UUID or a HL7 Id.

Defined in​

src/models/HealthcareProfessional.ts:44

labels​

• labels: Set<CodingReference>

A label is an item from a codification system that qualifies a doctor as being member of a certain class, whatever the value it might have taken. If the label qualifies the content of a field, it means that whatever the content of the field, the label will always apply. LOINC is a codification system typically used for labels. Example: HealthcareProfessional is an organisation

Defined in​

src/models/HealthcareProfessional.ts:61

languages​

• languages: string[]

The list of languages spoken by the patient ordered by fluency (alpha-2 code http://www.loc.gov/standards/iso639-2/ascii_8bits.html).

Defined in​

src/models/HealthcareProfessional.ts:110

lastName​

• Optional lastName: string

the lastname (surname) of the healthcare party. This is the official lastname that should be used for official administrative purposes.

Defined in​

src/models/HealthcareProfessional.ts:78

modified​

• Optional modified: number

last modification timestamp of the object.

Defined in​

src/models/HealthcareProfessional.ts:56

name​

• Optional name: string

The full name of the healthcare party, used mainly when the healthcare party is an organization

Defined in​

src/models/HealthcareProfessional.ts:74

names​

• names: PersonName[]

the list of all names of the healthcare party, also containing the official full name information. Ordered by preference of use. First element is therefore the official name used for the healthcare party in the application

Defined in​

src/models/HealthcareProfessional.ts:86

notes​

• Optional notes: string

Text notes.

Defined in​

src/models/HealthcareProfessional.ts:122

parentId​

• Optional parentId: string

Id of parent of the user representing the healthcare party.

Defined in​

src/models/HealthcareProfessional.ts:102

picture​

• Optional picture: ArrayBuffer

A picture usually saved in JPEG format.

Defined in​

src/models/HealthcareProfessional.ts:114

properties​

• properties: Set<Property>

Defined in​

src/models/HealthcareProfessional.ts:123

rev​

• Optional rev: string

the revision of the healthcare party in the database, used for conflict management / optimistic locking.

Defined in​

src/models/HealthcareProfessional.ts:48

speciality​

• Optional speciality: string

Medical specialty of the healthcare party

Defined in​

src/models/HealthcareProfessional.ts:98

specialityCodes​

• Optional specialityCodes: Set<CodingReference>

Medical specialty of the healthcare party codified using FHIR or Kmehr codificaiton scheme

Defined in​

src/models/HealthcareProfessional.ts:118

systemMetaData​

• Optional systemMetaData: SystemMetaDataOwner

Defined in​

src/models/HealthcareProfessional.ts:124

Methods​

marshal​

▸ marshal(): IHealthcareProfessional

Returns​

IHealthcareProfessional

Defined in​

src/models/HealthcareProfessional.ts:126