DocumentDto class

Constructors

DocumentDto({required String id, 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? objectStoreReference, DocumentDtoDocumentLocationEnum? documentLocation, DocumentDtoDocumentTypeEnum? documentType, DocumentDtoDocumentStatusEnum? documentStatus, String? externalUri, String? mainUti, String? name, String? version, Set<String> otherUtis = const {}, String? storedICureDocumentId, String? externalUuid, int? size, String? hash, String? openingContactId, String? attachmentId, String? encryptedAttachment, String? decryptedAttachment, 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 DocumentDto instance.

Properties

attachmentId String?
Id of attachment to this document
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
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
decryptedAttachment 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
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
documentLocation DocumentDtoDocumentLocationEnum?
Location of the document
getter/setter pair
documentStatus DocumentDtoDocumentStatusEnum?
The status of the development of the document. Ex: Draft, finalized, reviewed, signed, etc.
getter/setter pair
documentType DocumentDtoDocumentTypeEnum?
The type of document, ex: admission, clinical path, document report,invoice, etc.
getter/setter pair
encryptedAttachment 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
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
externalUri String?
When the document is stored in an external repository, this is the uri of the document in that repository
getter/setter pair
externalUuid String?
A unique external id (from another external source).
getter/setter pair
hash String?
Hashed version of the document
getter/setter pair
hashCode int
The hash code for this object.
no setteroverride
id String
The Id of the document. We encourage using either a v4 UUID or a HL7 Id.
getter/setter pair
mainUti String?
The main Uniform Type Identifier of the document (https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/understanding_utis/understand_utis_conc/understand_utis_conc.html#//apple_ref/doc/uid/TP40001319-CH202-CHDHIJDE)
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
name String?
Name of the document
getter/setter pair
objectStoreReference String?
Reference in object store
getter/setter pair
openingContactId String?
Id of the contact during which the document was created
getter/setter pair
otherUtis Set<String>
Extra Uniform Type Identifiers
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 document 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
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
size int?
Size of the document file
getter/setter pair
storedICureDocumentId String?
The ICureDocument (Form, Contact, ...) that has been used to generate the document
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
version String?
The document version
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) DocumentDto?
Returns a new DocumentDto instance and imports its values from value if it's a Map, null otherwise.
listFromJson(dynamic json, {bool growable = false}) List<DocumentDto>?
mapFromJson(dynamic json) Map<String, DocumentDto>
mapListFromJson(dynamic json, {bool growable = false}) Map<String, List<DocumentDto>>

Constants

requiredKeys → const Set<String>
The list of required keys that must be present in a JSON.