fhir-data-utils-ts 0.2.4 → 0.3.2

package/dist/claims/consent-claims.d.ts

@@ -0,0 +1,195 @@
+export declare enum ClaimConsent {
+    'decision' = "Consent.decision",
+    'status' = "Consent.status",
+    'action' = "Consent.action",
+    'category' = "Consent.category",
+    'categoryText' = "Consent.category-text",
+    'categoryDisplay' = "Consent.category-display",
+    'resourceType' = "Consent.resource-type",
+    'subject' = "Consent.subject",
+    'patient' = "Consent.patient",
+    'actorIdentifier' = "Consent.actor-identifier",
+    'actorRole' = "Consent.actor-role",
+    'date' = "Consent.date",
+    'periodStart' = "Consent.period-start",
+    'periodEnd' = "Consent.period-end",
+    'dataPeriodStart' = "Consent.data-period-start",
+    'dataPeriodEnd' = "Consent.data-period-end",
+    'grantor' = "Consent.grantor",
+    'grantee' = "Consent.grantee",
+    'manager' = "Consent.manager",
+    'controller' = "Consent.controller",
+    'verifiedBy' = "Consent.verified-by",
+    'verifiedDate' = "Consent.verified-date",
+    'purpose' = "Consent.purpose",
+    'identifier' = "Consent.identifier",
+    'eventBasedOn' = "Consent.event-basedon",
+    'sourceReference' = "Consent.source-reference",
+    'scope' = "Consent.scope",
+    'scopeDisplay' = "Consent.scope-display",
+    'policyRule' = "Consent.policy-rule",
+    'provisionCode' = "Consent.provision-code",
+    'provisionCodeDisplay' = "Consent.provision-code-display",
+    'securityLabel' = "Consent.security-label",
+    'documentType' = "Consent.document-type",
+    'containedReferenceList' = "Consent.contained-reference-list",
+    /**
+     * @deprecated Use `containedReferenceList`.
+     */
+    'containedResourceList' = "Consent.contained-resource-list",
+    /**
+     * @deprecated Use `containedReferenceList`.
+     */
+    'containedDocuments' = "Consent.contained-documents",
+    /**
+     * @deprecated Use `containedReferenceList`.
+     */
+    'attachmentContentIds' = "Consent.attachment-content-ids",
+    'attachmentContentType' = "Consent.attachment-contenttype",
+    'attachmentData' = "Consent.attachment-data",
+    'attachmentId' = "Consent.attachment-id"
+}
+/** Canonical resource-catalog name used consistently by the package. */
+export declare const ConsentClaim: typeof ClaimConsent;
+export declare const ConsentDecisions: Readonly<{
+    readonly Permit: "permit";
+    readonly Deny: "deny";
+}>;
+export type ConsentDecision = typeof ConsentDecisions[keyof typeof ConsentDecisions];
+/**
+ * Canonical FHIR R5 Consent lifecycle states.
+ *
+ * `draft` is the only state used for a professional permission request. A
+ * draft is carried to the controller for review and must never participate in
+ * authorization evaluation. Only `active` consent rules can grant access.
+ */
+export declare const ConsentStatuses: Readonly<{
+    readonly Draft: "draft";
+    readonly Active: "active";
+    readonly Inactive: "inactive";
+    readonly NotDone: "not-done";
+    readonly EnteredInError: "entered-in-error";
+    readonly Unknown: "unknown";
+}>;
+export type ConsentStatus = typeof ConsentStatuses[keyof typeof ConsentStatuses];
+/**
+ * Defines the structured, query-optimized format for storing a single, atomic consent rule
+ * in the vault (e.g., Firestore, CouchDB).
+ *
+ * This object is the "Query" model in a CQRS (Command Query Responsibility Segregation) pattern.
+ * It is generated by the `ConsentManager` from the "Command" - a set of interoperable claims
+ * provided in the `meta.claims` block of an incoming FHIR Consent resource.
+ *
+ * The backend's authorization engine queries against collections of these objects for high-speed
+ * access decisions. The original FHIR Consent resource may be stored separately for auditing.
+ *
+ * All fields are derived from claims using the reverse-DNS format, e.g., the `decision` field
+ * is populated from the `org.hl7.fhir.api.Consent.decision` claim.
+ */
+export interface ConsentRule {
+    /**
+     * JSON-LD context to define the vocabulary for the rule.
+     * Value MUST be "org.hl7.fhir.api".
+     */
+    '@context': 'org.hl7.fhir.api';
+    /** FHIR Consent lifecycle state; authorization evaluators accept only `active`. */
+    'Consent.status'?: ConsentStatus;
+    /**
+     * The decision of the rule: permit or deny.
+     * Derived from the `org.hl7.fhir.api.Consent.decision` claim.
+     */
+    'Consent.decision': ConsentDecision;
+    /**
+     * The data sections this rule applies to, as a comma-separated list of coded values.
+     * Derived from the `org.hl7.fhir.api.Consent.action` claim.
+     * Example claim: "LOINC|48765-2,SNOMED|12345"
+     */
+    'Consent.action': string;
+    /**
+     * The type of consent document, as a comma-serpareted list of coded values.
+     * Used for classifying the consent itself (e.g., for release of information).
+     * Derived from the `org.hl7.fhir.api.Consent.category` claim.
+     * Example claim: "LOINC|59284-0,LOINC|57016-8"
+     */
+    'Consent.category'?: string;
+    /**
+     * The subject of the consent.
+     * Derived from the `org.hl7.fhir.api.Consent.patient.identifier` claim.
+     */
+    'Consent.subject': string;
+    /**
+     * The identifier of the actor (jurisdiction, organization, professional) this rule applies to.
+     * This is the party whose access is being controlled.
+     * Derived from a claim like `org.hl7.fhir.api.Consent.actor.reference.identifier`.
+     * e.g., "urn:iso:3166-2:ES-CT", "did:web:hospital.example.com", "urn:email:dr-smith@example.com"
+     */
+    'Consent.actor-identifier': string;
+    /**
+     * The role of the actor this rule applies to.
+     * Derived from a claim like `org.hl7.fhir.api.Consent.actor.role`.
+     * e.g., "doctor", "nurse"
+     */
+    'Consent.actor-role': string;
+    /**
+     * The date the consent was granted (ISO 8601 Date).
+     * Derived from the `org.hl7.fhir.api.Consent.date` claim.
+     */
+    'Consent.date': string;
+    /**
+     * Start of the consent's validity period (ISO 8601 DateTime).
+     * Note: This is different from the date the consent was signed.
+     * Derived from the start of the `org.hl7.fhir.api.Consent.period` claim.
+     */
+    'Consent.period-start'?: string;
+    /**
+     * End of the consent's validity period (ISO 8601 DateTime).
+     * Derived from the end of the `org.hl7.fhir.api.Consent.period` claim.
+     */
+    'Consent.period-end'?: string;
+    /** Timeframe of the governed data; distinct from Consent validity. */
+    'Consent.data-period-start'?: string;
+    'Consent.data-period-end'?: string;
+    /** R5 grantor, grantee, workflow manager and enforcement controller references. */
+    'Consent.grantor'?: string;
+    'Consent.grantee'?: string;
+    'Consent.manager'?: string;
+    'Consent.controller'?: string;
+    /**
+     * The party to whom the consent is granted.
+     * Use both 'Consent.actor-identifier' and 'Consent.actor-role' instead.
+     * Derived from the `org.hl7.fhir.api.Consent.grantee` claim.
+     */
+    /**
+     * The DID of the entity (person or system) that verified the consent.
+     * Derived from the `org.hl7.fhir.api.Consent.verified-by` claim.
+     */
+    'Consent.verified-by'?: string;
+    /**
+     * The date the consent was verified (ISO 8601 DateTime).
+     * Derived from the `org.hl7.fhir.api.Consent.verified-date` claim.
+     */
+    'Consent.verified-date'?: string;
+    /**
+     * The purpose of use for this rule.
+     * Derived from the `org.hl7.fhir.api.Consent.purpose` claim.
+     * e.g., "ETREAT", "CAREMGT"
+     */
+    'Consent.purpose': string;
+    /**
+     * The original Consent resource ID for auditing.
+     * Derived from the `org.hl7.fhir.api.Consent.identifier` claim.
+     */
+    'Consent.identifier': string;
+    /** Governed FHIR resource types and security/content classifications. */
+    'Consent.resource-type'?: string;
+    'Consent.security-label'?: string;
+    'Consent.document-type'?: string;
+    'Consent.provision-code'?: string;
+    'Consent.contained-reference-list'?: string;
+    'Consent.contained-resource-list'?: string;
+    'Consent.contained-documents'?: string;
+    'Consent.attachment-content-ids'?: string;
+    'Consent.attachment-contenttype'?: string;
+    'Consent.attachment-data'?: string;
+    'Consent.attachment-id'?: string;
+}

package/dist/claims/consent-claims.js

@@ -0,0 +1,74 @@
+// src/models/consent-rule.ts
+export var ClaimConsent;
+(function (ClaimConsent) {
+    ClaimConsent["decision"] = "Consent.decision";
+    ClaimConsent["status"] = "Consent.status";
+    ClaimConsent["action"] = "Consent.action";
+    ClaimConsent["category"] = "Consent.category";
+    ClaimConsent["categoryText"] = "Consent.category-text";
+    ClaimConsent["categoryDisplay"] = "Consent.category-display";
+    ClaimConsent["resourceType"] = "Consent.resource-type";
+    ClaimConsent["subject"] = "Consent.subject";
+    ClaimConsent["patient"] = "Consent.patient";
+    ClaimConsent["actorIdentifier"] = "Consent.actor-identifier";
+    ClaimConsent["actorRole"] = "Consent.actor-role";
+    ClaimConsent["date"] = "Consent.date";
+    ClaimConsent["periodStart"] = "Consent.period-start";
+    ClaimConsent["periodEnd"] = "Consent.period-end";
+    ClaimConsent["dataPeriodStart"] = "Consent.data-period-start";
+    ClaimConsent["dataPeriodEnd"] = "Consent.data-period-end";
+    ClaimConsent["grantor"] = "Consent.grantor";
+    ClaimConsent["grantee"] = "Consent.grantee";
+    ClaimConsent["manager"] = "Consent.manager";
+    ClaimConsent["controller"] = "Consent.controller";
+    ClaimConsent["verifiedBy"] = "Consent.verified-by";
+    ClaimConsent["verifiedDate"] = "Consent.verified-date";
+    ClaimConsent["purpose"] = "Consent.purpose";
+    ClaimConsent["identifier"] = "Consent.identifier";
+    ClaimConsent["eventBasedOn"] = "Consent.event-basedon";
+    ClaimConsent["sourceReference"] = "Consent.source-reference";
+    ClaimConsent["scope"] = "Consent.scope";
+    ClaimConsent["scopeDisplay"] = "Consent.scope-display";
+    ClaimConsent["policyRule"] = "Consent.policy-rule";
+    ClaimConsent["provisionCode"] = "Consent.provision-code";
+    ClaimConsent["provisionCodeDisplay"] = "Consent.provision-code-display";
+    ClaimConsent["securityLabel"] = "Consent.security-label";
+    ClaimConsent["documentType"] = "Consent.document-type";
+    ClaimConsent["containedReferenceList"] = "Consent.contained-reference-list";
+    /**
+     * @deprecated Use `containedReferenceList`.
+     */
+    ClaimConsent["containedResourceList"] = "Consent.contained-resource-list";
+    /**
+     * @deprecated Use `containedReferenceList`.
+     */
+    ClaimConsent["containedDocuments"] = "Consent.contained-documents";
+    /**
+     * @deprecated Use `containedReferenceList`.
+     */
+    ClaimConsent["attachmentContentIds"] = "Consent.attachment-content-ids";
+    ClaimConsent["attachmentContentType"] = "Consent.attachment-contenttype";
+    ClaimConsent["attachmentData"] = "Consent.attachment-data";
+    ClaimConsent["attachmentId"] = "Consent.attachment-id";
+})(ClaimConsent || (ClaimConsent = {}));
+/** Canonical resource-catalog name used consistently by the package. */
+export const ConsentClaim = ClaimConsent;
+export const ConsentDecisions = Object.freeze({
+    Permit: 'permit',
+    Deny: 'deny',
+});
+/**
+ * Canonical FHIR R5 Consent lifecycle states.
+ *
+ * `draft` is the only state used for a professional permission request. A
+ * draft is carried to the controller for review and must never participate in
+ * authorization evaluation. Only `active` consent rules can grant access.
+ */
+export const ConsentStatuses = Object.freeze({
+    Draft: 'draft',
+    Active: 'active',
+    Inactive: 'inactive',
+    NotDone: 'not-done',
+    EnteredInError: 'entered-in-error',
+    Unknown: 'unknown',
+});

package/dist/claims/coverage-claims.d.ts

@@ -0,0 +1,16 @@
+import type { ClaimSpec } from './claim-types.js';
+export declare const CoverageClaim: {
+    readonly Identifier: "Coverage.identifier";
+    readonly Status: "Coverage.status";
+    readonly Type: "Coverage.type";
+    readonly PolicyHolder: "Coverage.policy-holder";
+    readonly Subscriber: "Coverage.subscriber";
+    readonly Beneficiary: "Coverage.beneficiary";
+    readonly Relationship: "Coverage.relationship";
+    readonly PeriodStart: "Coverage.period-start";
+    readonly PeriodEnd: "Coverage.period-end";
+    readonly Payor: "Coverage.payor";
+    readonly Class: "Coverage.class";
+};
+export type CoverageClaimKey = typeof CoverageClaim[keyof typeof CoverageClaim];
+export declare const CoverageClaimSpecs: ClaimSpec[];

package/dist/claims/coverage-claims.js

@@ -0,0 +1,28 @@
+// Copyright 2026 Conéctate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+// File: src/models/interoperable-claims/coverage-claims.ts
+export const CoverageClaim = {
+    Identifier: 'Coverage.identifier',
+    Status: 'Coverage.status',
+    Type: 'Coverage.type',
+    PolicyHolder: 'Coverage.policy-holder',
+    Subscriber: 'Coverage.subscriber',
+    Beneficiary: 'Coverage.beneficiary',
+    Relationship: 'Coverage.relationship',
+    PeriodStart: 'Coverage.period-start',
+    PeriodEnd: 'Coverage.period-end',
+    Payor: 'Coverage.payor',
+    Class: 'Coverage.class',
+};
+export const CoverageClaimSpecs = [
+    { key: CoverageClaim.Identifier, meaning: 'Business identifier.', example: 'cov-001' },
+    { key: CoverageClaim.Status, meaning: 'Coverage status.', example: 'active' },
+    { key: CoverageClaim.Type, meaning: 'Coverage type token.', example: 'http://terminology.hl7.org/CodeSystem/v3-ActCode|EHCPOL' },
+    { key: CoverageClaim.PolicyHolder, meaning: 'Policy holder reference.', example: 'RelatedPerson/rel-1' },
+    { key: CoverageClaim.Subscriber, meaning: 'Subscriber reference.', example: 'RelatedPerson/rel-1' },
+    { key: CoverageClaim.Beneficiary, meaning: 'Beneficiary reference.', example: 'did:web:patient.example.org' },
+    { key: CoverageClaim.Relationship, meaning: 'Relationship token.', example: 'http://terminology.hl7.org/CodeSystem/subscriber-relationship|self' },
+    { key: CoverageClaim.PeriodStart, meaning: 'Coverage start.', example: '2026-01-01' },
+    { key: CoverageClaim.PeriodEnd, meaning: 'Coverage end.', example: '2026-12-31' },
+    { key: CoverageClaim.Payor, meaning: 'Payor references (CSV).', example: 'Organization/payer-1' },
+    { key: CoverageClaim.Class, meaning: 'Coverage class values (CSV).', example: 'group|G-001,plan|P-001' },
+];

package/dist/claims/device-claims.d.ts

@@ -0,0 +1,20 @@
+import type { ClaimSpec } from './claim-types.js';
+export declare const DeviceClaim: {
+    readonly DeviceName: "Device.device-name";
+    readonly Identifier: "Device.identifier";
+    readonly Location: "Device.location";
+    readonly Manufacturer: "Device.manufacturer";
+    readonly Model: "Device.model";
+    readonly Organization: "Device.organization";
+    readonly Patient: "Device.patient";
+    readonly SerialNumber: "Device.serial-number";
+    readonly Status: "Device.status";
+    readonly Type: "Device.type";
+    readonly TypeText: "Device.type-text";
+    readonly TypeDisplay: "Device.type-display";
+    readonly UdiCarrier: "Device.udi-carrier";
+    readonly Url: "Device.url";
+    readonly Note: "Device.note";
+};
+export type DeviceClaimKey = typeof DeviceClaim[keyof typeof DeviceClaim];
+export declare const DeviceClaimSpecs: ClaimSpec[];

package/dist/claims/device-claims.js

@@ -0,0 +1,36 @@
+// Copyright 2026 Conéctate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+// File: src/models/interoperable-claims/device-claims.ts
+export const DeviceClaim = {
+    DeviceName: 'Device.device-name',
+    Identifier: 'Device.identifier',
+    Location: 'Device.location',
+    Manufacturer: 'Device.manufacturer',
+    Model: 'Device.model',
+    Organization: 'Device.organization',
+    Patient: 'Device.patient',
+    SerialNumber: 'Device.serial-number',
+    Status: 'Device.status',
+    Type: 'Device.type',
+    TypeText: 'Device.type-text',
+    TypeDisplay: 'Device.type-display',
+    UdiCarrier: 'Device.udi-carrier',
+    Url: 'Device.url',
+    Note: 'Device.note',
+};
+export const DeviceClaimSpecs = [
+    { key: DeviceClaim.DeviceName, meaning: 'Human-readable device name.', example: 'Insulin pump' },
+    { key: DeviceClaim.Identifier, meaning: 'Business identifier.', example: 'device-001' },
+    { key: DeviceClaim.Location, meaning: 'Location reference.', example: 'Location/loc-1' },
+    { key: DeviceClaim.Manufacturer, meaning: 'Manufacturer name.', example: 'Medtronic' },
+    { key: DeviceClaim.Model, meaning: 'Model number or name.', example: 'MiniMed 780G' },
+    { key: DeviceClaim.Organization, meaning: 'Owning organization reference.', example: 'Organization/org-1' },
+    { key: DeviceClaim.Patient, meaning: 'Patient reference.', example: 'did:web:patient.example.org' },
+    { key: DeviceClaim.SerialNumber, meaning: 'Serial number.', example: 'SN-12345' },
+    { key: DeviceClaim.Status, meaning: 'Device status.', example: 'active' },
+    { key: DeviceClaim.Type, meaning: 'Device type token.', example: 'http://snomed.info/sct|706172005' },
+    { key: DeviceClaim.TypeText, meaning: 'Local-language device type label.', example: 'Bomba de insulina' },
+    { key: DeviceClaim.TypeDisplay, meaning: 'Canonical/international device type display.', example: 'Insulin pump' },
+    { key: DeviceClaim.UdiCarrier, meaning: 'UDI carrier string.', example: '(01)09504000059118(17)220101(10)ABCD1234' },
+    { key: DeviceClaim.Url, meaning: 'Canonical URL.', example: 'https://device.example.org/catalogue/123' },
+    { key: DeviceClaim.Note, meaning: 'Clinical note text.', example: 'Patient-owned continuous glucose monitor.' },
+];

package/dist/claims/device-use-statement-claims.d.ts

@@ -0,0 +1,17 @@
+import type { ClaimSpec } from './claim-types.js';
+export declare const DeviceUseStatementClaim: {
+    readonly Identifier: "DeviceUseStatement.identifier";
+    readonly Subject: "DeviceUseStatement.subject";
+    readonly Status: "DeviceUseStatement.status";
+    readonly Device: "DeviceUseStatement.device";
+    readonly DeviceDisplay: "DeviceUseStatement.device-display";
+    readonly RecordedOn: "DeviceUseStatement.recorded-on";
+    /** @deprecated Read-only key from historical persisted rows. */
+    readonly RecordedOnLegacy: "DeviceUseStatement.recordedon";
+    readonly TimingDateTime: "DeviceUseStatement.timing-datetime";
+    readonly TimingAbsentReason: "DeviceUseStatement.timing-absent-reason";
+    readonly ReasonCode: "DeviceUseStatement.reason-code";
+    readonly Source: "DeviceUseStatement.source";
+};
+export type DeviceUseStatementClaimKey = typeof DeviceUseStatementClaim[keyof typeof DeviceUseStatementClaim];
+export declare const DeviceUseStatementClaimSpecs: ClaimSpec[];

package/dist/claims/device-use-statement-claims.js

@@ -0,0 +1,28 @@
+// Copyright 2026 Conéctate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+// File: src/models/interoperable-claims/device-use-statement-claims.ts
+// Always create JSDoc, do not use strings inline in keys nor values, use types instead, and reuse the data test examples.
+export const DeviceUseStatementClaim = {
+    Identifier: 'DeviceUseStatement.identifier',
+    Subject: 'DeviceUseStatement.subject',
+    Status: 'DeviceUseStatement.status',
+    Device: 'DeviceUseStatement.device',
+    DeviceDisplay: 'DeviceUseStatement.device-display',
+    RecordedOn: 'DeviceUseStatement.recorded-on',
+    /** @deprecated Read-only key from historical persisted rows. */
+    RecordedOnLegacy: 'DeviceUseStatement.recordedon',
+    TimingDateTime: 'DeviceUseStatement.timing-datetime',
+    TimingAbsentReason: 'DeviceUseStatement.timing-absent-reason',
+    ReasonCode: 'DeviceUseStatement.reason-code',
+    Source: 'DeviceUseStatement.source',
+};
+export const DeviceUseStatementClaimSpecs = [
+    { key: DeviceUseStatementClaim.Identifier, meaning: 'Business identifier for device-use record.', example: 'DUS-0001' },
+    { key: DeviceUseStatementClaim.Subject, meaning: 'Patient subject reference.', example: 'Patient/pat-123' },
+    { key: DeviceUseStatementClaim.Status, meaning: 'Use statement status.', example: 'active' },
+    { key: DeviceUseStatementClaim.Device, meaning: 'Device reference.', example: 'Device/dev-777' },
+    { key: DeviceUseStatementClaim.DeviceDisplay, meaning: 'Human-readable device name accompanying the reference.', example: 'Hip prosthesis' },
+    { key: DeviceUseStatementClaim.RecordedOn, meaning: 'Record creation date/time.', example: '2026-03-01T12:00:00Z' },
+    { key: DeviceUseStatementClaim.TimingDateTime, meaning: 'When the use happened.', example: '2026-03-01T08:00:00Z' },
+    { key: DeviceUseStatementClaim.ReasonCode, meaning: 'Reason code for use.', example: 'http://snomed.info/sct|182840001' },
+    { key: DeviceUseStatementClaim.Source, meaning: 'Source actor reference.', example: 'Practitioner/prac-8' },
+];

package/dist/claims/diagnostic-report-claims.d.ts

@@ -0,0 +1,109 @@
+import type { ClaimSpec } from './claim-types.js';
+export declare const DiagnosticReportClaim: {
+    readonly BasedOn: "DiagnosticReport.based-on";
+    readonly Category: "DiagnosticReport.category";
+    readonly Code: "DiagnosticReport.code";
+    readonly CodeText: "DiagnosticReport.code-text";
+    readonly CodeTextLocal: "DiagnosticReport.code-text";
+    readonly CodeDisplay: "DiagnosticReport.code-display";
+    readonly Date: "DiagnosticReport.date";
+    readonly Encounter: "DiagnosticReport.encounter";
+    readonly Identifier: "DiagnosticReport.identifier";
+    readonly Media: "DiagnosticReport.media";
+    readonly Patient: "DiagnosticReport.patient";
+    readonly Performer: "DiagnosticReport.performer";
+    readonly Result: "DiagnosticReport.result";
+    readonly ResultsInterpreter: "DiagnosticReport.results-interpreter";
+    readonly Specimen: "DiagnosticReport.specimen";
+    readonly Status: "DiagnosticReport.status";
+    readonly Subject: "DiagnosticReport.subject";
+    readonly PresentedFormContentType: "DiagnosticReport.presented-form-contenttype";
+    readonly PresentedFormData: "DiagnosticReport.presented-form-data";
+    readonly PresentedFormUrl: "DiagnosticReport.presented-form-url";
+    /**
+     * Canonical CSV/list of related contained resource references or identifiers.
+     */
+    readonly ContainedReferenceList: "DiagnosticReport.contained-reference-list";
+    /**
+     * @deprecated Use `ContainedReferenceList`.
+     */
+    readonly ContainedResourceList: "DiagnosticReport.contained-resource-list";
+    /**
+     * @deprecated Use `ContainedReferenceList`.
+     */
+    readonly ContainedDocuments: "DiagnosticReport.contained-documents";
+};
+/**
+ * TODO(ips-next):
+ * Add resource-level claim helpers in `src/utils/claims-helpers-diagnostic-report.ts`
+ * following the same contract already used by Consent/Medication/Condition/Allergy:
+ * - `getDiagnosticReportClaimList(...)`
+ * - `setDiagnosticReportClaimList(...)`
+ * - `addDiagnosticReportClaimList(...)`
+ * - `removeDiagnosticReportClaimList(...)`
+ * - focused helpers for:
+ *   - `get/set/add/removeDiagnosticReportResultList`
+ *   - `get/set/add/removeDiagnosticReportPerformerList`
+ *   - `get/set/add/removeDiagnosticReportSpecimenList`
+ *   - `get/set/add/removeDiagnosticReportContainedResourceReferences`
+ *   - `get/setDiagnosticReportPresentedFormContentType`
+ *   - `get/setDiagnosticReportPresentedFormData`
+ *   - `get/setDiagnosticReportPresentedFormUrl`
+ *
+ * Keep naming aligned with canonical FHIR search parameter names
+ * (lowercase with `-`) and reuse the existing `SearchParamNames` + contextualized
+ * claim-key mapping pattern.
+ *
+ * This file is intentionally type-first only for now so GW Core and
+ * `common-utils` can already exercise the rest of the bundle workflow without
+ * committing to the DiagnosticReport editing surface yet.
+ */
+export type DiagnosticReportClaimKey = typeof DiagnosticReportClaim[keyof typeof DiagnosticReportClaim];
+export declare const DiagnosticReportClaimSpecs: ClaimSpec[];
+export declare const DiagnosticReportSearchParamNames: {
+    readonly BasedOn: "based-on";
+    readonly Category: "category";
+    readonly Code: "code";
+    readonly Date: "date";
+    readonly Encounter: "encounter";
+    readonly Identifier: "identifier";
+    readonly Media: "media";
+    readonly Patient: "patient";
+    readonly Performer: "performer";
+    readonly Result: "result";
+    readonly ResultsInterpreter: "results-interpreter";
+    readonly Specimen: "specimen";
+    readonly Status: "status";
+    readonly Subject: "subject";
+};
+export type DiagnosticReportSearchParamName = typeof DiagnosticReportSearchParamNames[keyof typeof DiagnosticReportSearchParamNames];
+export declare enum DiagnosticReportClaimsFhirApi {
+    BasedOn = "org.hl7.fhir.api.DiagnosticReport.based-on",
+    Category = "org.hl7.fhir.api.DiagnosticReport.category",
+    Code = "org.hl7.fhir.api.DiagnosticReport.code",
+    Date = "org.hl7.fhir.api.DiagnosticReport.date",
+    Encounter = "org.hl7.fhir.api.DiagnosticReport.encounter",
+    Identifier = "org.hl7.fhir.api.DiagnosticReport.identifier",
+    Media = "org.hl7.fhir.api.DiagnosticReport.media",
+    Patient = "org.hl7.fhir.api.DiagnosticReport.patient",
+    Performer = "org.hl7.fhir.api.DiagnosticReport.performer",
+    Result = "org.hl7.fhir.api.DiagnosticReport.result",
+    ResultsInterpreter = "org.hl7.fhir.api.DiagnosticReport.results-interpreter",
+    Specimen = "org.hl7.fhir.api.DiagnosticReport.specimen",
+    Status = "org.hl7.fhir.api.DiagnosticReport.status",
+    Subject = "org.hl7.fhir.api.DiagnosticReport.subject"
+}
+export declare const DiagnosticReportSearchParamToClaimKey: Record<DiagnosticReportSearchParamName, DiagnosticReportClaimsFhirApi>;
+/**
+ * TODO(ips-next):
+ * Add `DiagnosticReportClaimsFhirApiExtended` only if/when the bundle editor
+ * needs operational flat fields beyond the official search parameter surface.
+ *
+ * Do not invent camelCase names. Prefer official FHIR search parameter names
+ * or explicit attachment aliases such as `presented-form-*` and
+ * `contained-reference-list`.
+ *
+ * Keep `DiagnosticReport` paused at the typing/mapping layer until:
+ * 1. `claims-helpers-diagnostic-report.ts` exists
+ * 2. GW Core readers/tests consume the same shared claim keys
+ */

package/dist/claims/diagnostic-report-claims.js

@@ -0,0 +1,120 @@
+// Copyright 2026 Conéctate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+// File: src/models/interoperable-claims/diagnostic-report-claims.ts
+export const DiagnosticReportClaim = {
+    BasedOn: 'DiagnosticReport.based-on',
+    Category: 'DiagnosticReport.category',
+    Code: 'DiagnosticReport.code',
+    CodeText: 'DiagnosticReport.code-text',
+    CodeTextLocal: 'DiagnosticReport.code-text',
+    CodeDisplay: 'DiagnosticReport.code-display',
+    Date: 'DiagnosticReport.date',
+    Encounter: 'DiagnosticReport.encounter',
+    Identifier: 'DiagnosticReport.identifier',
+    Media: 'DiagnosticReport.media',
+    Patient: 'DiagnosticReport.patient',
+    Performer: 'DiagnosticReport.performer',
+    Result: 'DiagnosticReport.result',
+    ResultsInterpreter: 'DiagnosticReport.results-interpreter',
+    Specimen: 'DiagnosticReport.specimen',
+    Status: 'DiagnosticReport.status',
+    Subject: 'DiagnosticReport.subject',
+    PresentedFormContentType: 'DiagnosticReport.presented-form-contenttype',
+    PresentedFormData: 'DiagnosticReport.presented-form-data',
+    PresentedFormUrl: 'DiagnosticReport.presented-form-url',
+    /**
+     * Canonical CSV/list of related contained resource references or identifiers.
+     */
+    ContainedReferenceList: 'DiagnosticReport.contained-reference-list',
+    /**
+     * @deprecated Use `ContainedReferenceList`.
+     */
+    ContainedResourceList: 'DiagnosticReport.contained-resource-list',
+    /**
+     * @deprecated Use `ContainedReferenceList`.
+     */
+    ContainedDocuments: 'DiagnosticReport.contained-documents',
+};
+export const DiagnosticReportClaimSpecs = [
+    { key: DiagnosticReportClaim.BasedOn, meaning: 'Request or order that originated the report.', example: 'ServiceRequest/sr-1' },
+    { key: DiagnosticReportClaim.Category, meaning: 'Diagnostic service section/category.', example: 'http://terminology.hl7.org/CodeSystem/v2-0074|LAB' },
+    { key: DiagnosticReportClaim.Code, meaning: 'Main diagnostic report code.', example: 'http://loinc.org|58410-2' },
+    { key: DiagnosticReportClaim.CodeText, meaning: 'Local-language report name matching resource language.', example: 'Hemograma completo' },
+    { key: DiagnosticReportClaim.CodeDisplay, meaning: 'English/international terminology display.', example: 'Complete blood count panel' },
+    { key: DiagnosticReportClaim.Date, meaning: 'Report issuance date/time.', example: '2026-06-12T10:00:00Z' },
+    { key: DiagnosticReportClaim.Encounter, meaning: 'Encounter reference.', example: 'Encounter/enc-1' },
+    { key: DiagnosticReportClaim.Identifier, meaning: 'Business identifier for the report.', example: 'diag-report-001' },
+    { key: DiagnosticReportClaim.Media, meaning: 'Linked media reference list (comma-separeted).', example: 'Media/media-1' },
+    { key: DiagnosticReportClaim.Patient, meaning: 'Patient reference.', example: 'did:web:patient.example.org' },
+    { key: DiagnosticReportClaim.Performer, meaning: 'Performer reference.', example: 'did:web:lab.example.org:system:lisin' },
+    { key: DiagnosticReportClaim.Result, meaning: 'Observation/result reference.', example: 'Observation/obs-1' },
+    { key: DiagnosticReportClaim.ResultsInterpreter, meaning: 'Results interpreter reference.', example: 'Practitioner/prac-1' },
+    { key: DiagnosticReportClaim.Specimen, meaning: 'Specimen reference list (comma-separared).', example: 'Specimen/spec-1' },
+    { key: DiagnosticReportClaim.Status, meaning: 'Diagnostic report status.', example: 'final' },
+    { key: DiagnosticReportClaim.Subject, meaning: 'Canonical subject reference.', example: 'did:web:patient.example.org' },
+    { key: DiagnosticReportClaim.PresentedFormContentType, meaning: 'FHIR presentedForm attachment content type.', example: 'application/pdf' },
+    { key: DiagnosticReportClaim.PresentedFormData, meaning: 'FHIR presentedForm inline base64 payload.', example: 'JVBERi0xLjc...' },
+    { key: DiagnosticReportClaim.PresentedFormUrl, meaning: 'FHIR presentedForm external URL.', example: 'https://example.org/report.pdf' },
+    { key: DiagnosticReportClaim.ContainedDocuments, meaning: 'CSV of linked DocumentReference identifiers stored in the same bundle.', example: 'docref-example-001,docref-example-002' },
+];
+export const DiagnosticReportSearchParamNames = {
+    BasedOn: 'based-on',
+    Category: 'category',
+    Code: 'code',
+    Date: 'date',
+    Encounter: 'encounter',
+    Identifier: 'identifier',
+    Media: 'media',
+    Patient: 'patient',
+    Performer: 'performer',
+    Result: 'result',
+    ResultsInterpreter: 'results-interpreter',
+    Specimen: 'specimen',
+    Status: 'status',
+    Subject: 'subject',
+};
+export var DiagnosticReportClaimsFhirApi;
+(function (DiagnosticReportClaimsFhirApi) {
+    DiagnosticReportClaimsFhirApi["BasedOn"] = "org.hl7.fhir.api.DiagnosticReport.based-on";
+    DiagnosticReportClaimsFhirApi["Category"] = "org.hl7.fhir.api.DiagnosticReport.category";
+    DiagnosticReportClaimsFhirApi["Code"] = "org.hl7.fhir.api.DiagnosticReport.code";
+    DiagnosticReportClaimsFhirApi["Date"] = "org.hl7.fhir.api.DiagnosticReport.date";
+    DiagnosticReportClaimsFhirApi["Encounter"] = "org.hl7.fhir.api.DiagnosticReport.encounter";
+    DiagnosticReportClaimsFhirApi["Identifier"] = "org.hl7.fhir.api.DiagnosticReport.identifier";
+    DiagnosticReportClaimsFhirApi["Media"] = "org.hl7.fhir.api.DiagnosticReport.media";
+    DiagnosticReportClaimsFhirApi["Patient"] = "org.hl7.fhir.api.DiagnosticReport.patient";
+    DiagnosticReportClaimsFhirApi["Performer"] = "org.hl7.fhir.api.DiagnosticReport.performer";
+    DiagnosticReportClaimsFhirApi["Result"] = "org.hl7.fhir.api.DiagnosticReport.result";
+    DiagnosticReportClaimsFhirApi["ResultsInterpreter"] = "org.hl7.fhir.api.DiagnosticReport.results-interpreter";
+    DiagnosticReportClaimsFhirApi["Specimen"] = "org.hl7.fhir.api.DiagnosticReport.specimen";
+    DiagnosticReportClaimsFhirApi["Status"] = "org.hl7.fhir.api.DiagnosticReport.status";
+    DiagnosticReportClaimsFhirApi["Subject"] = "org.hl7.fhir.api.DiagnosticReport.subject";
+})(DiagnosticReportClaimsFhirApi || (DiagnosticReportClaimsFhirApi = {}));
+export const DiagnosticReportSearchParamToClaimKey = {
+    [DiagnosticReportSearchParamNames.BasedOn]: DiagnosticReportClaimsFhirApi.BasedOn,
+    [DiagnosticReportSearchParamNames.Category]: DiagnosticReportClaimsFhirApi.Category,
+    [DiagnosticReportSearchParamNames.Code]: DiagnosticReportClaimsFhirApi.Code,
+    [DiagnosticReportSearchParamNames.Date]: DiagnosticReportClaimsFhirApi.Date,
+    [DiagnosticReportSearchParamNames.Encounter]: DiagnosticReportClaimsFhirApi.Encounter,
+    [DiagnosticReportSearchParamNames.Identifier]: DiagnosticReportClaimsFhirApi.Identifier,
+    [DiagnosticReportSearchParamNames.Media]: DiagnosticReportClaimsFhirApi.Media,
+    [DiagnosticReportSearchParamNames.Patient]: DiagnosticReportClaimsFhirApi.Patient,
+    [DiagnosticReportSearchParamNames.Performer]: DiagnosticReportClaimsFhirApi.Performer,
+    [DiagnosticReportSearchParamNames.Result]: DiagnosticReportClaimsFhirApi.Result,
+    [DiagnosticReportSearchParamNames.ResultsInterpreter]: DiagnosticReportClaimsFhirApi.ResultsInterpreter,
+    [DiagnosticReportSearchParamNames.Specimen]: DiagnosticReportClaimsFhirApi.Specimen,
+    [DiagnosticReportSearchParamNames.Status]: DiagnosticReportClaimsFhirApi.Status,
+    [DiagnosticReportSearchParamNames.Subject]: DiagnosticReportClaimsFhirApi.Subject,
+};
+/**
+ * TODO(ips-next):
+ * Add `DiagnosticReportClaimsFhirApiExtended` only if/when the bundle editor
+ * needs operational flat fields beyond the official search parameter surface.
+ *
+ * Do not invent camelCase names. Prefer official FHIR search parameter names
+ * or explicit attachment aliases such as `presented-form-*` and
+ * `contained-reference-list`.
+ *
+ * Keep `DiagnosticReport` paused at the typing/mapping layer until:
+ * 1. `claims-helpers-diagnostic-report.ts` exists
+ * 2. GW Core readers/tests consume the same shared claim keys
+ */