fhir-data-utils-ts 0.6.4 → 0.6.6

package/.codex/skills/govern-fhir-data-utilities/SKILL.md

@@ -15,6 +15,11 @@ description: Complete or audit migrations, claim catalogs, converters, builders,
    authorization and product policy in their owning services or sector packages.
 4. Define every flat key once in its owning named catalog. Import that symbol in
    converters, builders, tests and examples; never repeat a claim-path literal.
+5. For SHC and DGC archaeology, treat `uhc-helpers-typescript` as the early
+   flow source, the later UHC common models/data/common/crypto split as the
+   preferred implementation evidence, and `gdc-common-utils-ts` as its later
+   consolidation. Do not copy an earlier helper when a later governed contract
+   exists.
 
 ## Separate catalogs, adapters and builders
 

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Unreleased
 
+- Export data-only, coverage-excluded authoring schemas for the six minimum IPS
+  resource families used by shared Personal and Professional forms:
+  AllergyIntolerance, MedicationStatement, Immunization, Condition, Procedure
+  and Observation. Every field reuses its owning flat-claim catalog, records
+  the terminology-enabled source-text claims and remains neutral between human
+  and veterinary subjects.
+
+- Recover neutral SHC and EU DGC QR prefix classification from the later UHC
+  data-utility lineage, with exported repository-safe `*.data.ts` examples.
+  Recognition explicitly provides no decoding, verification or authorization.
+
 - Export one repository-safe, telephone-free IPS demo document with all sixteen
   clinical sections from the explicit `fhir-data-utils-ts/data` entry point so
   product portals and visual tests share the same typed source data.

package/dist/data/health-credential-qr.data.d.ts

@@ -0,0 +1,7 @@
+/** Repository-safe non-clinical examples for classification tests and portal hints. */
+export declare const HEALTH_CREDENTIAL_QR_EXAMPLES: Readonly<{
+    smartHealthCard: "shc:/123456";
+    europeanDigitalCertificate: "HC1:DEMO";
+    norwegianDigitalCertificate: "NO1:DEMO";
+    nonCredentialIdentifier: "urn:uuid:00000000-0000-4000-8000-000000000001";
+}>;

package/dist/data/health-credential-qr.data.js

@@ -0,0 +1,7 @@
+/** Repository-safe non-clinical examples for classification tests and portal hints. */
+export const HEALTH_CREDENTIAL_QR_EXAMPLES = Object.freeze({
+    smartHealthCard: 'shc:/123456',
+    europeanDigitalCertificate: 'HC1:DEMO',
+    norwegianDigitalCertificate: 'NO1:DEMO',
+    nonCredentialIdentifier: 'urn:uuid:00000000-0000-4000-8000-000000000001',
+});

package/dist/data/index.d.ts

@@ -2,3 +2,5 @@
 export * from './appointment-communication.data.js';
 export * from './encounter-transfer.data.js';
 export * from './ips-all-sections.data.js';
+export * from './health-credential-qr.data.js';
+export * from './ips-clinical-artifact-schemas.data.js';

package/dist/data/index.js

@@ -2,3 +2,5 @@
 export * from './appointment-communication.data.js';
 export * from './encounter-transfer.data.js';
 export * from './ips-all-sections.data.js';
+export * from './health-credential-qr.data.js';
+export * from './ips-clinical-artifact-schemas.data.js';

package/dist/data/ips-clinical-artifact-schemas.data.d.ts

@@ -0,0 +1,25 @@
+export declare const FhirIpsClinicalArtifactTypes: Readonly<{
+    readonly AllergyIntolerance: "AllergyIntolerance";
+    readonly MedicationStatement: "MedicationStatement";
+    readonly Immunization: "Immunization";
+    readonly Condition: "Condition";
+    readonly Procedure: "Procedure";
+    readonly Observation: "Observation";
+}>;
+export type FhirIpsClinicalArtifactType = typeof FhirIpsClinicalArtifactTypes[keyof typeof FhirIpsClinicalArtifactTypes];
+export type FhirIpsClinicalArtifactSchema = Readonly<{
+    resourceType: FhirIpsClinicalArtifactType;
+    requiredClaims: readonly string[];
+    optionalClaims: readonly string[];
+    /** Source-text claims for which a user may explicitly confirm a terminology candidate. */
+    terminologyTextClaims: readonly string[];
+}>;
+/**
+ * Minimum reusable IPS authoring surface for Personal and Professional portals.
+ *
+ * These data-only schemas contain claim keys, not UI labels, authorization or
+ * transport policy. Human and veterinary portals use the same core resource
+ * contracts; a veterinary terminology adapter may additionally receive the
+ * subject taxonomy without changing the stored FHIR claim names.
+ */
+export declare const FHIR_IPS_CLINICAL_ARTIFACT_SCHEMAS: Readonly<Record<FhirIpsClinicalArtifactType, FhirIpsClinicalArtifactSchema>>;

package/dist/data/ips-clinical-artifact-schemas.data.js

@@ -0,0 +1,61 @@
+// Copyright 2026 Connecting Solution & Applications Ltd under the Apache License, Version 2.0.
+import { AllergyIntoleranceClaim } from '../claims/allergy-intolerance-claims.js';
+import { ConditionClaim } from '../claims/condition-claims.js';
+import { ImmunizationClaim } from '../claims/immunization-claims.js';
+import { MedicationStatementClaim } from '../claims/medication-statement-claims.js';
+import { ProcedureClaim } from '../claims/procedure-claims.js';
+import { ObservationClaim } from '../observation-claims.js';
+export const FhirIpsClinicalArtifactTypes = Object.freeze({
+    AllergyIntolerance: 'AllergyIntolerance',
+    MedicationStatement: 'MedicationStatement',
+    Immunization: 'Immunization',
+    Condition: 'Condition',
+    Procedure: 'Procedure',
+    Observation: 'Observation',
+});
+/**
+ * Minimum reusable IPS authoring surface for Personal and Professional portals.
+ *
+ * These data-only schemas contain claim keys, not UI labels, authorization or
+ * transport policy. Human and veterinary portals use the same core resource
+ * contracts; a veterinary terminology adapter may additionally receive the
+ * subject taxonomy without changing the stored FHIR claim names.
+ */
+export const FHIR_IPS_CLINICAL_ARTIFACT_SCHEMAS = Object.freeze({
+    [FhirIpsClinicalArtifactTypes.AllergyIntolerance]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.AllergyIntolerance,
+        requiredClaims: Object.freeze([AllergyIntoleranceClaim.CodeText, AllergyIntoleranceClaim.ClinicalStatus]),
+        optionalClaims: Object.freeze([AllergyIntoleranceClaim.Code, AllergyIntoleranceClaim.CodeDisplay, AllergyIntoleranceClaim.Category, AllergyIntoleranceClaim.VerificationStatus, AllergyIntoleranceClaim.Criticality, AllergyIntoleranceClaim.OnsetDateTime, AllergyIntoleranceClaim.Recorder]),
+        terminologyTextClaims: Object.freeze([AllergyIntoleranceClaim.CodeText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.MedicationStatement]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.MedicationStatement,
+        requiredClaims: Object.freeze([MedicationStatementClaim.CodeText, MedicationStatementClaim.Status]),
+        optionalClaims: Object.freeze([MedicationStatementClaim.Code, MedicationStatementClaim.CodeDisplay, MedicationStatementClaim.Category, MedicationStatementClaim.Effective, MedicationStatementClaim.DosageInstruction, MedicationStatementClaim.DosageRoute, MedicationStatementClaim.TimingFrequency, MedicationStatementClaim.TimingPeriod, MedicationStatementClaim.TimingPeriodUnit, MedicationStatementClaim.Note]),
+        terminologyTextClaims: Object.freeze([MedicationStatementClaim.CodeText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.Immunization]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.Immunization,
+        requiredClaims: Object.freeze([ImmunizationClaim.VaccineCodeText, ImmunizationClaim.Status]),
+        optionalClaims: Object.freeze([ImmunizationClaim.VaccineCode, ImmunizationClaim.VaccineCodeDisplay, ImmunizationClaim.Date, ImmunizationClaim.LotNumber, ImmunizationClaim.DoseSequence, ImmunizationClaim.Manufacturer, ImmunizationClaim.Performer, ImmunizationClaim.Location, ImmunizationClaim.Route, ImmunizationClaim.RouteDisplay, ImmunizationClaim.Site, ImmunizationClaim.SiteDisplay, ImmunizationClaim.Series, ImmunizationClaim.TargetDisease, ImmunizationClaim.TargetDiseaseText, ImmunizationClaim.TargetDiseaseDisplay, ImmunizationClaim.ReactionDate, ImmunizationClaim.Note]),
+        terminologyTextClaims: Object.freeze([ImmunizationClaim.VaccineCodeText, ImmunizationClaim.TargetDiseaseText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.Condition]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.Condition,
+        requiredClaims: Object.freeze([ConditionClaim.CodeText, ConditionClaim.ClinicalStatus]),
+        optionalClaims: Object.freeze([ConditionClaim.Code, ConditionClaim.CodeDisplay, ConditionClaim.Category, ConditionClaim.VerificationStatus, ConditionClaim.Severity, ConditionClaim.OnsetDateTime, ConditionClaim.RecordedDate, ConditionClaim.Asserter, ConditionClaim.Recorder]),
+        terminologyTextClaims: Object.freeze([ConditionClaim.CodeText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.Procedure]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.Procedure,
+        requiredClaims: Object.freeze([ProcedureClaim.CodeText, ProcedureClaim.Status]),
+        optionalClaims: Object.freeze([ProcedureClaim.Code, ProcedureClaim.CodeDisplay, ProcedureClaim.Date, ProcedureClaim.Performer, ProcedureClaim.Location, ProcedureClaim.BodySite, ProcedureClaim.ReasonCode, ProcedureClaim.ReasonReference, ProcedureClaim.Note]),
+        terminologyTextClaims: Object.freeze([ProcedureClaim.CodeText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.Observation]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.Observation,
+        requiredClaims: Object.freeze([ObservationClaim.Category, ObservationClaim.CodeText, ObservationClaim.Status]),
+        optionalClaims: Object.freeze([ObservationClaim.Code, ObservationClaim.CodeDisplay, ObservationClaim.Date, ObservationClaim.EffectiveDateTime, ObservationClaim.Performer, ObservationClaim.Method, ObservationClaim.Specimen, ObservationClaim.Device, ObservationClaim.ValueQuantityNumber, ObservationClaim.ValueQuantityUnit, ObservationClaim.ValueString, ObservationClaim.ValueConcept, ObservationClaim.ReferenceRangeLowNumber, ObservationClaim.ReferenceRangeHighNumber, ObservationClaim.ReferenceRangeUnit, ObservationClaim.ReferenceRangeText, ObservationClaim.Note]),
+        terminologyTextClaims: Object.freeze([ObservationClaim.CodeText]),
+    }),
+});

package/dist/health-credential-qr.d.ts

@@ -0,0 +1,15 @@
+export declare const HealthCredentialQrPayloadKinds: Readonly<{
+    readonly SmartHealthCard: "smart-health-card";
+    readonly DigitalGreenCertificate: "digital-green-certificate";
+    readonly Unknown: "unknown";
+}>;
+export type HealthCredentialQrPayloadKind = typeof HealthCredentialQrPayloadKinds[keyof typeof HealthCredentialQrPayloadKinds];
+export type HealthCredentialQrClassification = Readonly<{
+    kind: HealthCredentialQrPayloadKind;
+    value: string;
+}>;
+/**
+ * Recognizes the wire prefix only. This function does not decode, verify,
+ * authorize, trust or persist the credential or any embedded FHIR resource.
+ */
+export declare function classifyHealthCredentialQrPayload(value: unknown): HealthCredentialQrClassification;

package/dist/health-credential-qr.js

@@ -0,0 +1,18 @@
+export const HealthCredentialQrPayloadKinds = Object.freeze({
+    SmartHealthCard: 'smart-health-card',
+    DigitalGreenCertificate: 'digital-green-certificate',
+    Unknown: 'unknown',
+});
+/**
+ * Recognizes the wire prefix only. This function does not decode, verify,
+ * authorize, trust or persist the credential or any embedded FHIR resource.
+ */
+export function classifyHealthCredentialQrPayload(value) {
+    const normalized = String(value ?? '').trim();
+    const upper = normalized.toUpperCase();
+    if (normalized.toLowerCase().startsWith('shc:/'))
+        return Object.freeze({ kind: HealthCredentialQrPayloadKinds.SmartHealthCard, value: normalized });
+    if (upper.startsWith('HC1:') || upper.startsWith('NO1:'))
+        return Object.freeze({ kind: HealthCredentialQrPayloadKinds.DigitalGreenCertificate, value: normalized });
+    return Object.freeze({ kind: HealthCredentialQrPayloadKinds.Unknown, value: normalized });
+}

package/dist/index.d.ts

@@ -26,3 +26,4 @@ export * from './subscription-r5.js';
 export * from './healthcare-service-specialty-map.js';
 export * from './data/index.js';
 export * from './fhir-instant.js';
+export * from './health-credential-qr.js';

package/dist/index.js

@@ -26,3 +26,4 @@ export * from './subscription-r5.js';
 export * from './healthcare-service-specialty-map.js';
 export * from './data/index.js';
 export * from './fhir-instant.js';
+export * from './health-credential-qr.js';

package/docs/UHC_FHIR_UTILS_MIGRATION.md

@@ -5,6 +5,14 @@ this package. Its useful behavior must be recovered behind neutral, typed and
 version-explicit contracts. Its product branding, obsolete security choices
 and transport assumptions must not be copied.
 
+The wider historical lineage began with early helpers in
+`uhc-helpers-typescript`, was then split and improved across
+`uhc-common-models-typescript`, `uhc-common-utils-typescript`,
+`data-utils-typescript` and the crypto utilities, and later contributed to
+`gdc-common-utils-ts`. For SHC and DGC, the later split packages are the
+preferred behavioural and type evidence; the early helper remains UI-flow
+evidence only.
+
 ## Migration rules
 
 1. Add the smallest failing contract test here before porting behavior.
@@ -43,6 +51,7 @@ and transport assumptions must not be copied.
 | `gdc-common-utils-ts` converters | Every product-neutral R4/R5 converter present there; Observation component writing was corrected to use a resource graph | Network, persistence and authorization orchestration |
 | `uhc-fhir-utils-typescript` models | ATC/FHIR/LOINC/SNOMED model types, all resource search parameter enums and template interfaces, strict replacement FHIR primitives | Embedded terminology JSON is not authoritative data |
 | `uhc-fhir-utils-typescript` helpers | Coding/token, Identifier, Reference, Quantity, telecom, RelatedPerson search projection and non-mutating Bundle traversal/classification/reference lookup | Message transport, SHA-1 writers, COVID-era product presets and mutation-heavy manager facades |
+| Later UHC data/common packages | SHC and EU DGC QR prefix classification plus repository-safe examples | Signature verification, issuer trust, credential import and authorization remain separate future contracts |
 | `uhc-fhir-utils-typescript` imaging | DICOMDIR structural types only | Byte parsing and pixel extraction require a separately versioned imaging package |
 | `sos-data-utils-ts` | Cross-sector terminology contract and fixtures, Immunization graph and reminder planning | SOS authorization, repository and emergency policy |
 | `vet-data-utils-ts` | Product-neutral FHIR R5 Group and ResearchStudy contracts/search projections | Animal identity, veterinary sections, species, insurance, payment and other Vet policy |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fhir-data-utils-ts",
-  "version": "0.6.4",
+  "version": "0.6.6",
   "description": "FHIR-version-neutral flat-claim and SearchParameter data utilities",
   "license": "Apache-2.0",
   "type": "module",
@@ -107,6 +107,10 @@
       "types": "./dist/healthcare-service-specialty-map.d.ts",
       "default": "./dist/healthcare-service-specialty-map.js"
     },
+    "./health-credential-qr": {
+      "types": "./dist/health-credential-qr.d.ts",
+      "default": "./dist/health-credential-qr.js"
+    },
     "./research-study-r5": {
       "types": "./dist/research-study-r5.d.ts",
       "default": "./dist/research-study-r5.js"