chore: add entity for surgery report

Author: giacomoaccursi

src/main/kotlin/entity/surgeryreport/healthcareuser/HealthcareUser.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2023. Smart Operating Block
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package entity.surgeryreport.healthcareuser
+
+import kotlinx.serialization.Serializable
+
+/**
+ * It represents a Healthcare user of the Healthcare national system.
+ * Each user is identified by their [taxCode] and has a [name] and a [surname].
+ */
+@Serializable
+data class HealthcareUser(
+    val taxCode: TaxCode,
+    val name: String,
+    val surname: String,
+) {
+    override fun equals(other: Any?): Boolean = when {
+        other === this -> true
+        other is HealthcareUser -> this.taxCode == other.taxCode
+        else -> false
+    }
+
+    override fun hashCode(): Int = this.taxCode.hashCode()
+}
+
+/**
+ * Tax Code of a [HealthcareUser].
+ * @param[value] the tax code.
+ */
+@Serializable
+data class TaxCode(val value: String) {
+    init {
+        // Constructor validation: the code must not be empty
+        require(this.value.isNotEmpty())
+    }
+}

src/main/kotlin/entity/surgeryreport/healthcareuser/Patient.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2023. Smart Operating Block
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package entity.surgeryreport.healthcareuser
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Id of [HealthcareUser] under a surgery.
+ * @param[value] the id.
+ */
+@Serializable
+data class PatientID(val value: String) {
+    init {
+        // Constructor validation: The id must not be empty
+        require(this.value.isNotEmpty())
+    }
+}
+
+/**
+ * [VitalSign]s of a patient.
+ * - [heartBeat]
+ * - [diastolicBloodPressure]
+ * - [systolicBloodPressure]
+ * - [respiratoryRate]
+ * - [saturationPercentage]
+ * - [bodyTemperature]
+ */
+@Serializable
+data class PatientVitalSigns(
+    val heartBeat: VitalSign.HeartBeat? = null,
+    val diastolicBloodPressure: VitalSign.DiastolicBloodPressure? = null,
+    val systolicBloodPressure: VitalSign.SystolicBloodPressure? = null,
+    val respiratoryRate: VitalSign.RespiratoryRate? = null,
+    val saturationPercentage: VitalSign.SaturationPercentage? = null,
+    val bodyTemperature: VitalSign.BodyTemperature? = null,
+)

src/main/kotlin/entity/surgeryreport/healthcareuser/VitalSign.kt

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2023. Smart Operating Block
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package entity.surgeryreport.healthcareuser
+
+import entity.surgeryreport.measurements.Percentage
+import entity.surgeryreport.measurements.Temperature
+import kotlinx.serialization.Serializable
+
+/**
+ * Module that wraps all the vital signs for a patient under surgery.
+ */
+object VitalSign {
+    /** The [bpm] of the patient. */
+    @Serializable
+    data class HeartBeat(val bpm: Int) {
+        init {
+            require(this.bpm >= 0) {
+                "Beat per minute cannot be negative"
+            }
+        }
+    }
+
+    /** The Diastolic blood [pressure] of the patient. */
+    @Serializable
+    data class DiastolicBloodPressure(val pressure: Int) {
+        init {
+            require(this.pressure >= 0) {
+                "Diastolic blood pressure cannot be negative"
+            }
+        }
+    }
+
+    /** The Systolic blood [pressure] of the patient. */
+    @Serializable
+    data class SystolicBloodPressure(val pressure: Int) {
+        init {
+            require(this.pressure >= 0) {
+                "Systolic blood pressure cannot be negative"
+            }
+        }
+    }
+
+    /** The Respiratory [rate] of the patient. */
+    @Serializable
+    data class RespiratoryRate(val rate: Int) {
+        init {
+            require(this.rate >= 0) {
+                "Respiratory rate cannot be negative"
+            }
+        }
+    }
+
+    /** The Saturation [percentage] of the patient. */
+    @Serializable
+    data class SaturationPercentage(val percentage: Percentage)
+
+    /** The body [temperature] of the patient. */
+    @Serializable
+    data class BodyTemperature(val temperature: Temperature) {
+        init {
+            require(this.temperature.value >= 0) {
+                "Body temperature cannot be negative"
+            }
+        }
+    }
+}

src/main/kotlin/entity/surgeryreport/healthprofessional/HealthProfessionalID.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2023. Smart Operating Block
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package entity.surgeryreport.healthprofessional
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Identification of a health professional working withing the Operating Block.
+ * @param[value] the id.
+ */
+@Serializable
+data class HealthProfessionalID(val value: String) {
+    init {
+        // Constructor validation: the id must not be empty
+        require(this.value.isNotEmpty())
+    }
+}

src/main/kotlin/entity/surgeryreport/measurements/AggregateData.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2023. Smart Operating Block
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package entity.surgeryreport.measurements
+
+import kotlinx.serialization.Serializable
+
+/**
+ * It describes aggregate data of type [E].
+ * It stores the [average], the [std], the [maximum] and the [minimum].
+ */
+@Serializable
+data class AggregateData<out E>(
+    val average: E,
+    val std: E,
+    val maximum: E,
+    val minimum: E,
+)

src/main/kotlin/entity/surgeryreport/measurements/Measurements.kt

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2023. Smart Operating Block
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package entity.surgeryreport.measurements
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Temperature concept.
+ * It is described by the current temperature [value] expressed in a [unit].
+ */
+@Serializable
+data class Temperature(val value: Double, val unit: TemperatureUnit = TemperatureUnit.CELSIUS)
+
+/**
+ * This enum describe the possible [Temperature] unit of measurement.
+ */
+@Serializable
+enum class TemperatureUnit {
+    /**
+     * Celsius unit.
+     */
+    CELSIUS,
+}
+
+/**
+ * Percentage concept.
+ * It represents a generic percentage.
+ * Therefore, its [value] must be within 0 and 100.
+ */
+@Serializable
+data class Percentage(val value: Double) {
+    init {
+        // Constructor validation
+        require(value in 0.0..100.0) { "Value of the percentage must be between 0 and 100" }
+    }
+}
+
+/**
+ * Humidity concept.
+ * It is described by the current [percentage] of humidity. So it describes the Relative Humidity.
+ */
+@Serializable
+data class Humidity(val percentage: Percentage)
+
+/**
+ * Luminosity concept.
+ * It is described by the current luminosity [value] expressed in a [unit].
+ */
+@Serializable
+data class Luminosity(val value: Double, val unit: LightUnit = LightUnit.LUX) {
+    init {
+        // Constructor validation
+        require(this.value >= 0)
+    }
+}
+
+/**
+ * This enum describe the possible [Luminosity] unit of measurement.
+ */
+@Serializable
+enum class LightUnit {
+    /**
+     * Lux unit.
+     */
+    LUX,
+}
+
+/**
+ * Describe the presence inside a room.
+ * @param[presenceDetected] true if someone is in the room, false otherwise.
+ */
+@Serializable
+data class Presence(val presenceDetected: Boolean)

src/main/kotlin/entity/surgeryreport/medicaldevice/ImplantableMedicalDevice.kt

@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2023. Smart Operating Block
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package entity.surgeryreport.medicaldevice
+
+import kotlinx.serialization.Serializable
+
+/**
+ * It describes an implantable medical device used during a surgery inside an Operating Room.
+ * It is identified by its [id] and it is of a particular [type].
+ */
+@Serializable
+data class ImplantableMedicalDevice(
+    val id: ImplantableMedicalDeviceID,
+    val type: ImplantableMedicalDeviceType,
+) {
+    override fun equals(other: Any?): Boolean = when {
+        other === this -> true
+        other is ImplantableMedicalDevice -> this.id == other.id
+        else -> false
+    }
+
+    override fun hashCode(): Int = this.id.hashCode()
+}
+
+/**
+ * Identification for [ImplantableMedicalDevice].
+ * @param[value] the id.
+ */
+@Serializable
+data class ImplantableMedicalDeviceID(val value: String) {
+    init {
+        // Constructor validation: the id must not be empty
+        require(this.value.isNotEmpty())
+    }
+}
+
+/**
+ * The types of [ImplantableMedicalDevice].
+ */
+@Serializable
+enum class ImplantableMedicalDeviceType {
+    /** The Catheter is an implantable medical device type. */
+    CATHETER,
+
+    /** The pacemaker is an implantable medical device type. */
+    PACEMAKER,
+}