Skip to main content

HealthElement

A HealthElement is an encryptable, root-level entity that represents a medical event persistent in time. For example, it may represent an illness that lasts for a couple of days (e.g. a flu), a more prolonged state (e.g. pregnancy), or a permanent ailment (e.g. allergy).

Fields Encrypted by Default​

By default, the following fields of this entity will be encrypted:

  • descr
  • note
  • The markdown field in all the notes.

You can customize the encrypted fields as explained in this how to.

Properties​

Below you will find an explanation of the most commonly used properties in the entity that are not among the shared fields. For a full list, check the reference documentation (🚧).

careTeam​

A collection of object that contain information about all the healthcare actor related to the condition of this HealthcareElement.

closingDate​

The closingDate represent the moment when the HealthElement ended. It is encoded as a FuzzyDateTime.

descr​

A human-readable description for the HealthElement.

episodes​

A collection of objects that contain information about all the moments when the condition described by the HealthElement happened.

idOpeningContact​

The id of the Contact that represents the encounter where this HealthElement was created.

idClosingContact​

The id of the Contact that represents the encounter where this HealthElement is closed.

idService​

The id of a Service if this HealthElement was created within a specific Service in a contact.

note​

A textual note to include in the HealthElement.

notes​

Additional textual notes to include in the HealthElement.

openingDate​

The openingDate represent the starting moment of the event of the HealthElement. It is encoded as a FuzzyDateTime.

plansOfAction​

A collection of objects that contain information about all the healthcare approaches related to this HealthElement.

valueDate​

If the HealthElement was opened and closed on the same date, this field can be used instead of openingDate and closingDate. It is encoded as a FuzzyDateTime.