Healthcare Party
This entity is a root level object. It represents a healthcare party. It is serialized in JSON and saved in the underlying icure-healthcareParty CouchDB database.

Property
Type
Description
id *
โ€‹Stringโ€‹
the Id of the healthcare party. We encourage using either a v4 UUID or a HL7 Id.
rev
โ€‹Stringโ€‹
the revision of the healthcare party in the database, used for conflict management / optimistic locking.
deletionDate
โ€‹Longโ€‹
hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called. format: int64.
name
โ€‹Stringโ€‹
The full name of the healthcare party, used mainly when the healthcare party is an organization
lastName
โ€‹Stringโ€‹
the lastname (surname) of the healthcare party. This is the official lastname that should be used for official administrative purposes.
firstName
โ€‹Stringโ€‹
the firstname (name) of the healthcare party.
gender
โ€‹Stringโ€‹
the gender of the healthcare party: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown Values: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown
civility
โ€‹Stringโ€‹
Mr., Ms., Pr., Dr. ...
companyName
โ€‹Stringโ€‹
The name of the company this healthcare party is member of
speciality
โ€‹Stringโ€‹
Medical specialty of the healthcare party
bankAccount
โ€‹Stringโ€‹
Bank Account identifier of the healhtcare party, IBAN, deprecated, use financial institutions instead
bic
โ€‹Stringโ€‹
Bank Identifier Code, the SWIFT Address assigned to the bank, use financial institutions instead
proxyBankAccount
โ€‹Stringโ€‹
โ€‹
proxyBic
โ€‹Stringโ€‹
โ€‹
invoiceHeader
โ€‹Stringโ€‹
All details included in the invoice header
cbe
โ€‹Stringโ€‹
Identifier number for institution type if the healthcare party is an enterprise
ehp
โ€‹Stringโ€‹
Identifier number for the institution if the healthcare party is an organization
userId
โ€‹Stringโ€‹
The id of the user that usually handles this healthcare party.
parentId
โ€‹Stringโ€‹
Id of parent of the user representing the healthcare party.
convention
โ€‹Integerโ€‹
format: int32.
nihii
โ€‹Stringโ€‹
National Institute for Health and Invalidity Insurance number assigned to healthcare parties (institution or person).
nihiiSpecCode
โ€‹Stringโ€‹
โ€‹
ssin
โ€‹Stringโ€‹
Social security inscription number.
addresses *
โ€‹Listโ€‹
The list of addresses (with address type).
languages *
โ€‹Listโ€‹
The list of languages spoken by the patient ordered by fluency (alpha-2 code http://www.loc.gov/standards/iso639-2/ascii_8bits.html).
picture
โ€‹Byte[]โ€‹
A picture usually saved in JPEG format. format: byte.
statuses *
โ€‹Listโ€‹
The healthcare party's status: 'trainee' or 'withconvention' or 'accredited' Values:
statusHistory *
โ€‹Listโ€‹
The healthcare party's status history
specialityCodes *
โ€‹Listโ€‹
Medical specialty of the healthcare party codified using FHIR or Kmehr codificaiton scheme
sendFormats *
โ€‹Mapโ€‹
The type of format for contacting the healthcare party, ex: mobile, phone, email, etc.
notes
โ€‹Stringโ€‹
Text notes.
financialInstitutionInformation *
โ€‹Listโ€‹
List of financial information (Bank, bank account).
billingType
โ€‹Stringโ€‹
The invoicing scheme this healthcare party adheres to : 'service fee' or 'flat rate'
type
โ€‹Stringโ€‹
โ€‹
contactPerson
โ€‹Stringโ€‹
โ€‹
contactPersonHcpId
โ€‹Stringโ€‹
โ€‹
supervisorId
โ€‹Stringโ€‹
โ€‹
flatRateTarifications *
โ€‹Listโ€‹
โ€‹
importedData *
โ€‹Mapโ€‹
โ€‹
options *
โ€‹Mapโ€‹
โ€‹
hcPartyKeys *
โ€‹Mapโ€‹
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.
privateKeyShamirPartitions *
โ€‹Mapโ€‹
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
publicKey
โ€‹Stringโ€‹
The public key of this hcp
Last modified 10mo ago
Copy link