vet-data-utils-ts 0.4.10 → 0.4.12

package/README.md

@@ -13,14 +13,21 @@ Reusable Communication screens receive immutable workflow presets from
 FHIR `notification` plus HL7 v3 ActReason `HRESCH` and does not expose a topic
 picker. See [`docs/communication-inbox-filters.md`](docs/communication-inbox-filters.md).
 
-Veterinary clinical entry screens obtain their allowed coding systems from
-`vet-data-utils-ts/clinical-terminology`. Observations and diagnostic reports
-use LOINC; conditions additionally support ICD-10; SNOMED CT is offered for
-conditions, procedures and allergies only when the selected ISO country is an
-official SNOMED member territory. A returned candidate is never accepted
+Veterinary clinical entry screens obtain browser-safe source identifiers and
+response types from `vet-data-utils-ts/clinical-terminology`; the terminology
+server remains authoritative for each FHIR field. Observations and diagnostic
+reports use LOINC and conditions additionally support ICD-10. SNOMED GPS is
+globally available, while full SNOMED CT and the veterinary extension are
+offered only when the selected ISO country is an official member territory.
+These sources share one FHIR system URI, so portals must preserve the source
+scope returned by the server rather than authorizing from the URI. A returned candidate is never accepted
 automatically: the professional must review and select it before creating the
 FHIR resource. Membership does not replace national edition, attribution or
 affiliate-license requirements. See the [official member list](https://www.snomed.org/members).
+Veterinary immunizations use the distinct WHO ATCvet classification (group QI
+for immunologicals); ordinary human ATC is not substituted for it. Veterinary
+allergy product coding may also use ATCvet, while manifestations use an allowed
+SNOMED source.
 
 The deferred spreadsheet shape for member and employee role assignments is
 documented in [`docs/member-import-contract.md`](docs/member-import-contract.md).

package/dist/clinical-terminology.d.ts

@@ -2,6 +2,46 @@ export declare const VeterinaryClinicalTerminologySystems: Readonly<{
     readonly Loinc: "http://loinc.org";
     readonly SnomedCt: "http://snomed.info/sct";
     readonly Icd10: "http://hl7.org/fhir/sid/icd-10";
+    /** WHO Collaborating Centre ATCvet classification, distinct from human ATC. */
+    readonly AtcVet: "http://www.whocc.no/atcvet";
+}>;
+/**
+ * Source scopes are authorization/content boundaries, not Coding.system URIs.
+ * GPS, full SNOMED CT and the veterinary extension intentionally share the
+ * canonical SNOMED system URI.
+ * https://www.snomed.org/gps
+ */
+export declare const VeterinaryTerminologySourceScopes: Readonly<{
+    readonly Loinc: "LNC";
+    readonly SnomedGps: "SNOMED_GPS";
+    readonly SnomedCt: "SNOMED_CT";
+    readonly SnomedVeterinary: "SNOMEDCT_VET";
+    readonly Icd10: "ICD10";
+    readonly AtcVet: "ATCVET";
+}>;
+export type VeterinaryTerminologySourceScope = typeof VeterinaryTerminologySourceScopes[keyof typeof VeterinaryTerminologySourceScopes];
+export type VeterinaryTerminologyCapability = Readonly<{
+    type: 'terminology-capability';
+    id: string;
+    attributes: Readonly<{
+        fhirVersion: 'R4';
+        sector: string;
+        jurisdiction: string;
+        resourceType: VeterinaryCodedResourceType;
+        elementPath: string;
+        flatClaims?: Readonly<{
+            code: string;
+            text: string;
+            display: string;
+        }>;
+        defaultSource: VeterinaryTerminologySourceScope;
+        sources: readonly Readonly<{
+            id: VeterinaryTerminologySourceScope;
+            system: string;
+            availability: 'hosted' | 'catalog';
+            globallyUsable: boolean;
+        }>[];
+    }>;
 }>;
 /**
  * ISO 3166-1 alpha-2 territories enumerated by the official SNOMED
@@ -14,5 +54,7 @@ export declare const VeterinaryClinicalTerminologySystems: Readonly<{
  * release, edition, attribution or affiliate-license requirements.
  */
 export declare const SnomedMemberCountryCodes: readonly ["AR", "BZ", "CA", "CL", "CR", "SV", "JM", "US", "UY", "AD", "AT", "BE", "HR", "CY", "CZ", "DK", "EE", "FI", "FR", "DE", "HU", "IS", "IE", "IL", "JO", "LV", "LT", "LU", "MT", "NL", "NO", "PT", "QA", "SI", "SA", "SK", "ZA", "ES", "SE", "CH", "AE", "GB", "AU", "BN", "HK", "IN", "ID", "MY", "MN", "NZ", "KR", "SG", "TH", "UZ"];
-export type VeterinaryCodedResourceType = 'Condition' | 'Procedure' | 'DiagnosticReport' | 'Observation' | 'AllergyIntolerance';
+export type VeterinaryCodedResourceType = 'Condition' | 'Procedure' | 'DiagnosticReport' | 'Observation' | 'AllergyIntolerance' | 'Immunization';
+/** Resource-level summary; field-level authority comes from the terminology API capability response. */
+export declare function veterinaryTerminologySourcesFor(resourceType: VeterinaryCodedResourceType, countryCode: string): readonly VeterinaryTerminologySourceScope[];
 export declare function veterinaryTerminologySystemsFor(resourceType: VeterinaryCodedResourceType, countryCode: string): readonly string[];

package/dist/clinical-terminology.js

@@ -2,6 +2,22 @@ export const VeterinaryClinicalTerminologySystems = Object.freeze({
     Loinc: 'http://loinc.org',
     SnomedCt: 'http://snomed.info/sct',
     Icd10: 'http://hl7.org/fhir/sid/icd-10',
+    /** WHO Collaborating Centre ATCvet classification, distinct from human ATC. */
+    AtcVet: 'http://www.whocc.no/atcvet',
+});
+/**
+ * Source scopes are authorization/content boundaries, not Coding.system URIs.
+ * GPS, full SNOMED CT and the veterinary extension intentionally share the
+ * canonical SNOMED system URI.
+ * https://www.snomed.org/gps
+ */
+export const VeterinaryTerminologySourceScopes = Object.freeze({
+    Loinc: 'LNC',
+    SnomedGps: 'SNOMED_GPS',
+    SnomedCt: 'SNOMED_CT',
+    SnomedVeterinary: 'SNOMEDCT_VET',
+    Icd10: 'ICD10',
+    AtcVet: 'ATCVET',
 });
 /**
  * ISO 3166-1 alpha-2 territories enumerated by the official SNOMED
@@ -20,15 +36,35 @@ export const SnomedMemberCountryCodes = Object.freeze([
     'SI', 'SA', 'SK', 'ZA', 'ES', 'SE', 'CH', 'AE', 'GB',
     'AU', 'BN', 'HK', 'IN', 'ID', 'MY', 'MN', 'NZ', 'KR', 'SG', 'TH', 'UZ',
 ]);
-export function veterinaryTerminologySystemsFor(resourceType, countryCode) {
+/** Resource-level summary; field-level authority comes from the terminology API capability response. */
+export function veterinaryTerminologySourcesFor(resourceType, countryCode) {
     if (resourceType === 'Observation' || resourceType === 'DiagnosticReport') {
-        return [VeterinaryClinicalTerminologySystems.Loinc];
+        return [VeterinaryTerminologySourceScopes.Loinc];
     }
     const permitsSnomed = SnomedMemberCountryCodes.includes(countryCode.toUpperCase());
-    if (resourceType === 'Condition') {
-        return permitsSnomed
-            ? [VeterinaryClinicalTerminologySystems.SnomedCt, VeterinaryClinicalTerminologySystems.Icd10]
-            : [VeterinaryClinicalTerminologySystems.Icd10];
-    }
-    return permitsSnomed ? [VeterinaryClinicalTerminologySystems.SnomedCt] : [];
+    const clinical = permitsSnomed
+        ? [
+            VeterinaryTerminologySourceScopes.SnomedGps,
+            VeterinaryTerminologySourceScopes.SnomedCt,
+            VeterinaryTerminologySourceScopes.SnomedVeterinary,
+        ]
+        : [VeterinaryTerminologySourceScopes.SnomedGps];
+    if (resourceType === 'Condition')
+        return [...clinical, VeterinaryTerminologySourceScopes.Icd10];
+    if (resourceType === 'Immunization')
+        return [VeterinaryTerminologySourceScopes.AtcVet, ...clinical];
+    if (resourceType === 'AllergyIntolerance')
+        return [...clinical, VeterinaryTerminologySourceScopes.AtcVet];
+    return clinical;
+}
+export function veterinaryTerminologySystemsFor(resourceType, countryCode) {
+    const sourceSystem = {
+        [VeterinaryTerminologySourceScopes.Loinc]: VeterinaryClinicalTerminologySystems.Loinc,
+        [VeterinaryTerminologySourceScopes.SnomedGps]: VeterinaryClinicalTerminologySystems.SnomedCt,
+        [VeterinaryTerminologySourceScopes.SnomedCt]: VeterinaryClinicalTerminologySystems.SnomedCt,
+        [VeterinaryTerminologySourceScopes.SnomedVeterinary]: VeterinaryClinicalTerminologySystems.SnomedCt,
+        [VeterinaryTerminologySourceScopes.Icd10]: VeterinaryClinicalTerminologySystems.Icd10,
+        [VeterinaryTerminologySourceScopes.AtcVet]: VeterinaryClinicalTerminologySystems.AtcVet,
+    };
+    return [...new Set(veterinaryTerminologySourcesFor(resourceType, countryCode).map((source) => sourceSystem[source]))];
 }

package/package.json

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