gdc-common-utils-ts 1.20.2 → 1.23.0

package/dist/examples/vital-signs.js

@@ -0,0 +1,159 @@
+// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
+import { ResourceTypesFhirR4 } from '../constants/fhir-resource-types.js';
+import { VitalSignsCodes, VitalSignsUnits } from '../constants/vital-signs.js';
+import { CommunicationClaim } from '../models/interoperable-claims/communication-claims.js';
+import { Format } from '../constants/Schemas.js';
+import { observationFromFlatToFhirR4 } from '../convert/convert-observation.js';
+import { CommunicationAttachedBundleSession } from '../utils/communication-attached-bundle-session.js';
+import { buildVitalSignObservationClaims } from '../utils/individual-bundle-vault.js';
+import { EXAMPLE_COMMUNICATION_IDENTIFIER, EXAMPLE_OBSERVATION_COMPONENT_IDENTIFIER, EXAMPLE_OBSERVATION_COMPONENT_IDENTIFIER_SECONDARY, EXAMPLE_OBSERVATION_IDENTIFIER, EXAMPLE_OBSERVATION_PANEL_IDENTIFIER, EXAMPLE_SUBJECT_DID, EXAMPLE_VITAL_SIGN_DISPLAY_VITAL_SIGNS, EXAMPLE_VITAL_SIGNS_EFFECTIVE_DATE_TIME, EXAMPLE_VITAL_SIGNS_NOTE, EXAMPLE_VITAL_SIGN_VALUE_BODY_TEMPERATURE, EXAMPLE_VITAL_SIGN_VALUE_DIASTOLIC, EXAMPLE_VITAL_SIGN_VALUE_HEART_RATE, EXAMPLE_VITAL_SIGN_VALUE_SYSTOLIC, } from './shared.js';
+/**
+ * Shared example inputs for authoring vital-sign Observations in claims-first
+ * flows.
+ *
+ * Reference:
+ * - HL7 CIMI Vital Signs with Qualifying Elements IG
+ *   https://build.fhir.org/ig/HL7/cimi-vital-signs/
+ *
+ * These examples intentionally cover only direct vital-sign authoring inputs
+ * that a person or simple frontend form would create:
+ * - heart rate
+ * - body temperature
+ * - systolic blood pressure
+ * - diastolic blood pressure
+ *
+ * Panel/group authoring is excluded on purpose because panels are typically
+ * imported from external FHIR systems or composed by professional workflows.
+ */
+/** Example claims-first input for one heart rate Observation (LOINC 8867-4, UCUM /min). */
+export const EXAMPLE_VITAL_SIGN_HEART_RATE_INPUT = {
+    identifier: EXAMPLE_OBSERVATION_IDENTIFIER,
+    subject: EXAMPLE_SUBJECT_DID,
+    code: VitalSignsCodes.HeartRate,
+    unit: VitalSignsUnits.BeatsPerMinute,
+    valueQuantity: EXAMPLE_VITAL_SIGN_VALUE_HEART_RATE,
+    effectiveDateTime: EXAMPLE_VITAL_SIGNS_EFFECTIVE_DATE_TIME,
+};
+/** Example claims-first input for one body temperature Observation (LOINC 8310-5, UCUM Cel). */
+export const EXAMPLE_VITAL_SIGN_BODY_TEMPERATURE_INPUT = {
+    identifier: EXAMPLE_OBSERVATION_PANEL_IDENTIFIER,
+    subject: EXAMPLE_SUBJECT_DID,
+    code: VitalSignsCodes.BodyTemperature,
+    unit: VitalSignsUnits.Celsius,
+    valueQuantity: EXAMPLE_VITAL_SIGN_VALUE_BODY_TEMPERATURE,
+    effectiveDateTime: EXAMPLE_VITAL_SIGNS_EFFECTIVE_DATE_TIME,
+};
+/** Example claims-first input for one systolic blood pressure Observation (LOINC 8480-6, UCUM mm[Hg]). */
+export const EXAMPLE_VITAL_SIGN_SYSTOLIC_BLOOD_PRESSURE_INPUT = {
+    identifier: EXAMPLE_OBSERVATION_COMPONENT_IDENTIFIER,
+    subject: EXAMPLE_SUBJECT_DID,
+    code: VitalSignsCodes.SystolicBloodPressure,
+    unit: VitalSignsUnits.MillimeterOfMercury,
+    valueQuantity: EXAMPLE_VITAL_SIGN_VALUE_SYSTOLIC,
+    effectiveDateTime: EXAMPLE_VITAL_SIGNS_EFFECTIVE_DATE_TIME,
+};
+/** Example claims-first input for one diastolic blood pressure Observation (LOINC 8462-4, UCUM mm[Hg]). */
+export const EXAMPLE_VITAL_SIGN_DIASTOLIC_BLOOD_PRESSURE_INPUT = {
+    identifier: EXAMPLE_OBSERVATION_COMPONENT_IDENTIFIER_SECONDARY,
+    subject: EXAMPLE_SUBJECT_DID,
+    code: VitalSignsCodes.DiastolicBloodPressure,
+    unit: VitalSignsUnits.MillimeterOfMercury,
+    valueQuantity: EXAMPLE_VITAL_SIGN_VALUE_DIASTOLIC,
+    effectiveDateTime: EXAMPLE_VITAL_SIGNS_EFFECTIVE_DATE_TIME,
+};
+function resolveObservationEntryFullUrl(identifier) {
+    return String(identifier || '').startsWith('urn:')
+        ? String(identifier)
+        : `urn:uuid:${String(identifier)}`;
+}
+function toFlatClaims(record) {
+    const claims = {};
+    for (const [key, value] of Object.entries(record || {})) {
+        if (value === undefined || value === null)
+            continue;
+        claims[key] = typeof value === 'string' ? value : String(value);
+    }
+    return claims;
+}
+/**
+ * Builds one high-level bundle entry for a vital-sign Observation.
+ *
+ * This is the preferred copy-paste pattern for frontend flows:
+ * 1. author flat claims with `buildVitalSignObservationClaims(...)`
+ * 2. convert them to one FHIR R4 `Observation`
+ * 3. keep the claims in `resource.meta.claims`
+ * 4. append the entry to a `Bundle.data` array
+ */
+export function buildVitalSignObservationEntry(input) {
+    const claims = buildVitalSignObservationClaims(input);
+    const flatClaims = toFlatClaims(claims);
+    const resource = observationFromFlatToFhirR4(flatClaims);
+    return {
+        id: String(claims['Observation.identifier'] || input.identifier),
+        fullUrl: resolveObservationEntryFullUrl(String(claims['Observation.identifier'] || input.identifier)),
+        type: `${ResourceTypesFhirR4.Observation}-entry-v1.0`,
+        resource: {
+            ...resource,
+            meta: {
+                ...(resource.meta || {}),
+                claims: flatClaims,
+            },
+        },
+    };
+}
+/**
+ * Builds a high-level bundle with one entry per directly authored vital sign.
+ *
+ * Included examples:
+ * - heart rate
+ * - body temperature
+ * - systolic blood pressure
+ * - diastolic blood pressure
+ *
+ * Panels are intentionally excluded because the app user normally authors
+ * simple observations, not professional/imported panel structures.
+ */
+export function buildExampleVitalSignsObservationBundle() {
+    return {
+        resourceType: 'Bundle',
+        type: 'collection',
+        data: [
+            buildVitalSignObservationEntry(EXAMPLE_VITAL_SIGN_HEART_RATE_INPUT),
+            buildVitalSignObservationEntry(EXAMPLE_VITAL_SIGN_BODY_TEMPERATURE_INPUT),
+            buildVitalSignObservationEntry(EXAMPLE_VITAL_SIGN_SYSTOLIC_BLOOD_PRESSURE_INPUT),
+            buildVitalSignObservationEntry(EXAMPLE_VITAL_SIGN_DIASTOLIC_BLOOD_PRESSURE_INPUT),
+        ],
+    };
+}
+/**
+ * Builds the same vital-sign bundle through `CommunicationAttachedBundleSession`
+ * for flows that already use the in-memory bundle editor/session abstraction.
+ */
+export function buildExampleVitalSignsObservationBundleSession() {
+    const session = new CommunicationAttachedBundleSession({
+        communicationClaims: {
+            '@context': Format.FHIR_API,
+            [CommunicationClaim.Identifier]: EXAMPLE_COMMUNICATION_IDENTIFIER,
+            [CommunicationClaim.Subject]: EXAMPLE_SUBJECT_DID,
+            [CommunicationClaim.Text]: EXAMPLE_VITAL_SIGN_DISPLAY_VITAL_SIGNS,
+        },
+    });
+    const inputs = [
+        EXAMPLE_VITAL_SIGN_HEART_RATE_INPUT,
+        EXAMPLE_VITAL_SIGN_BODY_TEMPERATURE_INPUT,
+        EXAMPLE_VITAL_SIGN_SYSTOLIC_BLOOD_PRESSURE_INPUT,
+        EXAMPLE_VITAL_SIGN_DIASTOLIC_BLOOD_PRESSURE_INPUT,
+    ];
+    for (const input of inputs) {
+        session.upsertActiveObservationEntry({
+            claims: buildVitalSignObservationClaims({
+                ...input,
+                note: EXAMPLE_VITAL_SIGNS_NOTE,
+            }),
+            fullUrl: resolveObservationEntryFullUrl(input.identifier),
+            type: `${ResourceTypesFhirR4.Observation}-entry-v1.0`,
+        });
+        session.saveAndReleaseActiveEntry();
+    }
+    return session.getBundleInMemory();
+}

package/dist/models/fhir-documents.d.ts

@@ -23,6 +23,10 @@ export type FhirAttachment = {
     url?: string;
     title?: string;
     creation?: string;
+    hash?: string;
+};
+export type FhirMeta = {
+    claims?: Record<string, unknown>;
 };
 export interface FhirCompositionResource {
     resourceType: 'Composition';
@@ -46,6 +50,7 @@ export interface FhirCompositionResource {
 export interface FhirDocumentReferenceResource {
     resourceType: 'DocumentReference';
     id?: string;
+    meta?: FhirMeta;
     status?: string;
     identifier?: Array<{
         system?: string;
@@ -81,9 +86,39 @@ export interface FhirDocumentReferenceResource {
         format?: FhirCoding;
     }>;
 }
+export interface FhirInvoiceResource {
+    resourceType: 'Invoice';
+    id?: string;
+    meta?: FhirMeta;
+    status?: string;
+    identifier?: Array<{
+        system?: string;
+        value?: string;
+    }>;
+    subject?: FhirReference;
+    recipient?: FhirReference;
+    issuer?: {
+        reference?: string;
+        display?: string;
+    };
+    date?: string;
+    paymentTerms?: string;
+    note?: Array<{
+        text?: string;
+    }>;
+    totalNet?: {
+        value?: number;
+        currency?: string;
+    };
+    totalGross?: {
+        value?: number;
+        currency?: string;
+    };
+}
 export interface FhirCommunicationResource {
     resourceType: 'Communication';
     id?: string;
+    meta?: FhirMeta;
     status?: string;
     category?: FhirCodeableConcept[];
     subject?: FhirReference;

package/dist/models/indexing.d.ts

@@ -1,11 +1,73 @@
-import { ClaimsOrganizationSchemaorg } from "../constants/schemaorg";
+import { ClaimsOrganizationSchemaorg } from '../constants/schemaorg';
+import type { ParameterData } from './params';
+/**
+ * Canonical index profile names used under each resource type.
+ */
+export declare const IndexingClaimSet: Readonly<{
+    readonly General: "General";
+    readonly Registry: "Registry";
+    readonly VitalSigns: "VitalSigns";
+}>;
+export type IndexingClaimSetKey = typeof IndexingClaimSet[keyof typeof IndexingClaimSet];
 /**
  * Defines which claims are allowed to be indexed for different resource types.
- * This provides a single, strongly-typed source of truth for indexing strategies.
+ *
+ * Preferred shape:
+ * `AllowedIndexableClaims[ResourceType][General/category/type]`
  */
 export declare const AllowedIndexableClaims: {
-    /**
-     * Defines the claims that can be indexed in the central tenant registry for an Organization.
-     */
-    organizationRegistry: readonly [ClaimsOrganizationSchemaorg.alternateName, ClaimsOrganizationSchemaorg.identifierValue, ClaimsOrganizationSchemaorg.identifierType, ClaimsOrganizationSchemaorg.addressCountry];
+    readonly Organization: {
+        /**
+         * Claims that can be indexed in the central tenant registry for an Organization.
+         */
+        readonly Registry: readonly [ClaimsOrganizationSchemaorg.alternateName, ClaimsOrganizationSchemaorg.identifierValue, ClaimsOrganizationSchemaorg.identifierType, ClaimsOrganizationSchemaorg.addressCountry];
+    };
+    readonly Observation: {
+        /**
+         * Searchable/indexable subset for a general Observation row.
+         *
+         * Keep this aligned with GW managers that build `indexed.attributes` from
+         * claims-first payloads. UI-only or long free-text fields stay out.
+         */
+        readonly General: readonly ["Observation.identifier", "Observation.subject", "Observation.patient", "Observation.status", "Observation.category", "Observation.code-system", "Observation.code-value", "Observation.code", "Observation.date", "Observation.effectiveDateTime", "Observation.value-concept-system", "Observation.value-concept-value", "Observation.value-concept", "Observation.value-date", "Observation.value-quantity-comparator", "Observation.value-quantity-number", "Observation.value-quantity-unit", "Observation.score-total-number", "Observation.component-tags", "Observation.component-code-values", "Observation.component-names", "Observation.bp-systolic-number", "Observation.bp-diastolic-number", "Observation.has-member", "Observation.encounter", "Observation.device", "Observation.specimen", "Observation.performer", "Observation.based-on", "Observation.focus", "Observation.method", "Observation.language"];
+        /**
+         * Searchable/indexable subset for a Vital Signs Observation row.
+         *
+         * This is intentionally narrower than the full persisted claims list and
+         * excludes local-language labels, XHTML/narrative, and note text.
+         */
+        readonly VitalSigns: readonly ["Observation.identifier", "Observation.subject", "Observation.patient", "Observation.status", "Observation.category", "Observation.code-system", "Observation.code-value", "Observation.code", "Observation.date", "Observation.effectiveDateTime", "Observation.value-concept-system", "Observation.value-concept-value", "Observation.value-concept", "Observation.value-date", "Observation.value-quantity-comparator", "Observation.value-quantity-number", "Observation.value-quantity-unit", "Observation.score-total-number", "Observation.component-tags", "Observation.component-code-values", "Observation.component-names", "Observation.bp-systolic-number", "Observation.bp-diastolic-number", "Observation.has-member", "Observation.method", "Observation.language"];
+    };
+    readonly Condition: {
+        readonly General: readonly ["Condition.identifier", "Condition.subject", "Condition.clinical-status", "Condition.verification-status", "Condition.category", "Condition.code", "Condition.severity", "Condition.onset-datetime", "Condition.recorder"];
+    };
+    readonly MedicationStatement: {
+        readonly General: readonly ["MedicationStatement.identifier", "MedicationStatement.subject", "MedicationStatement.patient", "MedicationStatement.status", "MedicationStatement.category", "MedicationStatement.effective", "MedicationStatement.code", "MedicationStatement.medication", "MedicationStatement.part-of", "MedicationStatement.source", "MedicationStatement.medication-identifier", "MedicationStatement.medication-serial-number", "MedicationStatement.medication-expiration-date"];
+    };
+    readonly DocumentReference: {
+        readonly General: readonly ["DocumentReference.identifier", "DocumentReference.subject", "DocumentReference.author", "DocumentReference.attester", "DocumentReference.basedOn", "DocumentReference.category", "DocumentReference.contenthash", "DocumentReference.contenttype", "DocumentReference.context", "DocumentReference.creation", "DocumentReference.date", "DocumentReference.event-code", "DocumentReference.event-reference", "DocumentReference.format-uri", "DocumentReference.language", "DocumentReference.location", "DocumentReference.modality", "DocumentReference.relatesto", "DocumentReference.relation", "DocumentReference.type"];
+    };
 };
+export type AllowedIndexableClaimsKey = keyof typeof AllowedIndexableClaims;
+/**
+ * Deprecated compatibility aliases.
+ *
+ * Prefer `AllowedIndexableClaims[ResourceTypesFhirR4.Observation].General`,
+ * `AllowedIndexableClaims[ResourceTypesFhirR4.Observation].VitalSigns`, and
+ * `AllowedIndexableClaims.Organization.Registry` in new code.
+ */
+export declare const AllowedIndexableClaimAliases: Readonly<{
+    readonly organizationRegistry: readonly [ClaimsOrganizationSchemaorg.alternateName, ClaimsOrganizationSchemaorg.identifierValue, ClaimsOrganizationSchemaorg.identifierType, ClaimsOrganizationSchemaorg.addressCountry];
+    readonly observationGeneral: readonly ["Observation.identifier", "Observation.subject", "Observation.patient", "Observation.status", "Observation.category", "Observation.code-system", "Observation.code-value", "Observation.code", "Observation.date", "Observation.effectiveDateTime", "Observation.value-concept-system", "Observation.value-concept-value", "Observation.value-concept", "Observation.value-date", "Observation.value-quantity-comparator", "Observation.value-quantity-number", "Observation.value-quantity-unit", "Observation.score-total-number", "Observation.component-tags", "Observation.component-code-values", "Observation.component-names", "Observation.bp-systolic-number", "Observation.bp-diastolic-number", "Observation.has-member", "Observation.encounter", "Observation.device", "Observation.specimen", "Observation.performer", "Observation.based-on", "Observation.focus", "Observation.method", "Observation.language"];
+    readonly observationVitalSigns: readonly ["Observation.identifier", "Observation.subject", "Observation.patient", "Observation.status", "Observation.category", "Observation.code-system", "Observation.code-value", "Observation.code", "Observation.date", "Observation.effectiveDateTime", "Observation.value-concept-system", "Observation.value-concept-value", "Observation.value-concept", "Observation.value-date", "Observation.value-quantity-comparator", "Observation.value-quantity-number", "Observation.value-quantity-unit", "Observation.score-total-number", "Observation.component-tags", "Observation.component-code-values", "Observation.component-names", "Observation.bp-systolic-number", "Observation.bp-diastolic-number", "Observation.has-member", "Observation.method", "Observation.language"];
+}>;
+/**
+ * Projects a claims-first record to the `ParameterData[]` shape used by GW/KMS
+ * before optional HMAC protection.
+ */
+export declare function buildIndexParametersFromClaims(claims: Record<string, unknown>, allowedClaims: readonly string[]): ParameterData[];
+/**
+ * Sanity guard to keep the indexable subset anchored to the broader claims
+ * lists declared by the interoperable-claims contract.
+ */
+export declare function isAllowedObservationIndexableClaim(claimKey: string, variant: 'general' | 'vital-signs'): boolean;

package/dist/models/indexing.js

@@ -1,18 +1,301 @@
 // Copyright 2025 Antifraud Services Inc. under the Apache License, Version 2.0.
 // File: src/models/indexing.ts
-import { ClaimsOrganizationSchemaorg } from "../constants/schemaorg.js";
+import { ResourceTypesFhirR4 } from '../constants/fhir-resource-types.js';
+import { ClaimsOrganizationSchemaorg } from '../constants/schemaorg.js';
+import { ConditionClaim } from './interoperable-claims/condition-claims.js';
+import { DocumentReferenceClaim } from './interoperable-claims/document-reference-claims.js';
+import { MedicationStatementClaim } from './interoperable-claims/medication-statement-claims.js';
+import { ObservationClaim, ObservationGeneralClaimsList, ObservationVitalSignsClaimsList, } from './interoperable-claims/observation-claims.js';
+/**
+ * Canonical index profile names used under each resource type.
+ */
+export const IndexingClaimSet = Object.freeze({
+    General: 'General',
+    Registry: 'Registry',
+    VitalSigns: 'VitalSigns',
+});
 /**
  * Defines which claims are allowed to be indexed for different resource types.
- * This provides a single, strongly-typed source of truth for indexing strategies.
+ *
+ * Preferred shape:
+ * `AllowedIndexableClaims[ResourceType][General/category/type]`
  */
 export const AllowedIndexableClaims = {
-    /**
-     * Defines the claims that can be indexed in the central tenant registry for an Organization.
-     */
-    organizationRegistry: [
-        ClaimsOrganizationSchemaorg.alternateName,
-        ClaimsOrganizationSchemaorg.identifierValue,
-        ClaimsOrganizationSchemaorg.identifierType,
-        ClaimsOrganizationSchemaorg.addressCountry,
-    ], // Use 'as const' to provide strong typing for the array elements
+    Organization: {
+        /**
+         * Claims that can be indexed in the central tenant registry for an Organization.
+         */
+        [IndexingClaimSet.Registry]: [
+            ClaimsOrganizationSchemaorg.alternateName,
+            ClaimsOrganizationSchemaorg.identifierValue,
+            ClaimsOrganizationSchemaorg.identifierType,
+            ClaimsOrganizationSchemaorg.addressCountry,
+        ],
+    },
+    [ResourceTypesFhirR4.Observation]: {
+        /**
+         * Searchable/indexable subset for a general Observation row.
+         *
+         * Keep this aligned with GW managers that build `indexed.attributes` from
+         * claims-first payloads. UI-only or long free-text fields stay out.
+         */
+        [IndexingClaimSet.General]: [
+            ObservationClaim.Identifier,
+            ObservationClaim.Subject,
+            ObservationClaim.Patient,
+            ObservationClaim.Status,
+            ObservationClaim.Category,
+            ObservationClaim.CodeSystem,
+            ObservationClaim.CodeValue,
+            ObservationClaim.Code,
+            ObservationClaim.Date,
+            ObservationClaim.EffectiveDateTime,
+            ObservationClaim.ValueConceptSystem,
+            ObservationClaim.ValueConceptValue,
+            ObservationClaim.ValueConcept,
+            ObservationClaim.ValueDate,
+            ObservationClaim.ValueQuantityComparator,
+            ObservationClaim.ValueQuantityNumber,
+            ObservationClaim.ValueQuantityUnit,
+            ObservationClaim.ScoreTotalNumber,
+            ObservationClaim.ComponentTags,
+            ObservationClaim.ComponentCodeValues,
+            ObservationClaim.ComponentNames,
+            ObservationClaim.BloodPressureSystolicNumber,
+            ObservationClaim.BloodPressureDiastolicNumber,
+            ObservationClaim.HasMember,
+            ObservationClaim.Encounter,
+            ObservationClaim.Device,
+            ObservationClaim.Specimen,
+            ObservationClaim.Performer,
+            ObservationClaim.BasedOn,
+            ObservationClaim.Focus,
+            ObservationClaim.Method,
+            ObservationClaim.Language,
+        ],
+        /**
+         * Searchable/indexable subset for a Vital Signs Observation row.
+         *
+         * This is intentionally narrower than the full persisted claims list and
+         * excludes local-language labels, XHTML/narrative, and note text.
+         */
+        [IndexingClaimSet.VitalSigns]: [
+            ObservationClaim.Identifier,
+            ObservationClaim.Subject,
+            ObservationClaim.Patient,
+            ObservationClaim.Status,
+            ObservationClaim.Category,
+            ObservationClaim.CodeSystem,
+            ObservationClaim.CodeValue,
+            ObservationClaim.Code,
+            ObservationClaim.Date,
+            ObservationClaim.EffectiveDateTime,
+            ObservationClaim.ValueConceptSystem,
+            ObservationClaim.ValueConceptValue,
+            ObservationClaim.ValueConcept,
+            ObservationClaim.ValueDate,
+            ObservationClaim.ValueQuantityComparator,
+            ObservationClaim.ValueQuantityNumber,
+            ObservationClaim.ValueQuantityUnit,
+            ObservationClaim.ScoreTotalNumber,
+            ObservationClaim.ComponentTags,
+            ObservationClaim.ComponentCodeValues,
+            ObservationClaim.ComponentNames,
+            ObservationClaim.BloodPressureSystolicNumber,
+            ObservationClaim.BloodPressureDiastolicNumber,
+            ObservationClaim.HasMember,
+            ObservationClaim.Method,
+            ObservationClaim.Language,
+        ],
+    },
+    [ResourceTypesFhirR4.Condition]: {
+        [IndexingClaimSet.General]: [
+            ConditionClaim.Identifier,
+            ConditionClaim.Subject,
+            ConditionClaim.ClinicalStatus,
+            ConditionClaim.VerificationStatus,
+            ConditionClaim.Category,
+            ConditionClaim.Code,
+            ConditionClaim.Severity,
+            ConditionClaim.OnsetDateTime,
+            ConditionClaim.Recorder,
+        ],
+    },
+    [ResourceTypesFhirR4.MedicationStatement]: {
+        [IndexingClaimSet.General]: [
+            MedicationStatementClaim.Identifier,
+            MedicationStatementClaim.Subject,
+            MedicationStatementClaim.Patient,
+            MedicationStatementClaim.Status,
+            MedicationStatementClaim.Category,
+            MedicationStatementClaim.Effective,
+            MedicationStatementClaim.Code,
+            MedicationStatementClaim.Medication,
+            MedicationStatementClaim.PartOf,
+            MedicationStatementClaim.Source,
+            MedicationStatementClaim.MedicationIdentifier,
+            MedicationStatementClaim.MedicationSerialNumber,
+            MedicationStatementClaim.MedicationExpirationDate,
+        ],
+    },
+    [ResourceTypesFhirR4.DocumentReference]: {
+        [IndexingClaimSet.General]: [
+            DocumentReferenceClaim.Identifier,
+            DocumentReferenceClaim.Subject,
+            DocumentReferenceClaim.Author,
+            DocumentReferenceClaim.Attester,
+            DocumentReferenceClaim.BasedOn,
+            DocumentReferenceClaim.Category,
+            DocumentReferenceClaim.ContentHash,
+            DocumentReferenceClaim.ContentType,
+            DocumentReferenceClaim.Context,
+            DocumentReferenceClaim.Creation,
+            DocumentReferenceClaim.Date,
+            DocumentReferenceClaim.EventCode,
+            DocumentReferenceClaim.EventReference,
+            DocumentReferenceClaim.FormatUri,
+            DocumentReferenceClaim.Language,
+            DocumentReferenceClaim.Location,
+            DocumentReferenceClaim.Modality,
+            DocumentReferenceClaim.RelatesTo,
+            DocumentReferenceClaim.Relation,
+            DocumentReferenceClaim.Type,
+        ],
+    },
 };
+/**
+ * Deprecated compatibility aliases.
+ *
+ * Prefer `AllowedIndexableClaims[ResourceTypesFhirR4.Observation].General`,
+ * `AllowedIndexableClaims[ResourceTypesFhirR4.Observation].VitalSigns`, and
+ * `AllowedIndexableClaims.Organization.Registry` in new code.
+ */
+export const AllowedIndexableClaimAliases = Object.freeze({
+    organizationRegistry: AllowedIndexableClaims.Organization.Registry,
+    observationGeneral: AllowedIndexableClaims[ResourceTypesFhirR4.Observation][IndexingClaimSet.General],
+    observationVitalSigns: AllowedIndexableClaims[ResourceTypesFhirR4.Observation][IndexingClaimSet.VitalSigns],
+});
+/**
+ * Projects a claims-first record to the `ParameterData[]` shape used by GW/KMS
+ * before optional HMAC protection.
+ */
+export function buildIndexParametersFromClaims(claims, allowedClaims) {
+    const parameters = [];
+    for (const claimKey of allowedClaims) {
+        const rawValue = claims[claimKey];
+        if (rawValue === undefined || rawValue === null || rawValue === '') {
+            continue;
+        }
+        const value = typeof rawValue === 'number' ? rawValue : String(rawValue).trim();
+        if (value === '') {
+            continue;
+        }
+        const parameter = {
+            name: claimKey,
+            value: value,
+            type: inferParameterTypeFromClaimKey(claimKey, rawValue),
+            ...(claimKey === ObservationClaim.ValueQuantityUnit && typeof rawValue === 'string'
+                ? { unit: rawValue }
+                : {}),
+        };
+        parameters.push(parameter);
+    }
+    return parameters;
+}
+function inferParameterTypeFromClaimKey(claimKey, rawValue) {
+    if (claimKey === ObservationClaim.ValueQuantityNumber
+        || claimKey === ObservationClaim.ScoreTotalNumber
+        || claimKey === ObservationClaim.BloodPressureSystolicNumber
+        || claimKey === ObservationClaim.BloodPressureDiastolicNumber) {
+        return 'number';
+    }
+    if (claimKey === ObservationClaim.Date
+        || claimKey === ObservationClaim.EffectiveDateTime
+        || claimKey === ObservationClaim.ValueDate
+        || claimKey === ConditionClaim.OnsetDateTime
+        || claimKey === MedicationStatementClaim.Effective
+        || claimKey === MedicationStatementClaim.MedicationExpirationDate
+        || claimKey === DocumentReferenceClaim.Creation
+        || claimKey === DocumentReferenceClaim.Date) {
+        return 'date';
+    }
+    if (claimKey === ObservationClaim.Subject
+        || claimKey === ObservationClaim.Patient
+        || claimKey === ObservationClaim.Encounter
+        || claimKey === ObservationClaim.Device
+        || claimKey === ObservationClaim.Specimen
+        || claimKey === ObservationClaim.Performer
+        || claimKey === ObservationClaim.BasedOn
+        || claimKey === ObservationClaim.Focus
+        || claimKey === ObservationClaim.HasMember
+        || claimKey === ConditionClaim.Subject
+        || claimKey === ConditionClaim.Recorder
+        || claimKey === MedicationStatementClaim.Subject
+        || claimKey === MedicationStatementClaim.Patient
+        || claimKey === MedicationStatementClaim.PartOf
+        || claimKey === MedicationStatementClaim.Source
+        || claimKey === DocumentReferenceClaim.Subject
+        || claimKey === DocumentReferenceClaim.Author
+        || claimKey === DocumentReferenceClaim.Attester
+        || claimKey === DocumentReferenceClaim.BasedOn
+        || claimKey === DocumentReferenceClaim.Context
+        || claimKey === DocumentReferenceClaim.EventReference
+        || claimKey === DocumentReferenceClaim.RelatesTo) {
+        return 'reference';
+    }
+    if (claimKey === ObservationClaim.Category
+        || claimKey === ObservationClaim.ComponentTags
+        || claimKey === ObservationClaim.ComponentCodeValues
+        || claimKey === ObservationClaim.CodeSystem
+        || claimKey === ObservationClaim.CodeValue
+        || claimKey === ObservationClaim.Code
+        || claimKey === ObservationClaim.ValueConceptSystem
+        || claimKey === ObservationClaim.ValueConceptValue
+        || claimKey === ObservationClaim.ValueConcept
+        || claimKey === ObservationClaim.Method
+        || claimKey === ObservationClaim.Language
+        || claimKey === ObservationClaim.ValueQuantityComparator
+        || claimKey === ObservationClaim.ValueQuantityUnit
+        || claimKey === ConditionClaim.ClinicalStatus
+        || claimKey === ConditionClaim.VerificationStatus
+        || claimKey === ConditionClaim.Category
+        || claimKey === ConditionClaim.Code
+        || claimKey === ConditionClaim.Severity
+        || claimKey === MedicationStatementClaim.Status
+        || claimKey === MedicationStatementClaim.Category
+        || claimKey === MedicationStatementClaim.Code
+        || claimKey === MedicationStatementClaim.Medication
+        || claimKey === DocumentReferenceClaim.Category
+        || claimKey === DocumentReferenceClaim.ContentType
+        || claimKey === DocumentReferenceClaim.EventCode
+        || claimKey === DocumentReferenceClaim.FormatUri
+        || claimKey === DocumentReferenceClaim.Language
+        || claimKey === DocumentReferenceClaim.Modality
+        || claimKey === DocumentReferenceClaim.Relation
+        || claimKey === DocumentReferenceClaim.Type) {
+        return 'token';
+    }
+    if (claimKey === ObservationClaim.ComponentNames) {
+        return 'string';
+    }
+    if ((claimKey === ObservationClaim.Identifier
+        || claimKey === ConditionClaim.Identifier
+        || claimKey === MedicationStatementClaim.Identifier
+        || claimKey === DocumentReferenceClaim.Identifier)
+        && typeof rawValue === 'string'
+        && /^urn:|^did:|^https?:/i.test(rawValue)) {
+        return 'uri';
+    }
+    return 'string';
+}
+/**
+ * Sanity guard to keep the indexable subset anchored to the broader claims
+ * lists declared by the interoperable-claims contract.
+ */
+export function isAllowedObservationIndexableClaim(claimKey, variant) {
+    const fullList = variant === 'general' ? ObservationGeneralClaimsList : ObservationVitalSignsClaimsList;
+    const allowed = variant === 'general'
+        ? AllowedIndexableClaims[ResourceTypesFhirR4.Observation][IndexingClaimSet.General]
+        : AllowedIndexableClaims[ResourceTypesFhirR4.Observation][IndexingClaimSet.VitalSigns];
+    return fullList.some((item) => item === claimKey) && allowed.some((item) => item === claimKey);
+}

package/dist/models/interoperable-claims/index.d.ts

@@ -22,3 +22,4 @@ export * from './related-person-claims';
 export * from './coverage-claims';
 export * from './clinical-impression-claims';
 export * from './task-claims';
+export * from './invoice-claims';

package/dist/models/interoperable-claims/index.js

@@ -24,3 +24,4 @@ export * from './related-person-claims.js';
 export * from './coverage-claims.js';
 export * from './clinical-impression-claims.js';
 export * from './task-claims.js';
+export * from './invoice-claims.js';