vet-data-utils-ts 0.5.37 → 0.6.0

package/README.md

@@ -23,15 +23,19 @@ and fear context as a claims-first social-history Observation. It deliberately
 uses narrative text rather than inventing a veterinary diagnosis code.
 
 The product-local `place-service-directory` export models persistent public
-sites as claims-only Schema.org `Place` resources and their offerings as
-claims-only `Service` or `Product` resources. A care organization publishes
-services; an insurance organization publishes products in a Schema.org
-`OfferCatalog`. Photos, accessibility, coordinates, address and opening-hours
-specifications remain neutral indexed claims. Native FHIR R5 `Location`,
-`HealthcareService` and `InsurancePlan` are produced only by explicit
-projection helpers. Member-specific FHIR `Coverage` is never a public catalog
-entry. The shared `gdc-*` claim catalog remains unchanged while this profile is
-validated in VetChain.
+departments as claims-only Schema.org `Organization` resources, their sites as
+`Place`, and their offerings as `Service` or `Product`. A department has one
+parent legal organization, one or more Places and several offered Services.
+`projectDepartmentToFhirR5HealthcareService(...)` aggregates those Services
+into exactly one stable FHIR `HealthcareService` per department; an offered
+Service is not a second department or communication sender. A care organization
+publishes services; an insurance organization publishes products in a
+Schema.org `OfferCatalog`. Logos, images, accessibility, coordinates, address
+and opening-hours specifications remain neutral indexed claims. Native FHIR R5
+`Organization`, `Location`, `HealthcareService` and `InsurancePlan` are
+produced only by explicit projection helpers. Member-specific FHIR `Coverage`
+is never a public catalog entry. The shared `gdc-*` claim catalog remains
+unchanged while this profile is validated in VetChain.
 
 The customer-facing Schema.org `OfferCatalog` is distinct from the Eclipse
 Dataspace Protocol catalog. `buildDataspaceCatalogAdvertisement(...)` exposes a

package/dist/place-service-directory.d.ts

@@ -21,6 +21,19 @@ export declare enum ClaimsPlaceSchemaorg {
     specialOpeningHoursSpecification = "org.schema.Place.specialOpeningHoursSpecification",
     userSelected = "Place.user-selected"
 }
+/** Schema.org flat claims for a public department/subOrganization. */
+export declare enum ClaimsDirectoryOrganizationSchemaorg {
+    identifier = "org.schema.Organization.identifier",
+    name = "org.schema.Organization.name",
+    description = "org.schema.Organization.description",
+    parentOrganizationIdentifier = "org.schema.Organization.parentOrganization.identifier",
+    additionalType = "org.schema.Organization.additionalType",
+    sameAs = "org.schema.Organization.sameAs",
+    locationIdentifier = "org.schema.Organization.location.identifier",
+    logoContentUrl = "org.schema.Organization.logo.contentUrl",
+    imageContentUrl = "org.schema.Organization.image.contentUrl",
+    userSelected = "Organization.user-selected"
+}
 /** Schema.org Service claims needed to join a public service to one or more Places. */
 export declare enum ClaimsDirectoryServiceSchemaorg {
     identifier = "org.schema.Service.identifier",
@@ -55,6 +68,7 @@ export declare enum ClaimsProductSchemaorg {
 }
 /** Product-local allowlist for the experimental Place, Service and Product directory profile. */
 export declare const DirectoryFlatClaimCatalog: Readonly<{
+    readonly Organization: readonly ClaimsDirectoryOrganizationSchemaorg[];
     readonly Place: readonly ClaimsPlaceSchemaorg[];
     readonly Service: readonly ClaimsDirectoryServiceSchemaorg[];
     readonly Product: readonly ClaimsProductSchemaorg[];
@@ -89,6 +103,21 @@ export type SpecialOpeningHoursInput = Readonly<{
     opens?: string;
     closes?: string;
 }>;
+export type DepartmentDirectoryInput = Readonly<{
+    id: string;
+    legalOrganizationIdentifier: string;
+    name: string;
+    description?: string;
+    specialty?: Readonly<{
+        system: 'http://loinc.org';
+        code: string;
+        display: string;
+    }>;
+    placeIdentifiers: readonly string[];
+    logoUrl?: string;
+    imageUrls?: readonly string[];
+    userSelected?: boolean;
+}>;
 export type PlaceDirectoryInput = Readonly<{
     id: string;
     organizationIdentifier: string;
@@ -165,6 +194,14 @@ export declare const DataspaceProtocol2025: Readonly<{
     readonly context: "https://w3id.org/dspace/2025/1/context.jsonld";
     readonly httpEndpointType: "https://w3id.org/idsa/v4.1/HTTP";
 }>;
+/**
+ * Builds the claims-only public department Organization.
+ *
+ * One department is one Schema.org/FHIR Organization and owns one stable
+ * HealthcareService projection whose id is the same department id. Offered
+ * Services remain separate directory records linked through providerIdentifier.
+ */
+export declare function buildDepartmentDirectoryResource(input: DepartmentDirectoryInput): DirectoryResource;
 /** Builds the claims-only public Place authored by an organization. */
 export declare function buildPlaceDirectoryResource(input: PlaceDirectoryInput): DirectoryResource;
 /** Builds a claims-only Schema.org Service joined to its provider and public Places. */
@@ -173,6 +210,78 @@ export declare function buildServiceDirectoryResource(input: ServiceDirectoryInp
 export declare function buildProductDirectoryResource(input: ProductDirectoryInput): DirectoryResource;
 /** Rejects native fields and converts a directory resource into deterministic array-valued claims. */
 export declare function normalizeDirectoryFlatClaimsResource(input: unknown): DirectoryFlatClaimsResource;
+/** Explicitly projects one public department to a native FHIR R5 Organization. */
+export declare function projectDepartmentToFhirR5Organization(department: DirectoryResource | DirectoryFlatClaimsResource): Readonly<{
+    meta: {
+        claims: {
+            'Organization.identifier': string;
+            'Organization.active': string;
+            'Organization.name': string | undefined;
+            'Organization.part-of': string;
+        };
+    };
+    type?: {
+        coding: {
+            system: string;
+            code: string;
+        }[];
+    }[] | undefined;
+    partOf: {
+        reference: string;
+    };
+    description?: string | undefined;
+    resourceType: "Organization";
+    id: string;
+    active: true;
+    identifier: {
+        value: string;
+    }[];
+    name: string;
+}>;
+/**
+ * Projects all offered Services of one department into its single stable
+ * HealthcareService. The Services supply types; the department supplies the
+ * provider identity and allowed Locations.
+ */
+export declare function projectDepartmentToFhirR5HealthcareService(department: DirectoryResource | DirectoryFlatClaimsResource, input: Readonly<{
+    services: readonly (DirectoryResource | DirectoryFlatClaimsResource)[];
+    places: readonly (DirectoryResource | DirectoryFlatClaimsResource)[];
+}>): Readonly<{
+    meta: {
+        claims: {
+            'HealthcareService.service-category'?: string[] | undefined;
+            'HealthcareService.identifier': string;
+            'HealthcareService.organization': string;
+            'HealthcareService.name': string | undefined;
+            'HealthcareService.location': string[];
+            'HealthcareService.service-type': string[];
+        };
+    };
+    photo?: {
+        url: string;
+    } | undefined;
+    resourceType: "HealthcareService";
+    id: string;
+    active: true;
+    providedBy: {
+        reference: string;
+    };
+    name: string | undefined;
+    comment: string | undefined;
+    category: {
+        coding: {
+            code: string;
+        }[];
+    }[];
+    type: {
+        coding: {
+            code: string;
+        }[];
+    }[];
+    location: {
+        reference: string;
+    }[];
+}>;
 /** Explicitly projects one neutral Place to native FHIR R5 Location for export or interop. */
 export declare function projectPlaceToFhirR5Location(place: DirectoryResource | DirectoryFlatClaimsResource): Readonly<{
     resourceType: "Location";
@@ -340,7 +449,7 @@ export declare function buildOrganizationOfferCatalog(input: Readonly<{
     itemListElement: readonly Readonly<{
         '@type': "Offer";
         itemOffered: Readonly<{
-            '@type': "Place" | "Service" | "Product";
+            '@type': "Organization" | "Place" | "Service" | "Product";
             identifier: string;
             name: string;
         }>;

package/dist/place-service-directory.js

@@ -23,6 +23,20 @@ export var ClaimsPlaceSchemaorg;
     ClaimsPlaceSchemaorg["specialOpeningHoursSpecification"] = "org.schema.Place.specialOpeningHoursSpecification";
     ClaimsPlaceSchemaorg["userSelected"] = "Place.user-selected";
 })(ClaimsPlaceSchemaorg || (ClaimsPlaceSchemaorg = {}));
+/** Schema.org flat claims for a public department/subOrganization. */
+export var ClaimsDirectoryOrganizationSchemaorg;
+(function (ClaimsDirectoryOrganizationSchemaorg) {
+    ClaimsDirectoryOrganizationSchemaorg["identifier"] = "org.schema.Organization.identifier";
+    ClaimsDirectoryOrganizationSchemaorg["name"] = "org.schema.Organization.name";
+    ClaimsDirectoryOrganizationSchemaorg["description"] = "org.schema.Organization.description";
+    ClaimsDirectoryOrganizationSchemaorg["parentOrganizationIdentifier"] = "org.schema.Organization.parentOrganization.identifier";
+    ClaimsDirectoryOrganizationSchemaorg["additionalType"] = "org.schema.Organization.additionalType";
+    ClaimsDirectoryOrganizationSchemaorg["sameAs"] = "org.schema.Organization.sameAs";
+    ClaimsDirectoryOrganizationSchemaorg["locationIdentifier"] = "org.schema.Organization.location.identifier";
+    ClaimsDirectoryOrganizationSchemaorg["logoContentUrl"] = "org.schema.Organization.logo.contentUrl";
+    ClaimsDirectoryOrganizationSchemaorg["imageContentUrl"] = "org.schema.Organization.image.contentUrl";
+    ClaimsDirectoryOrganizationSchemaorg["userSelected"] = "Organization.user-selected";
+})(ClaimsDirectoryOrganizationSchemaorg || (ClaimsDirectoryOrganizationSchemaorg = {}));
 /** Schema.org Service claims needed to join a public service to one or more Places. */
 export var ClaimsDirectoryServiceSchemaorg;
 (function (ClaimsDirectoryServiceSchemaorg) {
@@ -59,6 +73,7 @@ export var ClaimsProductSchemaorg;
 })(ClaimsProductSchemaorg || (ClaimsProductSchemaorg = {}));
 /** Product-local allowlist for the experimental Place, Service and Product directory profile. */
 export const DirectoryFlatClaimCatalog = Object.freeze({
+    Organization: Object.freeze(Object.values(ClaimsDirectoryOrganizationSchemaorg)),
     Place: Object.freeze(Object.values(ClaimsPlaceSchemaorg)),
     Service: Object.freeze(Object.values(ClaimsDirectoryServiceSchemaorg)),
     Product: Object.freeze(Object.values(ClaimsProductSchemaorg)),
@@ -151,6 +166,51 @@ function encodeSpecialOpeningHours(value) {
         throw new TypeError('place_special_opening_hours_invalid');
     return JSON.stringify({ validFrom, validThrough, opens: value.opens, closes: value.closes });
 }
+/**
+ * Builds the claims-only public department Organization.
+ *
+ * One department is one Schema.org/FHIR Organization and owns one stable
+ * HealthcareService projection whose id is the same department id. Offered
+ * Services remain separate directory records linked through providerIdentifier.
+ */
+export function buildDepartmentDirectoryResource(input) {
+    const id = required(input.id, 'department_id_required');
+    if (!RESOURCE_ID_PATTERN.test(id))
+        throw new TypeError('department_id_invalid');
+    const placeIdentifiers = unique(input.placeIdentifiers, 'department_place_invalid');
+    if (!placeIdentifiers.length)
+        throw new TypeError('department_place_required');
+    const logoUrl = optionalHttpsUrl(input.logoUrl, 'department_logo_url_invalid');
+    const imageUrls = unique(input.imageUrls, 'department_image_url_invalid').map(value => {
+        const imageUrl = optionalHttpsUrl(value, 'department_image_url_invalid');
+        if (!imageUrl)
+            throw new TypeError('department_image_url_invalid');
+        return imageUrl;
+    });
+    const claims = {
+        [ClaimsDirectoryOrganizationSchemaorg.identifier]: id,
+        [ClaimsDirectoryOrganizationSchemaorg.name]: required(input.name, 'department_name_required'),
+        [ClaimsDirectoryOrganizationSchemaorg.parentOrganizationIdentifier]: required(input.legalOrganizationIdentifier, 'department_parent_organization_required'),
+        [ClaimsDirectoryOrganizationSchemaorg.sameAs]: `Organization/${id}`,
+        [ClaimsDirectoryOrganizationSchemaorg.locationIdentifier]: placeIdentifiers,
+        [ClaimsDirectoryOrganizationSchemaorg.userSelected]: input.userSelected ?? false,
+    };
+    const description = optional(input.description);
+    if (description)
+        claims[ClaimsDirectoryOrganizationSchemaorg.description] = description;
+    if (input.specialty) {
+        if (input.specialty.system !== 'http://loinc.org'
+            || !/^L(?:A|P)\d+(?:-\d+)?$/.test(input.specialty.code)
+            || !optional(input.specialty.display))
+            throw new TypeError('department_specialty_invalid');
+        claims[ClaimsDirectoryOrganizationSchemaorg.additionalType] = `${input.specialty.system}/${input.specialty.code}`;
+    }
+    if (logoUrl)
+        claims[ClaimsDirectoryOrganizationSchemaorg.logoContentUrl] = logoUrl;
+    if (imageUrls.length)
+        claims[ClaimsDirectoryOrganizationSchemaorg.imageContentUrl] = Object.freeze(imageUrls);
+    return Object.freeze({ resourceType: 'Organization', id, meta: Object.freeze({ claims: Object.freeze(claims) }) });
+}
 /** Builds the claims-only public Place authored by an organization. */
 export function buildPlaceDirectoryResource(input) {
     const id = required(input.id, 'place_id_required');
@@ -302,7 +362,7 @@ export function normalizeDirectoryFlatClaimsResource(input) {
     if (!input || typeof input !== 'object' || Array.isArray(input))
         throw new TypeError('directory_flat_resource_invalid');
     const value = input;
-    if ((value.resourceType !== 'Place' && value.resourceType !== 'Service' && value.resourceType !== 'Product') || Object.keys(value).some(key => !['resourceType', 'id', 'meta'].includes(key)))
+    if ((value.resourceType !== 'Organization' && value.resourceType !== 'Place' && value.resourceType !== 'Service' && value.resourceType !== 'Product') || Object.keys(value).some(key => !['resourceType', 'id', 'meta'].includes(key)))
         throw new TypeError('directory_flat_resource_invalid');
     const resourceType = value.resourceType;
     const id = required(value.id, 'directory_flat_resource_invalid');
@@ -338,6 +398,78 @@ function parseJson(value, code) {
         throw new TypeError(code);
     }
 }
+/** Explicitly projects one public department to a native FHIR R5 Organization. */
+export function projectDepartmentToFhirR5Organization(department) {
+    if (department.resourceType !== 'Organization')
+        throw new TypeError('department_resource_required');
+    const parent = required(first(department, ClaimsDirectoryOrganizationSchemaorg.parentOrganizationIdentifier), 'department_parent_organization_required');
+    const additionalType = first(department, ClaimsDirectoryOrganizationSchemaorg.additionalType);
+    return Object.freeze({
+        resourceType: 'Organization', id: department.id, active: true,
+        identifier: [{ value: department.id }],
+        name: required(first(department, ClaimsDirectoryOrganizationSchemaorg.name), 'department_name_required'),
+        ...(first(department, ClaimsDirectoryOrganizationSchemaorg.description)
+            ? { description: first(department, ClaimsDirectoryOrganizationSchemaorg.description) } : {}),
+        partOf: { reference: parent },
+        ...(additionalType ? { type: [{ coding: [{ system: 'http://loinc.org', code: additionalType.replace('http://loinc.org/', '') }] }] } : {}),
+        meta: { claims: {
+                'Organization.identifier': department.id,
+                'Organization.active': 'true',
+                'Organization.name': first(department, ClaimsDirectoryOrganizationSchemaorg.name),
+                'Organization.part-of': parent,
+            } },
+    });
+}
+/**
+ * Projects all offered Services of one department into its single stable
+ * HealthcareService. The Services supply types; the department supplies the
+ * provider identity and allowed Locations.
+ */
+export function projectDepartmentToFhirR5HealthcareService(department, input) {
+    if (department.resourceType !== 'Organization')
+        throw new TypeError('department_resource_required');
+    const departmentLocations = values(department, ClaimsDirectoryOrganizationSchemaorg.locationIdentifier);
+    const places = departmentLocations.map(identifier => {
+        const place = input.places.find(candidate => candidate.resourceType === 'Place' && candidate.id === identifier);
+        if (!place)
+            throw new TypeError('department_place_not_found');
+        return place;
+    });
+    const services = input.services.filter(service => {
+        if (service.resourceType !== 'Service')
+            throw new TypeError('service_resource_required');
+        return first(service, ClaimsDirectoryServiceSchemaorg.providerIdentifier) === department.id;
+    });
+    if (!services.length)
+        throw new TypeError('department_service_required');
+    for (const service of services) {
+        if (values(service, ClaimsDirectoryServiceSchemaorg.placeIdentifier).some(identifier => !departmentLocations.includes(identifier))) {
+            throw new TypeError('department_service_place_invalid');
+        }
+    }
+    const serviceTypes = [...new Set(services.flatMap(service => values(service, ClaimsDirectoryServiceSchemaorg.serviceType)))];
+    const categories = [...new Set(services.flatMap(service => values(service, ClaimsDirectoryServiceSchemaorg.category)))];
+    const concept = (code) => ({ coding: [{ code }] });
+    const photoUrl = first(department, ClaimsDirectoryOrganizationSchemaorg.logoContentUrl)
+        || places.map(place => first(place, ClaimsPlaceSchemaorg.photoContentUrl)).find(Boolean);
+    return Object.freeze({
+        resourceType: 'HealthcareService', id: department.id, active: true,
+        providedBy: { reference: `Organization/${department.id}` },
+        name: first(department, ClaimsDirectoryOrganizationSchemaorg.name),
+        comment: first(department, ClaimsDirectoryOrganizationSchemaorg.description),
+        category: categories.map(concept), type: serviceTypes.map(concept),
+        location: places.map(place => ({ reference: `Location/${place.id}` })),
+        ...(photoUrl ? { photo: { url: photoUrl } } : {}),
+        meta: { claims: {
+                'HealthcareService.identifier': department.id,
+                'HealthcareService.organization': `Organization/${department.id}`,
+                'HealthcareService.name': first(department, ClaimsDirectoryOrganizationSchemaorg.name),
+                'HealthcareService.location': places.map(place => `Location/${place.id}`),
+                'HealthcareService.service-type': serviceTypes,
+                ...(categories.length ? { 'HealthcareService.service-category': categories } : {}),
+            } },
+    });
+}
 /** Explicitly projects one neutral Place to native FHIR R5 Location for export or interop. */
 export function projectPlaceToFhirR5Location(place) {
     if (place.resourceType !== 'Place')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vet-data-utils-ts",
-  "version": "0.5.37",
+  "version": "0.6.0",
   "description": "Browser-safe governed VetChain data contracts",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",