vet-data-utils-ts 0.4.2 → 0.4.5

package/README.md

@@ -8,6 +8,25 @@ Current surfaces cover the canonical animal-card DID, veterinary summary
 sections, animal-only emergency data, pseudonymous DigitalTwin search input and
 veterinary assistant intents.
 
+## Active sector extension
+
+`vet-data-utils-ts/sectors` extends the frozen CORE catalog without changing
+`gdc-common-utils-ts` or GW CORE. It adds the product-neutral
+`public-safety` value used by explicitly governed portal allowlists. Sector
+selection classifies an organization service; it does not grant membership,
+an occupation, an index role or access to any person or animal.
+
+```ts
+import { ExtendedDataspaceSectors } from 'vet-data-utils-ts/sectors'
+
+// The portal chooses its exact subset. Do not expose the complete catalog as
+// an authorization decision or infer capabilities from this selection.
+const allowedSectors = [
+  ExtendedDataspaceSectors.PublicSafety,
+  ExtendedDataspaceSectors.AnimalCare,
+] as const
+```
+
 `vet-data-utils-ts/organization-application` is the product-neutral application
 value used by UHC UNID, VetChain and SOSChain adapters. The host supplies the
 allowed sector list and translated labels. The value contains one official
@@ -17,6 +36,13 @@ controller and six independent index participation roles. It rejects a second
 `taxId` and every PIN field: profile protection happens immediately after
 login, before any application screen.
 
+`organizationServiceTypeForParticipationRoles()` projects those explicit
+business roles into the canonical GW `Service.serviceType` capability claim.
+Index and Digital Twin providers receive the corresponding `cruds` capability;
+consumers receive only `rs`. The application continues to retain the six roles
+separately, so this operational projection never erases who provides the index
+service and who merely provides or consumes its data.
+
 The financial surface defines provider-neutral flat claims for FHIR R5
 `Account`, `Invoice`, `PaymentNotice` and `PaymentReconciliation`. `Account`
 tracks charges and balances; the responsible party is represented through

package/dist/index.d.ts

@@ -5,4 +5,5 @@ export * from './emergency.js';
 export * from './financial.js';
 export * from './iso-jurisdictions.js';
 export * from './organization-application.js';
+export * from './sectors.js';
 export * from './veterinary-sections.js';

package/dist/index.js

@@ -5,4 +5,5 @@ export * from './emergency.js';
 export * from './financial.js';
 export * from './iso-jurisdictions.js';
 export * from './organization-application.js';
+export * from './sectors.js';
 export * from './veterinary-sections.js';

package/dist/organization-application.d.ts

@@ -33,6 +33,13 @@ export type ReusableOrganizationApplication = Readonly<{
     }>;
     participationRoles: readonly OrganizationParticipationRole[];
 }>;
+/**
+ * Converts the six explicit application roles into GW's canonical capability
+ * claim. Business roles remain distinct in the application and credential;
+ * this projection only grants their corresponding provider or reader runtime
+ * operations and removes duplicates.
+ */
+export declare function organizationServiceTypeForParticipationRoles(roles: readonly OrganizationParticipationRole[]): string;
 /**
  * Validates only reusable organization-application business data.
  *

package/dist/organization-application.js

@@ -1,4 +1,5 @@
 import { isIso3166CountryCode, isIso3166SubdivisionForCountry } from './iso-jurisdictions.js';
+import { serializeServiceCapabilityTokens, ServiceCapability, } from 'gdc-common-utils-ts/constants/service-capabilities';
 export const OrganizationOfficialIdTypes = Object.freeze({
     Tax: 'TAX',
     EmployerIdentificationNumber: 'EIN',
@@ -14,6 +15,32 @@ export const OrganizationParticipationRoles = Object.freeze({
 });
 const officialIdTypes = new Set(Object.values(OrganizationOfficialIdTypes));
 const participationRoles = new Set(Object.values(OrganizationParticipationRoles));
+/**
+ * Converts the six explicit application roles into GW's canonical capability
+ * claim. Business roles remain distinct in the application and credential;
+ * this projection only grants their corresponding provider or reader runtime
+ * operations and removes duplicates.
+ */
+export function organizationServiceTypeForParticipationRoles(roles) {
+    const capabilities = roles.map(role => {
+        switch (role) {
+            case OrganizationParticipationRoles.IndividualIndexServiceProvider:
+            case OrganizationParticipationRoles.IndividualIndexDataProvider:
+                return ServiceCapability.IndexProvider;
+            case OrganizationParticipationRoles.IndividualIndexDataConsumer:
+                return ServiceCapability.IndexReader;
+            case OrganizationParticipationRoles.DigitalTwinIndexServiceProvider:
+            case OrganizationParticipationRoles.DigitalTwinDataProvider:
+                return ServiceCapability.DigitalTwinProvider;
+            case OrganizationParticipationRoles.DigitalTwinDataConsumer:
+                return ServiceCapability.DigitalTwinReader;
+        }
+    });
+    const serviceType = serializeServiceCapabilityTokens(capabilities);
+    if (!serviceType)
+        throw new TypeError('organization_participation_role_required');
+    return serviceType;
+}
 /**
  * Validates only reusable organization-application business data.
  *

package/dist/sectors.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Active product extension of the frozen CORE sector vocabulary.
+ *
+ * CORE remains unchanged. Public safety is product-neutral and may be selected
+ * only by a consuming portal that explicitly includes it in its own allowlist;
+ * the value grants no organization role, membership or data capability.
+ */
+export declare const ExtendedDataspaceSectors: Readonly<{
+    readonly PublicSafety: "public-safety";
+    readonly HealthCare: "health-care";
+    readonly HealthResearch: "health-research";
+    readonly HealthTech: "health-tech";
+    readonly HealthInsurance: "health-insurance";
+    readonly AnimalCare: "animal-care";
+    readonly AnimalResearch: "animal-research";
+    readonly AnimalInsurance: "animal-insurance";
+    readonly AnimalTech: "animal-tech";
+    readonly OneHealthResearch: "onehealth-research";
+    readonly OneHealthTech: "onehealth-tech";
+}>;
+export type ExtendedDataspaceSector = typeof ExtendedDataspaceSectors[keyof typeof ExtendedDataspaceSectors];

package/dist/sectors.js

@@ -0,0 +1,12 @@
+import { DataspaceSectors } from 'gdc-common-utils-ts/constants/sectors';
+/**
+ * Active product extension of the frozen CORE sector vocabulary.
+ *
+ * CORE remains unchanged. Public safety is product-neutral and may be selected
+ * only by a consuming portal that explicitly includes it in its own allowlist;
+ * the value grants no organization role, membership or data capability.
+ */
+export const ExtendedDataspaceSectors = Object.freeze({
+    ...DataspaceSectors,
+    PublicSafety: 'public-safety',
+});

package/dist/veterinary-sections.d.ts

@@ -4,6 +4,18 @@ export type VeterinarySummarySection = Readonly<{
     value: `LOINC|${string}`;
     titleEn: string;
 }>;
+/**
+ * Product-owned display concepts used by high-level veterinary workflows.
+ *
+ * They deliberately carry no invented terminology-system code. A deployment
+ * may add a governed coding later, while claims-first research projection can
+ * safely index the non-identifying `Coding.display` value today.
+ */
+export declare const VeterinaryClinicalConcepts: Readonly<{
+    ClinicalNote: Readonly<{
+        display: "Veterinary clinical note";
+    }>;
+}>;
 /** VetChain-owned clinical section catalog. It is not an alias of human IPS. */
 export declare const VeterinarySummarySections: Readonly<{
     Problems: Readonly<{

package/dist/veterinary-sections.js

@@ -1,3 +1,13 @@
+/**
+ * Product-owned display concepts used by high-level veterinary workflows.
+ *
+ * They deliberately carry no invented terminology-system code. A deployment
+ * may add a governed coding later, while claims-first research projection can
+ * safely index the non-identifying `Coding.display` value today.
+ */
+export const VeterinaryClinicalConcepts = Object.freeze({
+    ClinicalNote: Object.freeze({ display: 'Veterinary clinical note' }),
+});
 function loinc(code, titleEn) {
     return Object.freeze({ system: 'http://loinc.org', code, value: `LOINC|${code}`, titleEn });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vet-data-utils-ts",
-  "version": "0.4.2",
+  "version": "0.4.5",
   "description": "Browser-safe governed VetChain data contracts",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",
@@ -36,6 +36,10 @@
       "types": "./dist/organization-application.d.ts",
       "default": "./dist/organization-application.js"
     },
+    "./sectors": {
+      "types": "./dist/sectors.d.ts",
+      "default": "./dist/sectors.js"
+    },
     "./veterinary-sections": {
       "types": "./dist/veterinary-sections.d.ts",
       "default": "./dist/veterinary-sections.js"
@@ -63,6 +67,9 @@
     "@types/node": "^22.0.0",
     "typescript": "^5.5.4"
   },
+  "dependencies": {
+    "gdc-common-utils-ts": "2.5.21"
+  },
   "engines": {
     "node": ">=20"
   }