> For the complete documentation index, see [llms.txt](https://icure.gitbook.io/icure/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://icure.gitbook.io/icure/icure-data-stack/icure-data-model/healthcareparty.md). # 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. ## Properties | Property | Type | Description | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id *` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | the Id of the healthcare party. We encourage using either a v4 UUID or a HL7 Id. | | `rev` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | the revision of the healthcare party in the database, used for conflict management / optimistic locking. | | `deletionDate` | [Long](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/Long/README.md) | hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called. format: int64. | | `name` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | The full name of the healthcare party, used mainly when the healthcare party is an organization | | `lastName` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | the lastname (surname) of the healthcare party. This is the official lastname that should be used for official administrative purposes. | | `firstName` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | the firstname (name) of the healthcare party. | | `gender` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | the gender of the healthcare party: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown Values: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown | | `civility` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | Mr., Ms., Pr., Dr. ... | | `companyName` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | The name of the company this healthcare party is member of | | `speciality` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | Medical specialty of the healthcare party | | `bankAccount` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | Bank Account identifier of the healhtcare party, IBAN, deprecated, use financial institutions instead | | `bic` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | Bank Identifier Code, the SWIFT Address assigned to the bank, use financial institutions instead | | `proxyBankAccount` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | | | `proxyBic` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | | | `invoiceHeader` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | All details included in the invoice header | | `cbe` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | Identifier number for institution type if the healthcare party is an enterprise | | `ehp` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | Identifier number for the institution if the healthcare party is an organization | | `userId` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | The id of the user that usually handles this healthcare party. | | `parentId` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | Id of parent of the user representing the healthcare party. | | `convention` | [Integer](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/Integer/README.md) | format: int32. | | `nihii` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | National Institute for Health and Invalidity Insurance number assigned to healthcare parties (institution or person). | | `nihiiSpecCode` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | | | `ssin` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | Social security inscription number. | | `addresses *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/Address/README.md) | The list of addresses (with address type). | | `languages *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | The list of languages spoken by the patient ordered by fluency (alpha-2 code ). | | `picture` | [Byte\[\]](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/Byte\[]/README.md) | A picture usually saved in JPEG format. format: byte. | | `statuses *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | The healthcare party's status: 'trainee' or 'withconvention' or 'accredited' Values: | | `statusHistory *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/HealthcarePartyHistoryStatus/README.md) | The healthcare party's status history | | `specialityCodes *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/CodeStub/README.md) | Medical specialty of the healthcare party codified using FHIR or Kmehr codificaiton scheme | | `sendFormats *` | [Map](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | The type of format for contacting the healthcare party, ex: mobile, phone, email, etc. | | `notes` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | Text notes. | | `financialInstitutionInformation *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/FinancialInstitutionInformation/README.md) | List of financial information (Bank, bank account). | | `billingType` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | The invoicing scheme this healthcare party adheres to : 'service fee' or 'flat rate' | | `type` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | | | `contactPerson` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | | | `contactPersonHcpId` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | | | `supervisorId` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | | | `flatRateTarifications *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/FlatRateTarification/README.md) | | | `importedData *` | [Map](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | | | `options *` | [Map](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | | | `hcPartyKeys *` | [Map](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/List/README.md) | 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](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | 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](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/String/README.md) | The public key of this hcp |