HealthcareProfessional
@icure/medical-device-sdk / HealthcareProfessional
Class: HealthcareProfessional
Table of contentsβ
Constructorsβ
Propertiesβ
- addresses
- civility
- codes
- created
- deletionDate
- firstName
- gender
- id
- labels
- languages
- lastName
- modified
- name
- names
- notes
- parentId
- picture
- properties
- rev
- speciality
- specialityCodes
- systemMetaData
Methodsβ
Constructorsβ
constructorβ
β’ new HealthcareProfessional(json
)
Parametersβ
Name | Type |
---|---|
json | IHealthcareProfessional |
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