HealthcarePartyDto class

Available extensions

• HealthCarePartyDtoExtension

Constructors

HealthcarePartyDto({required String id, String? rev, int? created, int? modified, int? deletionDate, String? name, String? lastName, String? firstName, List<PersonNameDto> names = const [], HealthcarePartyDtoGenderEnum? gender, String? civility, String? companyName, String? speciality, String? bankAccount, String? bic, String? proxyBankAccount, String? proxyBic, String? invoiceHeader, String? cbe, String? ehp, String? userId, String? parentId, int? convention, String? nihii, String? nihiiSpecCode, String? ssin, List<AddressDto> addresses = const [], List<String> languages = const [], String? picture, Set<HealthcarePartyDtoStatusesEnum> statuses = const {}, List<HealthcarePartyHistoryStatusDto> statusHistory = const [], Set<CodeStubDto> specialityCodes = const {}, Map<String, String> sendFormats = const {}, String? notes, List<FinancialInstitutionInformationDto> financialInstitutionInformation = const [], String? billingType, String? type, String? contactPerson, String? contactPersonHcpId, String? supervisorId, List<FlatRateTarificationDto> flatRateTarifications = const [], Map<String, String> importedData = const {}, Map<String, String> options = 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})

Returns a new HealthcarePartyDto instance.

Properties

addresses ↔ List<AddressDto>

The list of addresses (with address type).

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

bankAccount ↔ String?

Bank Account identifier of the healhtcare party, IBAN, deprecated, use financial institutions instead

getter/setter pair

bic ↔ String?

Bank Identifier Code, the SWIFT Address assigned to the bank, use financial institutions instead

getter/setter pair

billingType ↔ String?

The invoicing scheme this healthcare party adheres to : 'service fee' or 'flat rate'

getter/setter pair

cbe ↔ String?

Identifier number for institution type if the healthcare party is an enterprise

getter/setter pair

civility ↔ String?

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

getter/setter pair

companyName ↔ String?

The name of the company this healthcare party is member of

getter/setter pair

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

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

convention ↔ int?

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

created ↔ int?

creation timestamp of the object.

getter/setter pair

deletionDate ↔ int?

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

getter/setter pair

ehp ↔ String?

Identifier number for the institution if the healthcare party is an organization

getter/setter pair

financialInstitutionInformation ↔ List<FinancialInstitutionInformationDto>

List of financial information (Bank, bank account).

getter/setter pair

firstName ↔ String?

the firstname (name) of the healthcare party.

getter/setter pair

flatRateTarifications ↔ List<FlatRateTarificationDto>

getter/setter pair

gender ↔ HealthcarePartyDtoGenderEnum?

the gender of the healthcare party: 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 healthcare party. We encourage using either a v4 UUID or a HL7 Id.

getter/setter pair

importedData ↔ Map<String, String>

getter/setter pair

invoiceHeader ↔ String?

All details included in the invoice header

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 healthcare party. This is the official lastname that should be used for official administrative purposes.

getter/setter pair

modified ↔ int?

last modification timestamp of the object.

getter/setter pair

name ↔ String?

The full name of the healthcare party, used mainly when the healthcare party is an organization

getter/setter pair

names ↔ List<PersonNameDto>

the list of all names of the healthcare party, also containing the official full name information. Ordered by preference of use. First element is therefore the official name used for the healthcare party in the application

getter/setter pair

nihii ↔ String?

National Institute for Health and Invalidity Insurance number assigned to healthcare parties (institution or person).

getter/setter pair

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

notes ↔ String?

Text notes.

getter/setter pair

options ↔ Map<String, String>

getter/setter pair

parentId ↔ String?

Id of parent of the user representing the healthcare party.

getter/setter pair

picture ↔ String?

A picture usually saved in JPEG format.

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

properties ↔ Set<PropertyStubDto>

getter/setter pair

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

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

publicKey ↔ String?

The public key of this hcp

getter/setter pair

rev ↔ String?

the revision of the healthcare party 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

sendFormats ↔ Map<String, String>

The type of format for contacting the healthcare party, ex: mobile, phone, email, etc.

getter/setter pair

speciality ↔ String?

Medical specialty of the healthcare party

getter/setter pair

specialityCodes ↔ Set<CodeStubDto>

Medical specialty of the healthcare party codified using FHIR or Kmehr codificaiton scheme

getter/setter pair

ssin ↔ String?

Social security inscription number.

getter/setter pair

statuses ↔ Set<HealthcarePartyDtoStatusesEnum>

The healthcare party's status: 'trainee' or 'withconvention' or 'accredited'

getter/setter pair

statusHistory ↔ List<HealthcarePartyHistoryStatusDto>

The healthcare party's status history

getter/setter pair

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

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

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

userId ↔ String?

The id of the user that usually handles this healthcare party.

getter/setter pair

Methods

findName(PersonNameDtoUseEnum nameUse) → PersonNameDto

Available on HealthcarePartyDto, provided by the HealthCarePartyDtoExtension extension

hasName(PersonNameDtoUseEnum nameUse) → bool

Available on HealthcarePartyDto, provided by the HealthCarePartyDtoExtension extension

initHcParty() → HealthcarePartyDto

Available on HealthcarePartyDto, provided by the HealthCarePartyDtoExtension extension

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

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

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

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

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

Constants

requiredKeys → const Set<String>

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