-
active
↔ bool
-
Is the patient active (boolean).
getter/setter pairoverride
-
addresses
↔ List<Address>
-
the list of addresses (with address type).
getter/setter pairoverride
-
administrativeNote
↔ String?
-
An administrative note, not confidential.
getter/setter pairoverride
-
alias
↔ String?
-
An alias of the person, nickname, ...
getter/setter pairoverride
-
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.
getter/setter pairoverride
-
birthSex
↔ PatientBirthSexEnum?
-
the birth sex of the patient: male, female, indeterminate, unknown
getter/setter pairoverride
-
civility
↔ String?
-
Mr., Ms., Pr., Dr. ...
getter/setter pairoverride
-
codes
↔ Set<CodingReference>
-
A code is an item from a codification system that qualifies the content of this patient.
getter/setter pairoverride
-
companyName
↔ String?
-
the name of the company this patient is member of.
getter/setter pairoverride
-
created
↔ int?
-
the creation date of the patient (encoded as epoch).
getter/setter pairoverride
-
dateOfBirth
↔ int?
-
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).
getter/setter pairoverride
-
dateOfDeath
↔ int?
-
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).
getter/setter pairoverride
-
deactivationReason
↔ PatientDeactivationReasonEnum
-
When not active, the reason for deactivation.
getter/setter pairoverride
-
deceased
↔ bool?
-
Is the patient deceased.
getter/setter pairoverride
-
deletionDate
↔ int?
-
the soft delete timestamp. When a patient is ”deleted“, this is set to a non null value: the moment of the deletion
getter/setter pairoverride
-
education
↔ String?
-
The level of education (college degree, undergraduate, phd).
getter/setter pairoverride
-
endOfLife
↔ int?
-
Soft delete (unix epoch in ms) timestamp of the patient
getter/setter pairoverride
-
ethnicity
↔ String?
-
The ethnicity of the patient.
getter/setter pairoverride
-
externalId
↔ String?
-
An external (from another source) id with no guarantee or requirement for unicity .
getter/setter pairoverride
-
firstName
↔ String?
-
the firstname (name) of the patient.
getter/setter pairoverride
-
gender
↔ PatientGenderEnum?
-
the gender of the patient: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown
getter/setter pairoverride
-
hashCode
→ int
-
The hash code for this object.
no setteroverride
-
id
↔ String?
-
the Id of the patient. We encourage using either a v4 UUID or a HL7 Id.
getter/setter pairoverride
-
identifiers
↔ List<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.
getter/setter pairoverride
-
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.
getter/setter pairoverride
-
languages
↔ List<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).
getter/setter pairoverride
-
lastName
↔ String?
-
the lastname (surname) of the patient. This is the official lastname that should be used for official administrative purposes.
getter/setter pairoverride
-
maidenName
↔ String?
-
Lastname at birth (can be different of the current name), depending on the country, must be used to design the patient .
getter/setter pairoverride
-
mergedIds
↔ Set<String>
-
The ids of the patients that have been merged inside this patient.
getter/setter pairoverride
-
mergeToPatientId
↔ String?
-
The id of the patient this patient has been merged with.
getter/setter pairoverride
-
modified
↔ int?
-
the last modification date of the patient (encoded as epoch).
getter/setter pairoverride
-
names
↔ List<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
getter/setter pairoverride
-
nationality
↔ String?
-
The nationality of the patient.
getter/setter pairoverride
-
note
↔ String?
-
A text note (can be confidential, encrypted by default).
getter/setter pairoverride
-
parameters
↔ Map<String, List<String>>
-
Extra parameters
getter/setter pairoverride-getter
-
partnerName
↔ String?
-
Lastname of the partner, should not be used to design the patient.
getter/setter pairoverride
-
partnerships
↔ List<Partnership>
-
List of partners, or persons of contact (of class Partnership, see below).
getter/setter pairoverride
-
patientHealthCareParties
↔ List<PatientHealthCareParty>
-
Links (usually for therapeutic reasons) between this patient and healthcare parties (of class PatientHealthcareParty).
getter/setter pairoverride
-
patientProfessions
↔ List<CodingReference>
-
Codified list of professions exercised by this patient.
getter/setter pairoverride
-
personalStatus
↔ PatientPersonalStatusEnum?
-
any of
single
, in_couple
, married
, separated
, divorced
, divorcing
, widowed
, widower
, complicated
, unknown
, contract
, other
.
getter/setter pairoverride
-
picture
↔ String?
-
A picture usually saved in JPEG format.
getter/setter pairoverride
-
placeOfBirth
↔ String?
-
The place of birth.
getter/setter pairoverride
-
placeOfDeath
↔ String?
-
The place of death.
getter/setter pairoverride
-
profession
↔ String?
-
The current professional activity.
getter/setter pairoverride
-
properties
↔ Set<Property>
-
Extra properties
getter/setter pairoverride
-
race
↔ String?
-
The race of the patient.
getter/setter pairoverride
-
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
getter/setter pairoverride
-
rev
↔ String?
-
the revision of the patient in the database, used for conflict management / optimistic locking.
getter/setter pairoverride
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
spouseName
↔ String?
-
Lastname of the spouse for a married woman, depending on the country, can be used to design the patient.
getter/setter pairoverride
-
ssin
↔ String?
-
Social security inscription number.
getter/setter pairoverride
-
systemMetaData
↔ SystemMetaDataOwnerEncrypted?
-
Please note: This property should have been non-nullable! Since the specification file
does not include a default value (using the "default:" property), however, the generated
source code must fall back to having a nullable type.
Consider adding a "default:" property in the specification file to hide this note.
getter/setter pairoverride