> 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/healthelement.md). # Healthcare Element This entity is a root level object. It represents a healthcare element. It is serialized in JSON and saved in the underlying CouchDB database. ## Properties | Property | Type | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id *` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | The Id of the healthcare element. 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/healthelement/String/README.md) | The revision of the patient in the database, used for conflict management / optimistic locking. | | `created` | [Long](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Long/README.md) | The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server. format: int64. | | `modified` | [Long](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Long/README.md) | 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. format: int64. | | `author` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server. | | `responsible` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server. | | `medicalLocationId` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | The id of the medical location where this entity was created. | | `tags *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/CodeStub/README.md) | 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. | | `codes *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/CodeStub/README.md) | 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 | | `endOfLife` | [Long](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Long/README.md) | Soft delete (unix epoch in ms) timestamp of the object. format: int64. | | `deletionDate` | [Long](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Long/README.md) | hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called. format: int64. | | `healthElementId` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | 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. | | `valueDate` | [Long](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Long/README.md) | The date (unix epoch in ms) when the healthcare element is noted to have started and also closes on the same date format: int64. | | `openingDate` | [Long](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Long/README.md) | The date (unix epoch in ms) of the start of the healthcare element. format: int64. | | `closingDate` | [Long](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Long/README.md) | The date (unix epoch in ms) marking the end of the healthcare element. format: int64. | | `descr` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | Description of the healthcare element. | | `note` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | A text note (can be confidential, encrypted by default). | | `relevant *` | [Boolean](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Boolean/README.md) | If the healthcare element is relevant or not (Set relevant by default). | | `idOpeningContact` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | Id of the opening contact when the healthcare element was created. | | `idClosingContact` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | Id of the closing contact for the healthcare element. | | `idService` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | Id of the service when a service is used to create a healthcare element. | | `status *` | [Integer](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Integer/README.md) | bit 0: active/inactive, bit 1: relevant/irrelevant, bit 2 : present/absent, ex: 0 = active,relevant and present format: int32. | | `laterality` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | Left or Right dominance/preference. Values: left, right | | `plansOfAction *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/PlanOfAction/README.md) | List of healthcare approaches. | | `episodes *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/Episode/README.md) | List of episodes of occurrences of the healthcare element. | | `careTeam *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/CareTeamMember/README.md) | List of care team members assigned for the healthcare element. | | `secretForeignKeys *` | [List](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | 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. | | `cryptedForeignKeys *` | [Map](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/List/README.md) | 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. | | `delegations *` | [Map](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/List/README.md) | 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 | | `encryptionKeys *` | [Map](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/List/README.md) | 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 | | `encryptedSelf` | [String](https://github.com/icure-io/icure-tech-docs/blob/master/icure-data-stack/icure-data-model/healthelement/String/README.md) | The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys. |