vet-data-utils-ts 0.5.29 → 0.5.30

package/README.md

@@ -1,5 +1,18 @@
 # vet-data-utils-ts
 
+## Lost-animal access and behavior
+
+`normalizeIso3166Jurisdiction(...)` and
+`buildLostAnimalEmergencyJurisdictionActors(...)` create exact country or
+subdivision Consent actors such as `urn:iso:3166-2:CA-BC`. The
+`LostAnimalEmergencyAccess` profile limits standing access to licensed
+veterinarians, emergency treatment and a minimal veterinary summary. GW still
+verifies the credential, active licence, route jurisdiction and exact animal.
+
+`buildAnimalBehaviorObservation(...)` records controller-reported temperament
+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

package/dist/animal-behavior.d.ts

@@ -0,0 +1,18 @@
+export type AnimalBehaviorObservationInput = Readonly<{
+    id: string;
+    subject: string;
+    observedAt: string;
+    language: string;
+    summary: string;
+    note?: string;
+    localLabel?: string;
+}>;
+export type AnimalBehaviorObservation = Readonly<{
+    resourceType: 'Observation';
+    id: string;
+    meta: Readonly<{
+        claims: Readonly<Record<string, string>>;
+    }>;
+}>;
+/** Builds one claims-first, controller-reported behavior Observation without inventing a diagnosis code. */
+export declare function buildAnimalBehaviorObservation(input: AnimalBehaviorObservationInput): AnimalBehaviorObservation;

package/dist/animal-behavior.js

@@ -0,0 +1,44 @@
+import { ObservationCategoryCodes } from 'gdc-common-utils-ts/constants/observation-category';
+import { ObservationClaim } from 'gdc-common-utils-ts/models/interoperable-claims/observation-claims';
+import { isVetChainAnimalCardDid } from './animal-card.js';
+const ENGLISH_DISPLAY = 'Animal temperament and fear response';
+function boundedText(value, name, max) {
+    const normalized = String(value || '').trim();
+    if (!normalized || normalized.length > max)
+        throw new TypeError(`animal_behavior_${name}_invalid`);
+    return normalized;
+}
+/** Builds one claims-first, controller-reported behavior Observation without inventing a diagnosis code. */
+export function buildAnimalBehaviorObservation(input) {
+    const id = String(input.id || '').trim();
+    if (!/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/.test(id))
+        throw new TypeError('animal_behavior_id_invalid');
+    const subject = String(input.subject || '').trim();
+    if (!isVetChainAnimalCardDid(subject))
+        throw new TypeError('animal_behavior_animal_card_did_required');
+    const observedAt = String(input.observedAt || '').trim();
+    if (!observedAt || Number.isNaN(Date.parse(observedAt)))
+        throw new TypeError('animal_behavior_observedAt_invalid');
+    const language = String(input.language || '').trim();
+    if (!/^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$/.test(language))
+        throw new TypeError('animal_behavior_language_invalid');
+    const summary = boundedText(input.summary, 'summary', 1000);
+    const note = input.note === undefined ? undefined : boundedText(input.note, 'note', 1000);
+    const localLabel = input.localLabel === undefined ? ENGLISH_DISPLAY : boundedText(input.localLabel, 'local_label', 120);
+    const claims = {
+        '@context': 'org.hl7.fhir.api',
+        [ObservationClaim.Identifier]: id,
+        [ObservationClaim.Subject]: subject,
+        [ObservationClaim.Status]: 'final',
+        [ObservationClaim.Category]: ObservationCategoryCodes.SocialHistory.claim,
+        [ObservationClaim.CodeText]: localLabel,
+        [ObservationClaim.CodeDisplay]: ENGLISH_DISPLAY,
+        [ObservationClaim.ValueString]: summary,
+        [ObservationClaim.Date]: observedAt,
+        [ObservationClaim.EffectiveDateTime]: observedAt,
+        [ObservationClaim.Language]: language,
+    };
+    if (note)
+        claims[ObservationClaim.Note] = note;
+    return Object.freeze({ resourceType: 'Observation', id, meta: Object.freeze({ claims: Object.freeze(claims) }) });
+}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './animal-card.js';
+export * from './animal-behavior.js';
 export * from './assistant.js';
 export * from './communication.js';
 export * from './clinical-terminology.js';
@@ -13,6 +14,7 @@ export * from './international-health-card.js';
 export * from './index-projection-tags.js';
 export * from './insurance-consent.js';
 export * from './iso-jurisdictions.js';
+export * from './lost-animal-access.js';
 export * from './organization-application.js';
 export * from './payment.js';
 export * from './place-service-directory.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from './animal-card.js';
+export * from './animal-behavior.js';
 export * from './assistant.js';
 export * from './communication.js';
 export * from './clinical-terminology.js';
@@ -13,6 +14,7 @@ export * from './international-health-card.js';
 export * from './index-projection-tags.js';
 export * from './insurance-consent.js';
 export * from './iso-jurisdictions.js';
+export * from './lost-animal-access.js';
 export * from './organization-application.js';
 export * from './payment.js';
 export * from './place-service-directory.js';

package/dist/lost-animal-access.d.ts

@@ -0,0 +1,23 @@
+export type Iso3166Jurisdiction = Readonly<{
+    code: string;
+    countryCode: string;
+    kind: 'country' | 'subdivision';
+    actorIdentifier: string;
+}>;
+/** Normalizes an ISO 3166 country or subdivision into its canonical Consent actor. */
+export declare function normalizeIso3166Jurisdiction(input: unknown): Iso3166Jurisdiction;
+/** Builds a deterministic, duplicate-free actor list for controller-authored regional Consent rules. */
+export declare function buildLostAnimalEmergencyJurisdictionActors(input: readonly unknown[]): readonly string[];
+/**
+ * Least-privilege standing access profile for a lost animal.
+ *
+ * A matching rule is not proof that the requester is a veterinarian: GW must
+ * independently verify the professional credential, active licence, route
+ * jurisdiction and exact animal subject before issuing a short-lived token.
+ */
+export declare const LostAnimalEmergencyAccess: Readonly<{
+    actorRole: "ISCO-08|2250";
+    purpose: "ETREAT";
+    resourceTypes: readonly ["Composition"];
+    sections: readonly `LOINC|${string}`[];
+}>;

package/dist/lost-animal-access.js

@@ -0,0 +1,45 @@
+import { HealthcareActorRoles, HealthcareConsentPurposes } from 'gdc-common-utils-ts/constants/healthcare';
+import { isIso3166CountryCode, isIso3166SubdivisionForCountry } from './iso-jurisdictions.js';
+import { VeterinarySummarySections } from './veterinary-sections.js';
+const countryActor = /^urn:iso:3166:([a-z]{2})$/i;
+const subdivisionActor = /^urn:iso:3166-2:([a-z]{2}-[a-z0-9]{1,3})$/i;
+/** Normalizes an ISO 3166 country or subdivision into its canonical Consent actor. */
+export function normalizeIso3166Jurisdiction(input) {
+    const raw = String(input || '').trim();
+    const unwrapped = countryActor.exec(raw)?.[1] || subdivisionActor.exec(raw)?.[1] || raw;
+    const code = unwrapped.toUpperCase();
+    const countryCode = code.slice(0, 2);
+    if (code.length === 2 && isIso3166CountryCode(code)) {
+        return Object.freeze({ code, countryCode, kind: 'country', actorIdentifier: `urn:iso:3166:${code}` });
+    }
+    if (isIso3166CountryCode(countryCode) && isIso3166SubdivisionForCountry(code, countryCode)) {
+        return Object.freeze({ code, countryCode, kind: 'subdivision', actorIdentifier: `urn:iso:3166-2:${code}` });
+    }
+    throw new TypeError('lost_animal_access_iso_3166_jurisdiction_invalid');
+}
+/** Builds a deterministic, duplicate-free actor list for controller-authored regional Consent rules. */
+export function buildLostAnimalEmergencyJurisdictionActors(input) {
+    if (!Array.isArray(input) || input.length === 0)
+        throw new TypeError('lost_animal_access_jurisdiction_required');
+    return Object.freeze([...new Set(input.map(value => normalizeIso3166Jurisdiction(value).actorIdentifier))]);
+}
+/**
+ * Least-privilege standing access profile for a lost animal.
+ *
+ * A matching rule is not proof that the requester is a veterinarian: GW must
+ * independently verify the professional credential, active licence, route
+ * jurisdiction and exact animal subject before issuing a short-lived token.
+ */
+export const LostAnimalEmergencyAccess = Object.freeze({
+    actorRole: HealthcareActorRoles.Veterinarian,
+    purpose: HealthcareConsentPurposes.EmergencyTreatment,
+    resourceTypes: Object.freeze(['Composition']),
+    sections: Object.freeze([
+        VeterinarySummarySections.Alerts.value,
+        VeterinarySummarySections.Allergies.value,
+        VeterinarySummarySections.Medications.value,
+        VeterinarySummarySections.Immunizations.value,
+        VeterinarySummarySections.Problems.value,
+        VeterinarySummarySections.EnvironmentAndLifestyle.value,
+    ]),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vet-data-utils-ts",
-  "version": "0.5.29",
+  "version": "0.5.30",
   "description": "Browser-safe governed VetChain data contracts",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",
@@ -16,6 +16,10 @@
       "types": "./dist/animal-card.d.ts",
       "default": "./dist/animal-card.js"
     },
+    "./animal-behavior": {
+      "types": "./dist/animal-behavior.d.ts",
+      "default": "./dist/animal-behavior.js"
+    },
     "./communication": {
       "types": "./dist/communication.d.ts",
       "default": "./dist/communication.js"
@@ -68,6 +72,10 @@
       "types": "./dist/iso-jurisdictions.d.ts",
       "default": "./dist/iso-jurisdictions.js"
     },
+    "./lost-animal-access": {
+      "types": "./dist/lost-animal-access.d.ts",
+      "default": "./dist/lost-animal-access.js"
+    },
     "./organization-application": {
       "types": "./dist/organization-application.d.ts",
       "default": "./dist/organization-application.js"