@acorex-platform/module-health-core-client 0.0.21

package/types/acorex-platform-module-health-core-client-contracts.d.ts

@@ -0,0 +1,342 @@
+import { AXPEntityProperty, AXPQueryFilter, AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+import { AXPMultiLanguageString, AXPEntityReference, AXPSystemStatusType, AXPCategoryListItem } from '@acorex-platform/framework-shared/core';
+import { AXMMetaDataBuilderValue } from '@acorex-platform/module-data-management-contracts';
+
+/** Health catalog scope for questionnaires, question bank items, and workflow definitions. */
+declare const HEALTH_CATALOG_SCOPE = "health-core.health";
+
+declare const AXMHealthCoreCommandKeys: {
+    readonly HealthEvent: {
+        readonly StartFlow: "HealthCore.HealthEvent:StartFlow";
+    };
+};
+
+declare const AXMHealthCoreMenuKeys: {
+    readonly Root: "health-core";
+    readonly BloodTypes: "health-core.blood-types";
+    readonly BodyParts: "health-core.body-parts";
+    readonly DisabilityStatuses: "health-core.disability-statuses";
+    readonly InjuryTypes: "health-core.injury-types";
+    readonly VaccinationTypes: "health-core.vaccination-types";
+    readonly HealthConditionTypes: "health-core.health-condition-types";
+    readonly HealthRestrictions: "health-core.health-restrictions";
+    readonly HealthRecordTypes: "health-core.health-record-types";
+    readonly HealthEvents: "health-core.health-events";
+    readonly HealthProfiles: "health-core.health-profiles";
+    readonly HealthConditions: "health-core.health-conditions";
+};
+
+/**
+ * Safety & Risk capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPSafetyRiskPermissionKeys: {
+    readonly Access: "SafetyRisk:Permission:Access";
+    readonly MaintainSafety: "SafetyRisk:Permission:MaintainSafety";
+    readonly MaintainRisk: "SafetyRisk:Permission:MaintainRisk";
+    readonly MaintainHealth: "SafetyRisk:Permission:MaintainHealth";
+    readonly MaintainAssessments: "SafetyRisk:Permission:MaintainAssessments";
+    readonly Setup: "SafetyRisk:Permission:Setup";
+};
+/**
+ * @deprecated Prefer {@link AXPSafetyRiskPermissionKeys}.
+ * Legacy nested shape kept so existing imports compile during migration.
+ */
+declare const AXMHealthCorePermissionKeys: {
+    readonly HealthCore: {
+        readonly BloodType: {
+            readonly Management: "SafetyRisk:Permission:Setup";
+        };
+        readonly BodyPart: {
+            readonly Management: "SafetyRisk:Permission:Setup";
+        };
+        readonly DisabilityStatus: {
+            readonly Management: "SafetyRisk:Permission:Setup";
+        };
+        readonly InjuryType: {
+            readonly Management: "SafetyRisk:Permission:Setup";
+        };
+        readonly VaccinationType: {
+            readonly Management: "SafetyRisk:Permission:Setup";
+        };
+        readonly HealthConditionType: {
+            readonly Management: "SafetyRisk:Permission:Setup";
+        };
+        readonly HealthRestriction: {
+            readonly Management: "SafetyRisk:Permission:Setup";
+        };
+        readonly HealthRecordType: {
+            readonly Management: "SafetyRisk:Permission:Setup";
+        };
+        readonly HealthProfile: {
+            readonly ViewOwn: "SafetyRisk:Permission:MaintainHealth";
+            readonly EditOwn: "SafetyRisk:Permission:MaintainHealth";
+            readonly View: "SafetyRisk:Permission:MaintainHealth";
+            readonly Manage: "SafetyRisk:Permission:MaintainHealth";
+        };
+        readonly HealthCondition: {
+            readonly ViewOwn: "SafetyRisk:Permission:MaintainHealth";
+            readonly EditOwn: "SafetyRisk:Permission:MaintainHealth";
+            readonly View: "SafetyRisk:Permission:MaintainHealth";
+            readonly Manage: "SafetyRisk:Permission:MaintainHealth";
+        };
+        readonly HealthEvent: {
+            readonly ViewOwn: "SafetyRisk:Permission:MaintainHealth";
+            readonly EditOwn: "SafetyRisk:Permission:MaintainHealth";
+            readonly View: "SafetyRisk:Permission:MaintainHealth";
+            readonly Manage: "SafetyRisk:Permission:MaintainHealth";
+        };
+    };
+};
+
+/** Subject lookup field omitted from create/update when injected from parent context. */
+declare const HEALTH_SUBJECT_PROPERTY_NAMES: readonly ["subject.id"];
+type PropertyLayoutRef = {
+    name: string;
+    layout?: Record<string, unknown>;
+};
+/** Omits subject lookup from master create/update layouts (subject is injected from context). */
+declare function omitHealthSubjectFromEditLayouts<T extends PropertyLayoutRef>(layouts: T[]): T[];
+
+/** Person subject type for health records shared between My Profile and employee detail. */
+declare const HEALTH_PERSON_SUBJECT_TYPE = "PersonCore.Person";
+/** Filters child health records by polymorphic subject on a parent entity detail context. */
+declare function healthSubjectReferenceConditions(subjectType: string): AXPQueryFilter[];
+/**
+ * Filters health records for an employee's linked person (`personId` on employee context).
+ * Use for all person-scoped health records on employee detail so data matches My Profile.
+ */
+declare function healthPersonSubjectReferenceConditions(personIdExpression?: string): AXPQueryFilter[];
+/** Single polymorphic subject lookup (assessment-case `subjectRef.id` pattern). */
+declare function createHealthSubjectLookupProperty(groupId: string, options?: {
+    readonly?: boolean;
+}): AXPEntityProperty;
+
+declare const RootConfig: {
+    readonly config: {
+        i18n: string;
+        module: string;
+    };
+    readonly module: {
+        readonly name: string;
+        readonly title: `@${string}:module.title`;
+        readonly icon: "fa-light fa-heart-pulse";
+    };
+    readonly entities: {
+        readonly bloodType: {
+            readonly name: "BloodType";
+            readonly title: `@${string}:blood-types.entities.blood-type.title`;
+            readonly titlePlural: `@${string}:blood-types.entities.blood-type.plural`;
+            readonly icon: "fa-light fa-droplet";
+        };
+        readonly bodyPart: {
+            readonly name: "BodyPart";
+            readonly title: `@${string}:body-parts.entities.body-part.title`;
+            readonly titlePlural: `@${string}:body-parts.entities.body-part.plural`;
+            readonly icon: "fa-light fa-person";
+        };
+        readonly disabilityStatus: {
+            readonly name: "DisabilityStatus";
+            readonly title: `@${string}:disability-statuses.entities.disability-status.title`;
+            readonly titlePlural: `@${string}:disability-statuses.entities.disability-status.plural`;
+            readonly icon: "fa-light fa-wheelchair";
+        };
+        readonly injuryType: {
+            readonly name: "InjuryType";
+            readonly title: `@${string}:injury-types.entities.injury-type.title`;
+            readonly titlePlural: `@${string}:injury-types.entities.injury-type.plural`;
+            readonly icon: "fa-light fa-bandage";
+        };
+        readonly vaccinationType: {
+            readonly name: "VaccinationType";
+            readonly title: `@${string}:vaccination-types.entities.vaccination-type.title`;
+            readonly titlePlural: `@${string}:vaccination-types.entities.vaccination-type.plural`;
+            readonly icon: "fa-light fa-syringe";
+        };
+        readonly healthConditionType: {
+            readonly name: "HealthConditionType";
+            readonly title: `@${string}:health-condition-types.entities.health-condition-type.title`;
+            readonly titlePlural: `@${string}:health-condition-types.entities.health-condition-type.plural`;
+            readonly icon: "fa-light fa-file-medical";
+        };
+        readonly healthRestriction: {
+            readonly name: "HealthRestriction";
+            readonly title: `@${string}:health-restrictions.entities.health-restriction.title`;
+            readonly titlePlural: `@${string}:health-restrictions.entities.health-restriction.plural`;
+            readonly icon: "fa-light fa-ban";
+        };
+        readonly healthRecordType: {
+            readonly name: "HealthRecordType";
+            readonly title: `@${string}:health-record-types.entities.health-record-type.title`;
+            readonly titlePlural: `@${string}:health-record-types.entities.health-record-type.plural`;
+            readonly icon: "fa-light fa-notes-medical";
+        };
+        readonly healthEvent: {
+            readonly name: "HealthEvent";
+            readonly title: `@${string}:health-events.entities.health-event.title`;
+            readonly titlePlural: `@${string}:health-events.entities.health-event.plural`;
+            readonly icon: "fa-light fa-file-medical";
+        };
+        readonly healthProfile: {
+            readonly name: "HealthProfile";
+            readonly title: `@${string}:health-profiles.entities.health-profile.title`;
+            readonly titlePlural: `@${string}:health-profiles.entities.health-profile.plural`;
+            readonly icon: "fa-light fa-heart-pulse";
+        };
+        readonly healthCondition: {
+            readonly name: "HealthCondition";
+            readonly title: `@${string}:health-conditions.entities.health-condition.title`;
+            readonly titlePlural: `@${string}:health-conditions.entities.health-condition.plural`;
+            readonly icon: "fa-light fa-file-medical";
+        };
+    };
+    readonly queries: {
+        readonly reports: {
+            readonly getHealthEventsByType: `${string}:Reports:GetHealthEventsByType`;
+            readonly getWorkplaceInjuries: `${string}:Reports:GetWorkplaceInjuries`;
+            readonly getActiveWorkRestrictions: `${string}:Reports:GetActiveWorkRestrictions`;
+            readonly getFitnessForWorkStatus: `${string}:Reports:GetFitnessForWorkStatus`;
+            readonly getVaccinationCoverage: `${string}:Reports:GetVaccinationCoverage`;
+            readonly getHealthRiskDistribution: `${string}:Reports:GetHealthRiskDistribution`;
+            readonly getIncompleteHealthProfiles: `${string}:Reports:GetIncompleteHealthProfiles`;
+            readonly getIncompleteHealthProfileEmployees: `${string}:Reports:GetIncompleteHealthProfileEmployees`;
+        };
+        readonly dashboard: {
+            readonly healthEventsTrendLine: `${string}:Dashboard:HealthEventsTrendLine`;
+        };
+    };
+};
+
+interface AXMHealthCoreBloodTypeEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+}
+
+interface AXMHealthCoreBodyPartEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+}
+
+interface AXMHealthCoreDisabilityStatusEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+}
+
+interface AXMHealthCoreHealthConditionRestrictionItem {
+    restrictionId: string;
+    restriction?: {
+        id: string;
+        title?: unknown;
+    };
+    startDate?: Date | string;
+    endDate?: Date | string;
+}
+interface AXMHealthCoreHealthConditionEntityModel extends AXPEntityModel<string> {
+    subject: AXPEntityReference;
+    conditionTypeId: string;
+    conditionType?: {
+        id: string;
+        title?: unknown;
+        kind?: string;
+    };
+    diagnosedDate?: Date | string;
+    restrictions?: AXMHealthCoreHealthConditionRestrictionItem[];
+    notes?: string;
+}
+
+type AXMHealthCoreHealthConditionKind = 'allergy' | 'chronic';
+interface AXMHealthCoreHealthConditionTypeEntityModel extends AXPEntityModel<string> {
+    title: unknown;
+    kind: AXMHealthCoreHealthConditionKind;
+    description?: unknown;
+    suggestedRestrictionIds?: string[];
+    suggestedRestrictions?: Array<{
+        id: string;
+        title: AXPMultiLanguageString;
+    }>;
+    metaDataList?: AXMMetaDataBuilderValue;
+}
+
+type AXMHealthCoreHealthEventStatus = AXPSystemStatusType.InProgress | AXPSystemStatusType.WaitingSignOff | AXPSystemStatusType.Completed | AXPSystemStatusType.Cancelled;
+interface AXMHealthCoreHealthEventEntityModel extends AXPEntityModel<string> {
+    subject: AXPEntityReference;
+    recordTypeId: string;
+    recordType?: {
+        id: string;
+        title?: AXPMultiLanguageString;
+    };
+    occurredDate?: Date | string;
+    endDate?: Date | string | null;
+    provider?: string;
+    facility?: string;
+    notes?: string;
+    employeeSignature?: string;
+    employeeSignedAt?: Date | string;
+    managerSignature?: string;
+    managerSignedAt?: Date | string;
+    statusId?: AXMHealthCoreHealthEventStatus;
+    status?: {
+        id: AXMHealthCoreHealthEventStatus;
+        title?: string;
+    };
+}
+
+interface AXMHealthCoreHealthProfileEntityModel extends AXPEntityModel<string> {
+    subject: AXPEntityReference;
+    bloodTypeId?: string;
+    bloodType?: {
+        id: string;
+        title?: unknown;
+    };
+    disabilityStatusId?: string;
+    disabilityStatus?: {
+        id: string;
+        title?: unknown;
+    };
+    smokingStatus?: string;
+    alcoholConsumption?: string;
+    healthRiskLevel?: string;
+    doctorName?: string;
+    doctorNumber?: string;
+    emergencyContactName?: string;
+    emergencyContactPhone?: string;
+    emergencyContactEmail?: string;
+    notes?: string;
+}
+
+/** Workflow template binding and admin-configured default inputs for health record types. */
+interface AXMHealthCoreHealthRecordTypeWorkflowConfig {
+    workflowDefinitionId: string;
+    workflowName: string;
+    defaultInput?: Record<string, unknown>;
+}
+/**
+ * Defines workflow defaults, questionnaire, and metadata schema for health timeline records.
+ */
+interface AXMHealthCoreHealthRecordTypeEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString;
+    workflowConfig?: AXMHealthCoreHealthRecordTypeWorkflowConfig | null;
+    icon?: string;
+    metaDataList?: AXMMetaDataBuilderValue;
+}
+
+interface AXMHealthCoreHealthRestrictionEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString;
+    categoryIds?: string[];
+    categories?: AXPCategoryListItem[];
+}
+
+interface AXMHealthCoreInjuryTypeEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+}
+
+interface AXMHealthCoreVaccinationTypeEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+}
+
+export { AXMHealthCoreCommandKeys, AXMHealthCoreMenuKeys, AXMHealthCorePermissionKeys, AXPSafetyRiskPermissionKeys, HEALTH_CATALOG_SCOPE, HEALTH_PERSON_SUBJECT_TYPE, HEALTH_SUBJECT_PROPERTY_NAMES, RootConfig, createHealthSubjectLookupProperty, healthPersonSubjectReferenceConditions, healthSubjectReferenceConditions, omitHealthSubjectFromEditLayouts };
+export type { AXMHealthCoreBloodTypeEntityModel, AXMHealthCoreBodyPartEntityModel, AXMHealthCoreDisabilityStatusEntityModel, AXMHealthCoreHealthConditionEntityModel, AXMHealthCoreHealthConditionKind, AXMHealthCoreHealthConditionRestrictionItem, AXMHealthCoreHealthConditionTypeEntityModel, AXMHealthCoreHealthEventEntityModel, AXMHealthCoreHealthEventStatus, AXMHealthCoreHealthProfileEntityModel, AXMHealthCoreHealthRecordTypeEntityModel, AXMHealthCoreHealthRecordTypeWorkflowConfig, AXMHealthCoreHealthRestrictionEntityModel, AXMHealthCoreInjuryTypeEntityModel, AXMHealthCoreVaccinationTypeEntityModel };

package/types/acorex-platform-module-health-core-client.d.ts

@@ -0,0 +1,32 @@
+import * as i0 from '@angular/core';
+import * as i1 from '@acorex-platform/framework-client/runtime';
+import { AXPMenuProvider, AXPMenuProviderContext } from '@acorex-platform/framework-client/common';
+import { AXPPermissionDefinitionProvider, AXPPermissionDefinitionProviderContext } from '@acorex-platform/framework-client/auth';
+
+declare class AXMHealthCoreHealthEventFeatureModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMHealthCoreHealthEventFeatureModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMHealthCoreHealthEventFeatureModule, never, [typeof i1.AXPRuntimeModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMHealthCoreHealthEventFeatureModule>;
+}
+
+declare class AXMHealthCoreModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMHealthCoreModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMHealthCoreModule, never, [typeof i1.AXPRuntimeModule, typeof AXMHealthCoreHealthEventFeatureModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMHealthCoreModule>;
+}
+
+declare class AXMHealthCoreMenuProvider implements AXPMenuProvider {
+    private readonly entityService;
+    provide(context: AXPMenuProviderContext): Promise<void>;
+}
+
+/**
+ * Registers health capabilities into the shared Safety & Risk group.
+ */
+declare class AXMHealthCorePermissionDefinitionProvider implements AXPPermissionDefinitionProvider {
+    define(context: AXPPermissionDefinitionProviderContext): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMHealthCorePermissionDefinitionProvider, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXMHealthCorePermissionDefinitionProvider>;
+}
+
+export { AXMHealthCoreMenuProvider, AXMHealthCoreModule, AXMHealthCorePermissionDefinitionProvider };