@iveri/contracts 0.47.0 → 0.48.0

package/dist/api/clinic/clinic-consent-form.type.d.ts

@@ -0,0 +1,14 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { LocalizedText } from './localized-text.type.js';
+/** One version of what a client agrees to before a treatment. A change is a new version. */
+export interface ClinicConsentForm {
+    id: UUID;
+    treatmentId: UUID;
+    version: number;
+    body: LocalizedText;
+    createdAt: IsoDateTime;
+}
+export interface PublishClinicConsentFormRequest {
+    body: LocalizedText;
+}

package/dist/api/clinic/clinic-consent-form.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-my-appointment.type.d.ts

@@ -3,6 +3,7 @@ import type { Nullable } from '../../type/nil.type.js';
 import type { UUID } from '../../type/uuid.type.js';
 import type { ClinicAppointmentStatus } from './clinic-appointment-status.enum.js';
 import type { ClinicAppointmentLine } from './clinic-appointment.type.js';
+import type { ClinicScreeningAnswerRequest, SignClinicConsentRequest } from './clinic-record.type.js';
 import type { LocalizedText } from './localized-text.type.js';
 /** A client's own view of a booking, without the room and machine the clinic assigned. */
 export interface MyClinicAppointment {
@@ -32,6 +33,17 @@ export interface BookMyClinicAppointmentRequest {
     staffMemberId: UUID;
     startsAt: IsoDateTime;
     note?: Nullable<string>;
+    /** One answer for each of the treatment's questions. Required when it has any. */
+    screening?: ClinicScreeningAnswerRequest[];
+    /** Required when the treatment has a consent form this client has not signed yet. */
+    consent?: SignClinicConsentRequest;
+}
+/** What one client still has to do before booking one treatment. */
+export interface MyClinicBookingStatus {
+    /** Whether the booking has to carry a signature, which it does until the current form is signed. */
+    needsConsent: boolean;
+    /** When this client's next session may start, or `null` when nothing they have booked limits it. */
+    nextSessionFrom: Nullable<IsoDateTime>;
 }
 export interface SaveMyClinicClientRequest {
     firstName: string;

package/dist/api/clinic/clinic-public.type.d.ts

@@ -94,3 +94,23 @@ export interface PublicReviewList {
     count: number;
     items: PublicReview[];
 }
+export interface PublicScreeningQuestion {
+    id: UUID;
+    text: LocalizedText;
+    /** The answer that rules the treatment out, or `null` when it is only for the specialist to read. */
+    stopsBookingOn: Nullable<boolean>;
+}
+export interface PublicConsentForm {
+    version: number;
+    body: LocalizedText;
+}
+/**
+ * What a treatment asks of somebody before it can be booked.
+ *
+ * The rule travels with the question so a client can stop at the answer that rules it out, without
+ * sending somebody's health information anywhere when no booking is going to follow.
+ */
+export interface PublicBookingForm {
+    questions: PublicScreeningQuestion[];
+    consent: Nullable<PublicConsentForm>;
+}

package/dist/api/clinic/clinic-record-access-action.enum.d.ts

@@ -0,0 +1,5 @@
+/** What somebody opened: one visit's record, or a client's whole history. */
+export declare enum ClinicRecordAccessAction {
+    VISIT = "visit",
+    CLIENT = "client"
+}

package/dist/api/clinic/clinic-record-access-action.enum.js

@@ -0,0 +1,6 @@
+/** What somebody opened: one visit's record, or a client's whole history. */
+export var ClinicRecordAccessAction;
+(function (ClinicRecordAccessAction) {
+    ClinicRecordAccessAction["VISIT"] = "visit";
+    ClinicRecordAccessAction["CLIENT"] = "client";
+})(ClinicRecordAccessAction || (ClinicRecordAccessAction = {}));

package/dist/api/clinic/clinic-record-method.enum.d.ts

@@ -0,0 +1,5 @@
+/** Whether the client entered it themselves, or a member of staff recorded it with them there. */
+export declare enum ClinicRecordMethod {
+    ONLINE = "online",
+    IN_CLINIC = "in-clinic"
+}

package/dist/api/clinic/clinic-record-method.enum.js

@@ -0,0 +1,6 @@
+/** Whether the client entered it themselves, or a member of staff recorded it with them there. */
+export var ClinicRecordMethod;
+(function (ClinicRecordMethod) {
+    ClinicRecordMethod["ONLINE"] = "online";
+    ClinicRecordMethod["IN_CLINIC"] = "in-clinic";
+})(ClinicRecordMethod || (ClinicRecordMethod = {}));

package/dist/api/clinic/clinic-record.type.d.ts

@@ -0,0 +1,129 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { ClinicAppointmentStatus } from './clinic-appointment-status.enum.js';
+import type { ClinicConsentForm } from './clinic-consent-form.type.js';
+import type { ClinicRecordAccessAction } from './clinic-record-access-action.enum.js';
+import type { ClinicRecordMethod } from './clinic-record-method.enum.js';
+import type { ClinicScreeningQuestion } from './clinic-screening-question.type.js';
+import type { LocalizedText } from './localized-text.type.js';
+export interface ClinicScreeningAnswerRequest {
+    questionId: UUID;
+    answer: boolean;
+}
+/** An answer beside the question as it read when it was asked, which is what gives it meaning. */
+export interface ClinicScreeningAnswer {
+    questionId: UUID;
+    question: LocalizedText;
+    answer: boolean;
+    /** Whether this answer is the one that rules the treatment out. */
+    isFlagged: boolean;
+}
+export interface ClinicScreening {
+    id: UUID;
+    appointmentId: UUID;
+    treatmentId: UUID;
+    treatmentName: LocalizedText;
+    answers: ClinicScreeningAnswer[];
+    hasFlaggedAnswer: boolean;
+    method: ClinicRecordMethod;
+    recordedByName: Nullable<string>;
+    createdAt: IsoDateTime;
+}
+export interface RecordClinicScreeningRequest {
+    answers: ClinicScreeningAnswerRequest[];
+}
+export interface SignClinicConsentRequest {
+    /** The version that was on screen, so nobody signs one they have not read. */
+    version: number;
+    /** The language of the text that was on screen. The form must be written in it. */
+    locale: string;
+    signedName: string;
+}
+/** The exact text somebody agreed to, kept whatever later happens to the form. */
+export interface ClinicConsentSignature {
+    id: UUID;
+    appointmentId: UUID;
+    treatmentId: UUID;
+    treatmentName: LocalizedText;
+    version: number;
+    locale: string;
+    text: string;
+    signedName: string;
+    method: ClinicRecordMethod;
+    recordedByName: Nullable<string>;
+    signedAt: IsoDateTime;
+}
+/** A setting used for the session, such as a fluence or a needle depth, as the specialist wrote it. */
+export interface ClinicTreatmentParameter {
+    name: string;
+    value: string;
+}
+/** What was done at one session. It is never edited: a correction is a new entry pointing at it. */
+export interface ClinicTreatmentLogEntry {
+    id: UUID;
+    appointmentId: UUID;
+    treatmentId: UUID;
+    treatmentName: LocalizedText;
+    specialistName: string;
+    parameters: ClinicTreatmentParameter[];
+    reaction: Nullable<string>;
+    notes: Nullable<string>;
+    /** Why the session went ahead despite a flagged screening answer. */
+    overrideReason: Nullable<string>;
+    correctsEntryId: Nullable<UUID>;
+    correctionReason: Nullable<string>;
+    /** The entry that replaced this one, or `null` while this is the one that stands. */
+    correctedByEntryId: Nullable<UUID>;
+    recordedByName: Nullable<string>;
+    createdAt: IsoDateTime;
+}
+export interface CreateClinicTreatmentLogEntryRequest {
+    parameters: ClinicTreatmentParameter[];
+    reaction?: Nullable<string>;
+    notes?: Nullable<string>;
+    /** Required when the latest screening has a flagged answer, and refused when it has none. */
+    overrideReason?: Nullable<string>;
+}
+export interface CorrectClinicTreatmentLogEntryRequest {
+    parameters: ClinicTreatmentParameter[];
+    reaction?: Nullable<string>;
+    notes?: Nullable<string>;
+    reason: string;
+}
+/** Everything a specialist needs in the room for one visit. */
+export interface ClinicVisitRecord {
+    appointmentId: UUID;
+    clientId: UUID;
+    clientName: string;
+    treatmentId: UUID;
+    treatmentName: LocalizedText;
+    specialistName: string;
+    status: ClinicAppointmentStatus;
+    startsAt: IsoDateTime;
+    questions: ClinicScreeningQuestion[];
+    screening: Nullable<ClinicScreening>;
+    /** The form's current version, or `null` when this treatment has none. */
+    consentForm: Nullable<ClinicConsentForm>;
+    /** The signature of that version, or `null` when it has not been signed. */
+    consent: Nullable<ClinicConsentSignature>;
+    /** The session's entry and its corrections, oldest first. */
+    entries: ClinicTreatmentLogEntry[];
+}
+/** A client's whole history at this clinic, newest first. */
+export interface ClinicClientRecord {
+    clientId: UUID;
+    clientName: string;
+    consents: ClinicConsentSignature[];
+    screenings: ClinicScreening[];
+    entries: ClinicTreatmentLogEntry[];
+}
+export interface ClinicRecordAccess {
+    id: UUID;
+    actorUserId: UUID;
+    /** The member of staff who read it, or `null` for an account that is not one. */
+    actorName: Nullable<string>;
+    appointmentId: Nullable<UUID>;
+    action: ClinicRecordAccessAction;
+    createdAt: IsoDateTime;
+}

package/dist/api/clinic/clinic-record.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-screening-question.type.d.ts

@@ -0,0 +1,24 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { LocalizedText } from './localized-text.type.js';
+/** A yes or no question a treatment asks first. Which answer matters is the clinic's judgement. */
+export interface ClinicScreeningQuestion {
+    id: UUID;
+    treatmentId: UUID;
+    text: LocalizedText;
+    /** The answer that rules the treatment out, or `null` when it is only for the specialist to read. */
+    stopsBookingOn: Nullable<boolean>;
+    sortOrder: number;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicScreeningQuestionRequest {
+    text: LocalizedText;
+    stopsBookingOn?: Nullable<boolean>;
+}
+export interface UpdateClinicScreeningQuestionRequest {
+    text?: LocalizedText;
+    stopsBookingOn?: Nullable<boolean>;
+    sortOrder?: number;
+}

package/dist/api/clinic/clinic-screening-question.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/index.d.ts

@@ -1,6 +1,7 @@
 export * from './clinic-appointment-status.enum.js';
 export * from './clinic-appointment.type.js';
 export * from './clinic-client.type.js';
+export * from './clinic-consent-form.type.js';
 export * from './clinic-device.type.js';
 export * from './clinic-lead-kind.enum.js';
 export * from './clinic-lead-status.enum.js';
@@ -16,10 +17,14 @@ export * from './clinic-newsletter.type.js';
 export * from './clinic-profile.type.js';
 export * from './clinic-promotion.type.js';
 export * from './clinic-public.type.js';
+export * from './clinic-record-access-action.enum.js';
+export * from './clinic-record-method.enum.js';
+export * from './clinic-record.type.js';
 export * from './clinic-resource-status.enum.js';
 export * from './clinic-review-status.enum.js';
 export * from './clinic-review.type.js';
 export * from './clinic-room.type.js';
+export * from './clinic-screening-question.type.js';
 export * from './clinic-slot.type.js';
 export * from './clinic-specialty.type.js';
 export * from './clinic-staff.type.js';

package/dist/api/clinic/index.js

@@ -1,6 +1,7 @@
 export * from './clinic-appointment-status.enum.js';
 export * from './clinic-appointment.type.js';
 export * from './clinic-client.type.js';
+export * from './clinic-consent-form.type.js';
 export * from './clinic-device.type.js';
 export * from './clinic-lead-kind.enum.js';
 export * from './clinic-lead-status.enum.js';
@@ -16,10 +17,14 @@ export * from './clinic-newsletter.type.js';
 export * from './clinic-profile.type.js';
 export * from './clinic-promotion.type.js';
 export * from './clinic-public.type.js';
+export * from './clinic-record-access-action.enum.js';
+export * from './clinic-record-method.enum.js';
+export * from './clinic-record.type.js';
 export * from './clinic-resource-status.enum.js';
 export * from './clinic-review-status.enum.js';
 export * from './clinic-review.type.js';
 export * from './clinic-room.type.js';
+export * from './clinic-screening-question.type.js';
 export * from './clinic-slot.type.js';
 export * from './clinic-specialty.type.js';
 export * from './clinic-staff.type.js';

package/dist/enum/user-permission.enum.d.ts

@@ -450,7 +450,13 @@ export declare enum UserPermission {
     /** See what a clinic is promoting and publishing. */
     CLINIC_MARKETING_READ = "clinic:marketing:read",
     /** Change what a clinic is promoting and publishing, including its discounts. */
-    CLINIC_MARKETING_MANAGE = "clinic:marketing:manage"
+    CLINIC_MARKETING_MANAGE = "clinic:marketing:manage",
+    /** Read a client's clinical record. Reception runs the calendar without this. */
+    CLINIC_RECORD_READ = "clinic:record:read",
+    /** Add to a client's clinical record: screening answers, signed consent and the treatment log. */
+    CLINIC_RECORD_MANAGE = "clinic:record:manage",
+    /** See who has read a client's clinical record, which reading the record does not show. */
+    CLINIC_RECORD_AUDIT = "clinic:record:audit"
 }
 /**
  * Every member, for seeding the owner role and validating custom-role input.

package/dist/enum/user-permission.enum.js

@@ -513,6 +513,12 @@ export var UserPermission;
     UserPermission["CLINIC_MARKETING_READ"] = "clinic:marketing:read";
     /** Change what a clinic is promoting and publishing, including its discounts. */
     UserPermission["CLINIC_MARKETING_MANAGE"] = "clinic:marketing:manage";
+    /** Read a client's clinical record. Reception runs the calendar without this. */
+    UserPermission["CLINIC_RECORD_READ"] = "clinic:record:read";
+    /** Add to a client's clinical record: screening answers, signed consent and the treatment log. */
+    UserPermission["CLINIC_RECORD_MANAGE"] = "clinic:record:manage";
+    /** See who has read a client's clinical record, which reading the record does not show. */
+    UserPermission["CLINIC_RECORD_AUDIT"] = "clinic:record:audit";
 })(UserPermission || (UserPermission = {}));
 /**
  * Every member, for seeding the owner role and validating custom-role input.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iveri/contracts",
-  "version": "0.47.0",
+  "version": "0.48.0",
   "description": "Wire contracts shared by every Iveri backend and frontend. Zero runtime dependencies.",
   "license": "MIT",
   "repository": {