Skip to main content

Patient

@icure/medical-device-sdk / Patient

Class: Patient

Implements​

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new Patient(json)

Parameters​

NameType
jsonIPatient

Defined in​

src/models/Patient.ts:26

Properties​

active​

• active: boolean

Is the patient active (boolean).

Implementation of​

PotentiallyEncryptedPatient.active

Defined in​

src/models/Patient.ts:102

addresses​

• addresses: Address[]

the list of addresses (with address type).

Implementation of​

PotentiallyEncryptedPatient.addresses

Defined in​

src/models/Patient.ts:95

administrativeNote​

• Optional administrativeNote: string

An administrative note, not confidential.

Implementation of​

PotentiallyEncryptedPatient.administrativeNote

Defined in​

src/models/Patient.ts:117

alias​

• Optional alias: string

An alias of the person, nickname, ...

Implementation of​

PotentiallyEncryptedPatient.alias

Defined in​

src/models/Patient.ts:101

author​

• Optional author: string

The id of the [User] that created this patient. When creating the patient, this field will be filled automatically by the current user id if not provided.

Implementation of​

PotentiallyEncryptedPatient.author

Defined in​

src/models/Patient.ts:84

birthSex​

• Optional birthSex: PatientBirthSexEnum

the birth sex of the patient: male, female, indeterminate, unknown

Implementation of​

PotentiallyEncryptedPatient.birthSex

Defined in​

src/models/Patient.ts:98

civility​

• Optional civility: string

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

Implementation of​

PotentiallyEncryptedPatient.civility

Defined in​

src/models/Patient.ts:96

codes​

• codes: Set<CodingReference>

A code is an item from a codification system that qualifies the content of this patient.

Implementation of​

PotentiallyEncryptedPatient.codes

Defined in​

src/models/Patient.ts:87

companyName​

• Optional companyName: string

the name of the company this patient is member of.

Implementation of​

PotentiallyEncryptedPatient.companyName

Defined in​

src/models/Patient.ts:93

created​

• Optional created: number

the creation date of the patient (encoded as epoch).

Implementation of​

PotentiallyEncryptedPatient.created

Defined in​

src/models/Patient.ts:82

dateOfBirth​

• Optional dateOfBirth: number

The birthdate encoded as a fuzzy date on 8 positions (YYYYMMDD) MM and/or DD can be set to 00 if unknown (19740000 is a valid date).

Implementation of​

PotentiallyEncryptedPatient.dateOfBirth

Defined in​

src/models/Patient.ts:109

dateOfDeath​

• Optional dateOfDeath: number

The date of death encoded as a fuzzy date on 8 positions (YYYYMMDD) MM and/or DD can be set to 00 if unknown (19740000 is a valid date).

Implementation of​

PotentiallyEncryptedPatient.dateOfDeath

Defined in​

src/models/Patient.ts:110

deactivationReason​

• deactivationReason: PatientDeactivationReasonEnum

When not active, the reason for deactivation.

Implementation of​

PotentiallyEncryptedPatient.deactivationReason

Defined in​

src/models/Patient.ts:103

deceased​

• Optional deceased: boolean

Is the patient deceased.

Implementation of​

PotentiallyEncryptedPatient.deceased

Defined in​

src/models/Patient.ts:113

deletionDate​

• Optional deletionDate: number

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

Implementation of​

PotentiallyEncryptedPatient.deletionDate

Defined in​

src/models/Patient.ts:89

education​

• Optional education: string

The level of education (college degree, undergraduate, phd).

Implementation of​

PotentiallyEncryptedPatient.education

Defined in​

src/models/Patient.ts:114

endOfLife​

• Optional endOfLife: number

Soft delete (unix epoch in ms) timestamp of the patient

Implementation of​

PotentiallyEncryptedPatient.endOfLife

Defined in​

src/models/Patient.ts:88

ethnicity​

• Optional ethnicity: string

The ethnicity of the patient.

Implementation of​

PotentiallyEncryptedPatient.ethnicity

Defined in​

src/models/Patient.ts:120

externalId​

• Optional externalId: string

An external (from another source) id with no guarantee or requirement for unicity .

Implementation of​

PotentiallyEncryptedPatient.externalId

Defined in​

src/models/Patient.ts:122

firstName​

• Optional firstName: string

the firstname (name) of the patient.

Implementation of​

PotentiallyEncryptedPatient.firstName

Defined in​

src/models/Patient.ts:90

gender​

• Optional gender: PatientGenderEnum

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

Implementation of​

PotentiallyEncryptedPatient.gender

Defined in​

src/models/Patient.ts:97

id​

• Optional id: string

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

Implementation of​

PotentiallyEncryptedPatient.id

Defined in​

src/models/Patient.ts:79

identifiers​

• identifiers: Identifier[]

Typically used for business / client identifiers. An identifier should identify a patient uniquely and unambiguously. However, iCure can't guarantee the uniqueness of those identifiers : This is something you need to take care of.

Implementation of​

PotentiallyEncryptedPatient.identifiers

Defined in​

src/models/Patient.ts:81

labels​

• labels: Set<CodingReference>

A label is an item from a codification system that qualifies a patient 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.

Implementation of​

PotentiallyEncryptedPatient.labels

Defined in​

src/models/Patient.ts:86

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).

Implementation of​

PotentiallyEncryptedPatient.languages

Defined in​

src/models/Patient.ts:94

lastName​

• Optional lastName: string

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

Implementation of​

PotentiallyEncryptedPatient.lastName

Defined in​

src/models/Patient.ts:91

maidenName​

• Optional maidenName: string

Lastname at birth (can be different of the current name), depending on the country, must be used to design the patient .

Implementation of​

PotentiallyEncryptedPatient.maidenName

Defined in​

src/models/Patient.ts:105

mergeToPatientId​

• Optional mergeToPatientId: string

The id of the patient this patient has been merged with.

Implementation of​

PotentiallyEncryptedPatient.mergeToPatientId

Defined in​

src/models/Patient.ts:99

mergedIds​

• mergedIds: Set<string>

The ids of the patients that have been merged inside this patient.

Implementation of​

PotentiallyEncryptedPatient.mergedIds

Defined in​

src/models/Patient.ts:100

modified​

• Optional modified: number

the last modification date of the patient (encoded as epoch).

Implementation of​

PotentiallyEncryptedPatient.modified

Defined in​

src/models/Patient.ts:83

names​

• names: PersonName[]

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

Implementation of​

PotentiallyEncryptedPatient.names

Defined in​

src/models/Patient.ts:92

nationality​

• Optional nationality: string

The nationality of the patient.

Implementation of​

PotentiallyEncryptedPatient.nationality

Defined in​

src/models/Patient.ts:118

note​

• Optional note: string

A text note (can be confidential, encrypted by default).

Implementation of​

PotentiallyEncryptedPatient.note

Defined in​

src/models/Patient.ts:116

parameters​

• parameters: Object

Extra parameters

Index signature​

▪ [key: string]: string[]

Implementation of​

PotentiallyEncryptedPatient.parameters

Defined in​

src/models/Patient.ts:126

partnerName​

• Optional partnerName: string

Lastname of the partner, should not be used to design the patient.

Implementation of​

PotentiallyEncryptedPatient.partnerName

Defined in​

src/models/Patient.ts:107

partnerships​

• partnerships: Partnership[]

List of partners, or persons of contact (of class Partnership, see below).

Implementation of​

PotentiallyEncryptedPatient.partnerships

Defined in​

src/models/Patient.ts:123

patientHealthCareParties​

• patientHealthCareParties: PatientHealthCareParty[]

Links (usually for therapeutic reasons) between this patient and healthcare parties (of class PatientHealthcareParty).

Implementation of​

PotentiallyEncryptedPatient.patientHealthCareParties

Defined in​

src/models/Patient.ts:124

patientProfessions​

• patientProfessions: CodingReference[]

Codified list of professions exercised by this patient.

Implementation of​

PotentiallyEncryptedPatient.patientProfessions

Defined in​

src/models/Patient.ts:125

personalStatus​

• Optional personalStatus: PatientPersonalStatusEnum

any of single, in_couple, married, separated, divorced, divorcing, widowed, widower, complicated, unknown, contract, other.

Implementation of​

PotentiallyEncryptedPatient.personalStatus

Defined in​

src/models/Patient.ts:108

picture​

• Optional picture: ArrayBuffer

A picture usually saved in JPEG format.

Implementation of​

PotentiallyEncryptedPatient.picture

Defined in​

src/models/Patient.ts:121

placeOfBirth​

• Optional placeOfBirth: string

The place of birth.

Implementation of​

PotentiallyEncryptedPatient.placeOfBirth

Defined in​

src/models/Patient.ts:111

placeOfDeath​

• Optional placeOfDeath: string

The place of death.

Implementation of​

PotentiallyEncryptedPatient.placeOfDeath

Defined in​

src/models/Patient.ts:112

profession​

• Optional profession: string

The current professional activity.

Implementation of​

PotentiallyEncryptedPatient.profession

Defined in​

src/models/Patient.ts:115

properties​

• properties: Set<Property>

Extra properties

Implementation of​

PotentiallyEncryptedPatient.properties

Defined in​

src/models/Patient.ts:127

race​

• Optional race: string

The race of the patient.

Implementation of​

PotentiallyEncryptedPatient.race

Defined in​

src/models/Patient.ts:119

responsible​

• Optional responsible: string

The id of the data owner that is responsible of this patient. When creating the patient, will be filled automatically by the current user data owner id ([HealthcareProfessional], [Patient] or [MedicalDevice]) if missing

Implementation of​

PotentiallyEncryptedPatient.responsible

Defined in​

src/models/Patient.ts:85

rev​

• Optional rev: string

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

Implementation of​

PotentiallyEncryptedPatient.rev

Defined in​

src/models/Patient.ts:80

spouseName​

• Optional spouseName: string

Lastname of the spouse for a married woman, depending on the country, can be used to design the patient.

Implementation of​

PotentiallyEncryptedPatient.spouseName

Defined in​

src/models/Patient.ts:106

ssin​

• Optional ssin: string

Social security inscription number.

Implementation of​

PotentiallyEncryptedPatient.ssin

Defined in​

src/models/Patient.ts:104

systemMetaData​

• Optional systemMetaData: SystemMetaDataOwnerEncrypted

Implementation of​

PotentiallyEncryptedPatient.systemMetaData

Defined in​

src/models/Patient.ts:128

Methods​

marshal​

▸ marshal(): IPatient

Returns​

IPatient

Defined in​

src/models/Patient.ts:130