HealthElementDto class

Constructors

HealthElementDto({required String id, List<IdentifierDto> identifiers = const [], String? rev, int? created, int? modified, String? author, String? responsible, String? medicalLocationId, Set<CodeStubDto> tags = const {}, Set<CodeStubDto> codes = const {}, int? endOfLife, int? deletionDate, String? healthElementId, int? valueDate, int? openingDate, int? closingDate, String? descr, String? note, required bool relevant, String? idOpeningContact, String? idClosingContact, String? idService, required int status, HealthElementDtoLateralityEnum? laterality, List<PlanOfActionDto> plansOfAction = const [], List<EpisodeDto> episodes = const [], List<CareTeamMemberDto> careTeam = const [], Set<String> secretForeignKeys = const {}, Map<String, Set<DelegationDto>> cryptedForeignKeys = const {}, Map<String, Set<DelegationDto>> delegations = const {}, Map<String, Set<DelegationDto>> encryptionKeys = const {}, String? encryptedSelf})

Returns a new HealthElementDto instance.

Properties

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

careTeam ↔ List<CareTeamMemberDto>

List of care team members assigned for the healthcare element.

getter/setter pair

closingDate ↔ int?

The date (unix epoch in ms) marking the end of the healthcare element.

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

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

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

descr ↔ String?

Description of the healthcare element.

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

episodes ↔ List<EpisodeDto>

List of episodes of occurrences of the healthcare element.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

healthElementId ↔ String?

The logical id of the healthcare element, used to link together different versions of the same healthcare element. We encourage using either a v4 UUID or a HL7 Id.

getter/setter pair

id ↔ String

The Id of the healthcare element. We encourage using either a v4 UUID or a HL7 Id.

getter/setter pair

idClosingContact ↔ String?

Id of the closing contact for the healthcare element.

getter/setter pair

identifiers ↔ List<IdentifierDto>

getter/setter pair

idOpeningContact ↔ String?

Id of the opening contact when the healthcare element was created.

getter/setter pair

idService ↔ String?

Id of the service when a service is used to create a healthcare element.

getter/setter pair

laterality ↔ HealthElementDtoLateralityEnum?

Left or Right dominance/preference.

getter/setter pair

medicalLocationId ↔ String?

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

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

note ↔ String?

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

getter/setter pair

openingDate ↔ int?

The date (unix epoch in ms) of the start of the healthcare element.

getter/setter pair

plansOfAction ↔ List<PlanOfActionDto>

List of healthcare approaches.

getter/setter pair

relevant ↔ bool

If the healthcare element is relevant or not (Set relevant by default).

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

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

status ↔ int

bit 0: active/inactive, bit 1: relevant/irrelevant, bit 2 : present/absent, ex: 0 = active,relevant and present

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

valueDate ↔ int?

The date (unix epoch in ms) when the healthcare element is noted to have started and also closes on the same date

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) → HealthElementDto?

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

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

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

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

Constants

requiredKeys → const Set<String>

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