PotentiallyEncryptedPatient class abstract

Implementers

Properties

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

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited