DecryptedPatientDto class

Available Extensions

• PatientInitDto

Constructors

DecryptedPatientDto({required String id, List<IdentifierDto> identifier = const [], String? rev, int? created, int? modified, String? author, String? responsible, Set<CodeStubDto> tags = const {}, Set<CodeStubDto> codes = const {}, int? endOfLife, int? deletionDate, String? firstName, String? lastName, List<PersonNameDto> names = const [], String? companyName, List<String> languages = const [], List<AddressDto> addresses = const [], String? civility, PatientDtoGenderEnum? gender, PatientDtoBirthSexEnum? birthSex, String? mergeToPatientId, Set<String> mergedIds = const {}, String? alias, bool active = true, PatientDtoDeactivationReasonEnum deactivationReason = const PatientDtoDeactivationReasonEnum._('DeactivationReason.none'), String? ssin, String? maidenName, String? spouseName, String? partnerName, PatientDtoPersonalStatusEnum? personalStatus, int? dateOfBirth, int? dateOfDeath, int? timestampOfLatestEidReading, String? placeOfBirth, String? placeOfDeath, bool? deceased, String? education, String? profession, String? note, String? administrativeNote, String? nationality, String? race, String? ethnicity, String? preferredUserId, String? picture, String? externalId, List<InsurabilityDto> insurabilities = const [], List<PartnershipDto> partnerships = const [], List<PatientHealthCarePartyDto> patientHealthCareParties = const [], List<FinancialInstitutionInformationDto> financialInstitutionInformation = const [], List<MedicalHouseContractDto> medicalHouseContracts = const [], List<CodeStubDto> patientProfessions = const [], Map<String, List<String>> parameters = const {}, Set<PropertyStubDto> properties = const {}, Map<String, List<String>> hcPartyKeys = const {}, Map<String, Map<String, Map<String, String>>> aesExchangeKeys = const {}, Map<String, Map<String, String>> transferKeys = const {}, Map<String, String> privateKeyShamirPartitions = const {}, String? publicKey, Set<String> secretForeignKeys = const {}, Map<String, Set<DelegationDto>> cryptedForeignKeys = const {}, Map<String, Set<DelegationDto>> delegations = const {}, Map<String, Set<DelegationDto>> encryptionKeys = const {}, String? encryptedSelf, String? medicalLocationId, Set<String> nonDuplicateIds = const {}, Set<String> encryptedAdministrativesDocuments = const {}, String? comment, String? warning, CodeStubDto? fatherBirthCountry, CodeStubDto? birthCountry, CodeStubDto? nativeCountry, CodeStubDto? socialStatus, CodeStubDto? mainSourceOfIncome, List<SchoolingInfoDto> schoolingInfos = const [], List<EmploymentInfoDto> employementInfos = const []})

Returns a new DecryptedPatientDto instance.

Properties

active ↔ bool

Is the patient active (boolean).

getter/setter pair

addresses ↔ List<AddressDto>

the list of addresses (with address type).

getter/setter pair

administrativeNote ↔ String?

An administrative note, not confidential.

getter/setter pair

aesExchangeKeys ↔ Map<String, Map<String, Map<String, String>>>

Extra AES exchange keys, usually the ones we lost access to at some point The structure is { publicKey: { delegateId: aesExKey_for_this, aesExKey_for_delegate } }

getter/setter pair

alias ↔ String?

An alias of the person, nickname, ...

getter/setter pair

author ↔ String?

The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

birthCountry ↔ CodeStubDto?

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

birthSex ↔ PatientDtoBirthSexEnum?

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

getter/setter pair

civility ↔ String?

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

getter/setter pair

codes ↔ Set<CodeStubDto>

A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes

getter/setter pair

comment ↔ String?

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

companyName ↔ String?

the name of the company this patient is member of.

getter/setter pair

created ↔ int?

The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

cryptedForeignKeys ↔ Map<String, Set<DelegationDto>>

The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.

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 ↔ PatientDtoDeactivationReasonEnum

When not active, the reason for deactivation.

getter/setter pair

deceased ↔ bool?

Is the patient deceased.

getter/setter pair

delegations ↔ Map<String, Set<DelegationDto>>

When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well

getter/setter pair

deletionDate ↔ int?

hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.

getter/setter pair

education ↔ String?

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

getter/setter pair

employementInfos ↔ List<EmploymentInfoDto>

getter/setter pair

encryptedAdministrativesDocuments ↔ Set<String>

getter/setter pair

encryptedSelf ↔ String?

The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.

getter/setter pair

encryptionKeys ↔ Map<String, Set<DelegationDto>>

When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation

getter/setter pair

endOfLife ↔ int?

Soft delete (unix epoch in ms) timestamp of the object.

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

fatherBirthCountry ↔ CodeStubDto?

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

financialInstitutionInformation ↔ List<FinancialInstitutionInformationDto>

Financial information (Bank, bank account) used to reimburse the patient.

getter/setter pair

firstName ↔ String?

the firstname (name) of the patient.

getter/setter pair

gender ↔ PatientDtoGenderEnum?

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

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

hcPartyKeys ↔ Map<String, List<String>>

For each couple of HcParties (delegator and delegate), this map contains the exchange AES key. The delegator is always this hcp, the key of the map is the id of the delegate. The AES exchange key is encrypted using RSA twice : once using this hcp public key (index 0 in the Array) and once using the other hcp public key (index 1 in the Array). For a pair of HcParties. Each HcParty always has one AES exchange key for himself.

getter/setter pair

id ↔ String

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

getter/setter pair

identifier ↔ List<IdentifierDto>

getter/setter pair

insurabilities ↔ List<InsurabilityDto>

List of insurance coverages (of class Insurability, see below).

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

mainSourceOfIncome ↔ CodeStubDto?

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

medicalHouseContracts ↔ List<MedicalHouseContractDto>

Contracts between the patient and the healthcare entity.

getter/setter pair

medicalLocationId ↔ String?

The id of the medical location where this entity was created.

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 date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

names ↔ List<PersonNameDto>

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

nativeCountry ↔ CodeStubDto?

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

nonDuplicateIds ↔ Set<String>

getter/setter pair

note ↔ String?

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

getter/setter pair

parameters ↔ Map<String, List<String>>

Extra parameters

getter/setter pair

partnerName ↔ String?

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

getter/setter pair

partnerships ↔ List<PartnershipDto>

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

getter/setter pair

patientHealthCareParties ↔ List<PatientHealthCarePartyDto>

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

getter/setter pair

patientProfessions ↔ List<CodeStubDto>

Codified list of professions exercised by this patient.

getter/setter pair

personalStatus ↔ PatientDtoPersonalStatusEnum?

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

preferredUserId ↔ String?

The id of the user that usually handles this patient.

getter/setter pair

privateKeyShamirPartitions ↔ Map<String, String>

The privateKeyShamirPartitions are used to share this hcp's private RSA key with a series of other hcParties using Shamir's algorithm. The key of the map is the hcp Id with whom this partition has been shared. The value is "threshold⎮partition in hex" encrypted using the the partition's holder's public RSA key

getter/setter pair

profession ↔ String?

The current professional activity.

getter/setter pair

properties ↔ Set<PropertyStubDto>

Extra properties

getter/setter pair

publicKey ↔ String?

The public key of this hcp

getter/setter pair

race ↔ String?

The race of the patient.

getter/setter pair

responsible ↔ String?

The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.

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 setter, inherited

schoolingInfos ↔ List<SchoolingInfoDto>

getter/setter pair

secretForeignKeys ↔ Set<String>

The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.

getter/setter pair

socialStatus ↔ CodeStubDto?

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

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

tags ↔ Set<CodeStubDto>

A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.

getter/setter pair

timestampOfLatestEidReading ↔ int?

Timestamp of the latest validation of the eID of the person..

getter/setter pair

transferKeys ↔ Map<String, Map<String, String>>

Data owner private keys encrypted with its other public keys. This mechanism will help the data owner to re-encrypt all information with its new key, if he found back the lost one. The structure is { publicKey1: { publicKey2: privateKey2_encrypted_with_publicKey1, publicKey3: privateKey3_encrypted_with_publicKey1 } }

getter/setter pair

warning ↔ String?

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

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → DecryptedPatientDto?

Returns a new DecryptedPatientDto instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<DecryptedPatientDto>?

mapFromJson(dynamic json) → Map<String, DecryptedPatientDto>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<DecryptedPatientDto>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.