chore: add dto for surgery report

Author: giacomoaccursi

src/main/kotlin/application/presenter/api/report/SurgeryReportApiDto.kt

@@ -0,0 +1,77 @@
+/*
+ * 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 application.presenter.api.report
+
+import application.presenter.api.report.healthcareuser.HealthcareUserApiDto
+import application.presenter.api.report.healthcareuser.PatientVitalSignsApiDto
+import application.presenter.api.report.measurements.AggregateDataApiDto
+import application.presenter.api.report.medicaldevice.ImplantableMedicalDeviceApiDto
+import application.presenter.api.report.medicaldevice.MedicalTechnologyUsageApiDto
+import application.presenter.api.report.process.SurgicalProcessStepApiDto
+import application.presenter.api.report.room.RoomApiDto
+import application.presenter.api.report.room.RoomApiDtoType
+import application.presenter.api.report.room.RoomEnvironmentalDataApiDto
+import application.presenter.api.report.tracking.TrackingInformationApiDto
+import kotlinx.serialization.Serializable
+
+/**
+ * It represents the presentation of a single [entity.report.SurgeryReport] entry.
+ * The necessary information are the [surgicalProcessID], the [patientId], the [patientName], the [patientSurname],
+ * the [surgicalProcessDescription] and the [surgeryDate].
+ */
+@Serializable
+data class SurgeryReportEntry(
+    val surgicalProcessID: String,
+    val patientId: String,
+    val patientName: String?,
+    val patientSurname: String?,
+    val surgicalProcessDescription: String,
+    val surgeryDate: String,
+)
+
+/**
+ * It represents the presentation of a [entity.report.SurgeryReport].
+ * The necessary information are: the [surgicalProcessID], the [surgeryDate], the [surgicalProcessDescription],
+ * the [inChargeHealthProfessionalID], the [patientID], the [roomsInvolved], the [healthcareUser], the [stepData],
+ * the [consumedImplantableMedicalDevice], the [medicalTechnologyUsageData], the [healthProfessionalTrackingInformation]
+ * and the [additionalData].
+ */
+@Serializable
+data class SurgeryReportApiDto(
+    val surgicalProcessID: String,
+    val surgeryDate: String,
+    val surgicalProcessDescription: String,
+    val patientID: String,
+    val roomsInvolved: List<RoomApiDto>,
+    val inChargeHealthProfessionalID: String?,
+    val healthcareUser: HealthcareUserApiDto?,
+    val stepData: Map<SurgicalProcessStepApiDto, SurgicalProcessStepAggregateDataApiDto>,
+    val consumedImplantableMedicalDevice: Set<ImplantableMedicalDeviceApiDto>,
+    val medicalTechnologyUsageData: Set<MedicalTechnologyUsageApiDto>,
+    val healthProfessionalTrackingInformation: List<TrackingInformationApiDto>,
+    val additionalData: String,
+)
+
+/**
+ * Presenter class for the [entity.report.SurgeryProcessStepAggregateData].
+ * It represents its [startDateTime], [stopDateTime], [patientVitalSignAggregateData] and [environmentalAggregateData].
+ */
+@Serializable
+data class SurgicalProcessStepAggregateDataApiDto(
+    val startDateTime: String,
+    val stopDateTime: String?,
+    val patientVitalSignAggregateData: AggregateDataApiDto<PatientVitalSignsApiDto>,
+    val environmentalAggregateData: Map<RoomApiDtoType, AggregateDataApiDto<RoomEnvironmentalDataApiDto>>,
+)
+
+/**
+ * Presenter class for the integration of a surgery report with [additionalData].
+ */
+@Serializable
+data class SurgeryReportPatchApiDto(val additionalData: String)

src/main/kotlin/application/presenter/api/report/apiresponse/ApiResponses.kt

@@ -0,0 +1,37 @@
+/*
+ * 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 application.presenter.api.report.apiresponse
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Module that wraps the REST-API template responses.
+ */
+object ApiResponses {
+    /**
+     * Class that represents an [entry] returned as response by an API.
+     * It could include also the entry's [url].
+     */
+    @Serializable
+    data class ResponseEntry<out T>(val entry: T, val url: String?)
+
+    /**
+     * Class that represents an [entry] returned as response by an API.
+     * Each entry is associated with its [date].
+     */
+    @Serializable
+    data class ResponseTimedEntry<out T>(val entry: T, val date: String)
+
+    /**
+     * Class that represents a list of [entries] returned as response to an API request.
+     * As the REST API best-practise recommend it is included also the [total] number of the entries.
+     */
+    @Serializable
+    data class ResponseEntryList<out T>(val entries: List<T>, val total: Int)
+}

src/main/kotlin/application/presenter/api/report/healthcareuser/HealthcareUserApiDto.kt

@@ -0,0 +1,22 @@
+/*
+ * 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 application.presenter.api.report.healthcareuser
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Presenter class to serialize [entity.healthcareuser.HealthcareUser] information.
+ * The necessary information are the [taxCode], the [name] and the [surname].
+ */
+@Serializable
+data class HealthcareUserApiDto(
+    val taxCode: String,
+    val name: String,
+    val surname: String,
+)

src/main/kotlin/application/presenter/api/report/healthcareuser/PatientVitalSignsApiDto.kt

@@ -0,0 +1,27 @@
+/*
+ * 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 application.presenter.api.report.healthcareuser
+
+import application.presenter.api.report.measurements.ValueWithUnit
+import kotlinx.serialization.Serializable
+
+/**
+ * Presenter class to serialize [entity.healthcareuser.PatientVitalSigns].
+ * It describes the [heartBeat], the [diastolicBloodPressure], the [systolicBloodPressure], the [respiratoryRate],
+ * the [saturationPercentage] and the [bodyTemperature].
+ */
+@Serializable
+data class PatientVitalSignsApiDto(
+    val heartBeat: Int? = null,
+    val diastolicBloodPressure: Int? = null,
+    val systolicBloodPressure: Int? = null,
+    val respiratoryRate: Int? = null,
+    val saturationPercentage: Double? = null,
+    val bodyTemperature: ValueWithUnit<Double>? = null,
+)

src/main/kotlin/application/presenter/api/report/measurements/AggregateDataApiDto.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 application.presenter.api.report.measurements
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Presenter class for the [entity.measurements.AggregateData] class.
+ * It returns the following data: [average], [std], [maximum] and [minimum].
+ */
+@Serializable
+data class AggregateDataApiDto<out E>(
+    val average: E,
+    val std: E,
+    val maximum: E,
+    val minimum: E,
+)

src/main/kotlin/application/presenter/api/report/measurements/ValueWithUnit.kt

@@ -0,0 +1,17 @@
+/*
+ * 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 application.presenter.api.report.measurements
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Describes a [value] with a [unit] of measurement.
+ */
+@Serializable
+data class ValueWithUnit<T>(val value: T, val unit: String)

src/main/kotlin/application/presenter/api/report/medicaldevice/ImplantableMedicalDeviceApiDto.kt

@@ -0,0 +1,32 @@
+/*
+ * 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 application.presenter.api.report.medicaldevice
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Presenter class for the [entity.medicaldevice.ImplantableMedicalDevice] class.
+ * It returns: the [id] of the implantable medical device and the [type]
+ */
+@Serializable
+data class ImplantableMedicalDeviceApiDto(
+    val id: String,
+    val type: ImplantableMedicalDeviceApiDtoType,
+)
+
+/**
+ * Presenter enum class to represent [entity.medicaldevice.ImplantableMedicalDeviceType].
+ */
+enum class ImplantableMedicalDeviceApiDtoType {
+    /** The Catheter is an implantable medical device type. */
+    CATHETER,
+
+    /** The pacemaker is an implantable medical device type. */
+    PACEMAKER,
+}

src/main/kotlin/application/presenter/api/report/medicaldevice/MedicalTechnologyApiDto.kt

@@ -0,0 +1,43 @@
+/*
+ * 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 application.presenter.api.report.medicaldevice
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Presenter class for the [entity.medicaldevice.MedicalTechnology] class.
+ * It returns: the [id], the [name], the [description], the [type] of the medical technology and moreover
+ * if it is [inUse].
+ */
+@Serializable
+data class MedicalTechnologyApiDto(
+    val id: String,
+    val name: String,
+    val description: String? = null,
+    val type: MedicalTechnologyApiDtoType,
+    val inUse: Boolean = false,
+)
+
+/**
+ * Presenter enum to handle medical technology type.
+ */
+@Serializable
+enum class MedicalTechnologyApiDtoType {
+    ENDOSCOPE,
+    XRAY,
+}
+
+/**
+ * Presenter class that represent the usage of a [medicalTechnology] in a specific [dateTime].
+ */
+@Serializable
+data class MedicalTechnologyUsageApiDto(
+    val dateTime: String,
+    val medicalTechnology: MedicalTechnologyApiDto,
+)

src/main/kotlin/application/presenter/api/report/process/SurgicalProcessStepApiDto.kt

@@ -0,0 +1,35 @@
+/*
+ * 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 application.presenter.api.report.process
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Presenter enum class to represent the surgical process states and steps.
+ */
+@Serializable
+enum class SurgicalProcessStepApiDto {
+    /** Pre-surgery state - patient in preparation step. */
+    PATIENT_IN_PREPARATION,
+
+    /** Surgery state - patient on operating table step. */
+    PATIENT_ON_OPERATING_TABLE,
+
+    /** Surgery state - anesthesia step. */
+    ANESTHESIA,
+
+    /** Surgery state - surgery in progress step. */
+    SURGERY_IN_PROGRESS,
+
+    /** Surgery state - end of surgery step. */
+    END_OF_SURGERY,
+
+    /** Post-surgery state - patient under observation step. */
+    PATIENT_UNDER_OBSERVATION,
+}

src/main/kotlin/application/presenter/api/report/room/RoomApiDto.kt

@@ -0,0 +1,51 @@
+/*
+ * 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 application.presenter.api.report.room
+
+import application.presenter.api.report.measurements.ValueWithUnit
+import kotlinx.serialization.Serializable
+
+/**
+ * Presenter class to serialize [entity.room.Room] information.
+ * The necessary information are [id] and [type].
+ */
+@Serializable
+data class RoomApiDto(
+    val id: String,
+    val type: RoomApiDtoType,
+)
+
+/**
+ * Presenter enum class to represent the room type.
+ */
+@Serializable
+enum class RoomApiDtoType {
+    /** Operating room type. */
+    OPERATING_ROOM,
+
+    /** Pre-operating room type. */
+    PRE_OPERATING_ROOM,
+}
+
+/**
+ * Wraps all the environmental data associated to a Room.
+ * So it describes:
+ * - the [temperature] inside the room
+ * - the [humidity] inside the room
+ * - the [luminosity] inside the room
+ * - the [presence] of someone in the room
+ * All the data may be not present.
+ */
+@Serializable
+data class RoomEnvironmentalDataApiDto(
+    val temperature: ValueWithUnit<Double>? = null,
+    val humidity: Double? = null,
+    val luminosity: ValueWithUnit<Double>? = null,
+    val presence: Boolean? = null,
+)