Skip to main content

PotentiallyEncryptedPatient

@icure/medical-device-sdk / PotentiallyEncryptedPatient

Interface: PotentiallyEncryptedPatient

Implemented by​

Table of contents​

Properties​

Properties​

active​

• active: boolean

Is the patient active (boolean).

Defined in​

src/models/Patient.ts:369

addresses​

• addresses: Address[]

the list of addresses (with address type).

Defined in​

src/models/Patient.ts:341

administrativeNote​

• Optional administrativeNote: string

An administrative note, not confidential.

Defined in​

src/models/Patient.ts:429

alias​

• Optional alias: string

An alias of the person, nickname, ...

Defined in​

src/models/Patient.ts:365

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.

Defined in​

src/models/Patient.ts:297

birthSex​

• Optional birthSex: PatientBirthSexEnum

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

Defined in​

src/models/Patient.ts:353

civility​

• Optional civility: string

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

Defined in​

src/models/Patient.ts:345

codes​

• codes: Set<CodingReference>

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

Defined in​

src/models/Patient.ts:309

companyName​

• Optional companyName: string

the name of the company this patient is member of.

Defined in​

src/models/Patient.ts:333

created​

• Optional created: number

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

Defined in​

src/models/Patient.ts:289

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

Defined in​

src/models/Patient.ts:397

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

Defined in​

src/models/Patient.ts:401

deactivationReason​

• deactivationReason: PatientDeactivationReasonEnum

When not active, the reason for deactivation.

Defined in​

src/models/Patient.ts:373

deceased​

• Optional deceased: boolean

Is the patient deceased.

Defined in​

src/models/Patient.ts:413

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

Defined in​

src/models/Patient.ts:317

education​

• Optional education: string

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

Defined in​

src/models/Patient.ts:417

endOfLife​

• Optional endOfLife: number

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

Defined in​

src/models/Patient.ts:313

ethnicity​

• Optional ethnicity: string

The ethnicity of the patient.

Defined in​

src/models/Patient.ts:441

externalId​

• Optional externalId: string

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

Defined in​

src/models/Patient.ts:449

firstName​

• Optional firstName: string

the firstname (name) of the patient.

Defined in​

src/models/Patient.ts:321

gender​

• Optional gender: PatientGenderEnum

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

Defined in​

src/models/Patient.ts:349

id​

• Optional id: string

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

Defined in​

src/models/Patient.ts:277

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.

Defined in​

src/models/Patient.ts:285

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.

Defined in​

src/models/Patient.ts:305

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/Patient.ts:337

lastName​

• Optional lastName: string

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

Defined in​

src/models/Patient.ts:325

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 .

Defined in​

src/models/Patient.ts:381

mergeToPatientId​

• Optional mergeToPatientId: string

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

Defined in​

src/models/Patient.ts:357

mergedIds​

• mergedIds: Set<string>

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

Defined in​

src/models/Patient.ts:361

modified​

• Optional modified: number

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

Defined in​

src/models/Patient.ts:293

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

Defined in​

src/models/Patient.ts:329

nationality​

• Optional nationality: string

The nationality of the patient.

Defined in​

src/models/Patient.ts:433

note​

• Optional note: string

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

Defined in​

src/models/Patient.ts:425

parameters​

• parameters: Object

Extra parameters

Index signature​

▪ [key: string]: string[]

Defined in​

src/models/Patient.ts:465

partnerName​

• Optional partnerName: string

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

Defined in​

src/models/Patient.ts:389

partnerships​

• partnerships: Partnership[]

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

Defined in​

src/models/Patient.ts:453

patientHealthCareParties​

• patientHealthCareParties: PatientHealthCareParty[]

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

Defined in​

src/models/Patient.ts:457

patientProfessions​

• patientProfessions: CodingReference[]

Codified list of professions exercised by this patient.

Defined in​

src/models/Patient.ts:461

personalStatus​

• Optional personalStatus: PatientPersonalStatusEnum

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

Defined in​

src/models/Patient.ts:393

picture​

• Optional picture: ArrayBuffer

A picture usually saved in JPEG format.

Defined in​

src/models/Patient.ts:445

placeOfBirth​

• Optional placeOfBirth: string

The place of birth.

Defined in​

src/models/Patient.ts:405

placeOfDeath​

• Optional placeOfDeath: string

The place of death.

Defined in​

src/models/Patient.ts:409

profession​

• Optional profession: string

The current professional activity.

Defined in​

src/models/Patient.ts:421

properties​

• properties: Set<Property>

Extra properties

Defined in​

src/models/Patient.ts:469

race​

• Optional race: string

The race of the patient.

Defined in​

src/models/Patient.ts:437

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

Defined in​

src/models/Patient.ts:301

rev​

• Optional rev: string

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

Defined in​

src/models/Patient.ts:281

spouseName​

• Optional spouseName: string

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

Defined in​

src/models/Patient.ts:385

ssin​

• Optional ssin: string

Social security inscription number.

Defined in​

src/models/Patient.ts:377

systemMetaData​

• Optional systemMetaData: SystemMetaDataOwnerEncrypted

Defined in​

src/models/Patient.ts:470