gdc-common-utils-ts 1.0.7 → 1.0.8

package/dist/models/comm.d.ts

@@ -41,4 +41,4 @@ export interface CommMsgExtended extends DidCommPayload {
 /**
  * A type placeholder for a FHIR Communication resource.
  */
-export type FhirCommunication = any;
+export type { FhirCommunicationResource as FhirCommunication } from './fhir-documents';

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

@@ -0,0 +1,101 @@
+/**
+ * Minimal strict-FHIR typing for Composition, DocumentReference, and Communication.
+ * These interfaces intentionally cover the subset used by frontend/backend flows today.
+ */
+export type FhirReference = {
+    reference?: string;
+    type?: string;
+    display?: string;
+};
+export type FhirCoding = {
+    system?: string;
+    code?: string;
+    display?: string;
+};
+export type FhirCodeableConcept = {
+    coding?: FhirCoding[];
+    text?: string;
+};
+export type FhirAttachment = {
+    contentType?: string;
+    language?: string;
+    data?: string;
+    url?: string;
+    title?: string;
+    creation?: string;
+};
+export interface FhirCompositionResource {
+    resourceType: 'Composition';
+    id?: string;
+    status?: string;
+    type?: FhirCodeableConcept;
+    subject?: FhirReference;
+    date?: string;
+    author?: FhirReference[];
+    title?: string;
+    section?: Array<{
+        title?: string;
+        code?: FhirCodeableConcept;
+        text?: {
+            status?: string;
+            div?: string;
+        };
+        entry?: FhirReference[];
+    }>;
+}
+export interface FhirDocumentReferenceResource {
+    resourceType: 'DocumentReference';
+    id?: string;
+    status?: string;
+    identifier?: Array<{
+        system?: string;
+        value?: string;
+    }>;
+    type?: FhirCodeableConcept;
+    category?: FhirCodeableConcept[];
+    subject?: FhirReference;
+    date?: string;
+    author?: FhirReference[];
+    attester?: Array<{
+        mode?: string;
+        party?: FhirReference;
+        time?: string;
+    }>;
+    description?: string;
+    context?: {
+        encounter?: FhirReference[];
+        event?: FhirCodeableConcept[];
+        period?: {
+            start?: string;
+            end?: string;
+        };
+        related?: FhirReference[];
+    };
+    basedOn?: FhirReference[];
+    relatesTo?: Array<{
+        code?: string;
+        target?: FhirReference;
+    }>;
+    content?: Array<{
+        attachment?: FhirAttachment;
+        format?: FhirCoding;
+    }>;
+}
+export interface FhirCommunicationResource {
+    resourceType: 'Communication';
+    id?: string;
+    status?: string;
+    category?: FhirCodeableConcept[];
+    subject?: FhirReference;
+    recipient?: FhirReference[];
+    sender?: FhirReference;
+    sent?: string;
+    payload?: Array<{
+        contentAttachment?: FhirAttachment;
+        contentReference?: FhirReference;
+    }>;
+    partOf?: FhirReference[];
+    note?: Array<{
+        text?: string;
+    }>;
+}

package/dist/models/fhir-documents.js

@@ -0,0 +1,3 @@
+// Copyright 2026 Conéctate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+// File: src/models/fhir-documents.ts
+export {};

package/dist/models/index.d.ts

@@ -11,6 +11,8 @@ export * from './consent-rule';
 export * from './crypto';
 export * from './device-license';
 export * from './did';
+export * from './fhir-documents';
+export * from './interoperable-claims';
 export * from './indexing';
 export * from './issue';
 export * from './jsonapi';

package/dist/models/index.js

@@ -11,6 +11,8 @@ export * from './consent-rule.js';
 export * from './crypto.js';
 export * from './device-license.js';
 export * from './did.js';
+export * from './fhir-documents.js';
+export * from './interoperable-claims.js';
 export * from './indexing.js';
 export * from './issue.js';
 export * from './jsonapi.js';

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

@@ -0,0 +1,68 @@
+/**
+ * Canonical interoperable-claims keys used by claims-first payloads.
+ * Keep this separated from strict FHIR resource typings.
+ */
+export type ClaimSpec = {
+    key: string;
+    meaning: string;
+    example: string;
+};
+export declare const CompositionClaim: {
+    readonly Subject: "Composition.subject";
+    readonly Section: "Composition.section";
+    readonly Author: "Composition.author";
+    readonly Date: "Composition.date";
+    readonly Entry: "Composition.entry";
+    readonly Type: "Composition.type";
+    readonly Identifier: "Composition.identifier";
+    readonly Title: "Composition.title";
+};
+export declare const DocumentReferenceClaim: {
+    readonly Attester: "DocumentReference.attester";
+    readonly Author: "DocumentReference.author";
+    readonly BasedOn: "DocumentReference.basedOn";
+    readonly Category: "DocumentReference.category";
+    readonly ContentData: "DocumentReference.contentdata";
+    readonly ContentType: "DocumentReference.contenttype";
+    readonly Context: "DocumentReference.context";
+    readonly Creation: "DocumentReference.creation";
+    readonly Date: "DocumentReference.date";
+    readonly Description: "DocumentReference.description";
+    readonly EventCode: "DocumentReference.event-code";
+    readonly EventReference: "DocumentReference.event-reference";
+    readonly FormatUri: "DocumentReference.format-uri";
+    readonly Identifier: "DocumentReference.identifier";
+    readonly Language: "DocumentReference.language";
+    readonly Location: "DocumentReference.location";
+    readonly Modality: "DocumentReference.modality";
+    readonly RelatesTo: "DocumentReference.relatesto";
+    readonly Relation: "DocumentReference.relation";
+    readonly Subject: "DocumentReference.subject";
+    readonly Type: "DocumentReference.type";
+};
+export declare const CommunicationClaim: {
+    readonly Identifier: "Communication.identifier";
+    readonly Subject: "Communication.subject";
+    readonly Recipient: "Communication.recipient";
+    readonly Sender: "Communication.sender";
+    readonly Sent: "Communication.sent";
+    readonly Text: "Communication.text";
+    readonly ContentReference: "Communication.content-reference";
+    readonly ContentAttachmentData: "Communication.content-attachment-data";
+    readonly ContentAttachmentType: "Communication.content-attachment-type";
+    readonly ContentAttachmentTitle: "Communication.content-attachment-title";
+    readonly PartOf: "Communication.partOf";
+};
+export type CompositionClaimKey = typeof CompositionClaim[keyof typeof CompositionClaim];
+export type DocumentReferenceClaimKey = typeof DocumentReferenceClaim[keyof typeof DocumentReferenceClaim];
+export type CommunicationClaimKey = typeof CommunicationClaim[keyof typeof CommunicationClaim];
+/**
+ * Human-readable reference for UI/docs generators.
+ * This is intentionally claims-first metadata and not a FHIR structure.
+ */
+export declare const DocumentReferenceClaimSpecs: ClaimSpec[];
+/**
+ * Optional mapping helper when converting claims-first payloads to strict FHIR JSON.
+ * Not used as canonical claim naming.
+ */
+export declare const DocumentReferenceClaimToFhirPath: Record<string, string | string[]>;

package/dist/models/interoperable-claims.js

@@ -0,0 +1,105 @@
+// Copyright 2026 Conéctate Soluciones y Aplicaciones SL under the Apache License, Version 2.0.
+// File: src/models/interoperable-claims.ts
+export const CompositionClaim = {
+    Subject: 'Composition.subject',
+    Section: 'Composition.section',
+    Author: 'Composition.author',
+    Date: 'Composition.date',
+    Entry: 'Composition.entry',
+    Type: 'Composition.type',
+    Identifier: 'Composition.identifier',
+    Title: 'Composition.title',
+};
+export const DocumentReferenceClaim = {
+    Attester: 'DocumentReference.attester',
+    Author: 'DocumentReference.author',
+    BasedOn: 'DocumentReference.basedOn',
+    Category: 'DocumentReference.category',
+    ContentData: 'DocumentReference.contentdata',
+    ContentType: 'DocumentReference.contenttype',
+    Context: 'DocumentReference.context',
+    Creation: 'DocumentReference.creation',
+    Date: 'DocumentReference.date',
+    Description: 'DocumentReference.description',
+    EventCode: 'DocumentReference.event-code',
+    EventReference: 'DocumentReference.event-reference',
+    FormatUri: 'DocumentReference.format-uri',
+    Identifier: 'DocumentReference.identifier',
+    Language: 'DocumentReference.language',
+    Location: 'DocumentReference.location',
+    Modality: 'DocumentReference.modality',
+    RelatesTo: 'DocumentReference.relatesto',
+    Relation: 'DocumentReference.relation',
+    Subject: 'DocumentReference.subject',
+    Type: 'DocumentReference.type',
+};
+export const CommunicationClaim = {
+    Identifier: 'Communication.identifier',
+    Subject: 'Communication.subject',
+    Recipient: 'Communication.recipient',
+    Sender: 'Communication.sender',
+    Sent: 'Communication.sent',
+    Text: 'Communication.text',
+    ContentReference: 'Communication.content-reference',
+    ContentAttachmentData: 'Communication.content-attachment-data',
+    ContentAttachmentType: 'Communication.content-attachment-type',
+    ContentAttachmentTitle: 'Communication.content-attachment-title',
+    PartOf: 'Communication.partOf',
+};
+/**
+ * Human-readable reference for UI/docs generators.
+ * This is intentionally claims-first metadata and not a FHIR structure.
+ */
+export const DocumentReferenceClaimSpecs = [
+    { key: DocumentReferenceClaim.Attester, meaning: 'Attester value (DID or role: personal | professional | legal | official).', example: 'did:web:hospital.example.com:employee:adm-332' },
+    { key: DocumentReferenceClaim.Author, meaning: 'DID of the source author.', example: 'did:web:lab.example.com:system:lisin' },
+    { key: DocumentReferenceClaim.BasedOn, meaning: 'URL of the source FHIR resource.', example: 'https://ehr.example.com/fhir/ServiceRequest/sr-991' },
+    { key: DocumentReferenceClaim.Category, meaning: 'Higher-level document grouping.', example: 'http://hl7.org/fhir/ValueSet/document-classcodes|LP173418-7' },
+    { key: DocumentReferenceClaim.ContentData, meaning: 'Embedded attachment as base64.', example: 'JVBERi0xLjc...' },
+    { key: DocumentReferenceClaim.ContentType, meaning: 'Attachment MIME type.', example: 'application/pdf' },
+    { key: DocumentReferenceClaim.Context, meaning: 'Context such as Appointment | Encounter | EpisodeOfCare.', example: 'Encounter/enc-123' },
+    { key: DocumentReferenceClaim.Creation, meaning: 'When source information was created.', example: '2026-02-10T08:20:00Z' },
+    { key: DocumentReferenceClaim.Date, meaning: 'When this registration was attested.', example: '2026-02-10T10:05:33Z' },
+    { key: DocumentReferenceClaim.Description, meaning: 'Human-readable summary.', example: 'Vital signs report from home device' },
+    { key: DocumentReferenceClaim.EventCode, meaning: 'Main code for the source FHIR resource.', example: 'http://loinc.org|85354-9' },
+    { key: DocumentReferenceClaim.EventReference, meaning: 'URL of the source FHIR resource.', example: 'https://ehr.example.com/fhir/Observation/obs-778' },
+    { key: DocumentReferenceClaim.FormatUri, meaning: 'Attachment format URI.', example: 'urn:ihe:dent:PDF' },
+    { key: DocumentReferenceClaim.Identifier, meaning: 'Document identifier used for correlation.', example: 'docref-2026-00042' },
+    { key: DocumentReferenceClaim.Language, meaning: 'Language of attachment content.', example: 'en' },
+    { key: DocumentReferenceClaim.Location, meaning: 'Remote URL of attachment.', example: 'https://ehr.example.com/fhir/Binary/bin-123' },
+    { key: DocumentReferenceClaim.Modality, meaning: 'Imaging modality/equipment function.', example: 'http://dicom.nema.org/resources/ontology/DCM|CT' },
+    { key: DocumentReferenceClaim.RelatesTo, meaning: 'Reference to related/prior document.', example: 'DocumentReference/docref-00041' },
+    { key: DocumentReferenceClaim.Relation, meaning: 'Relation type to related document.', example: 'appends' },
+    { key: DocumentReferenceClaim.Subject, meaning: 'URN for the section in the individual index.', example: 'urn:uhix:section:vitals' },
+    { key: DocumentReferenceClaim.Type, meaning: 'Lower-level, sector-specific type.', example: 'http://hl7.org/fhir/ValueSet/c80-doc-typecodes|34133-9' },
+];
+/**
+ * Optional mapping helper when converting claims-first payloads to strict FHIR JSON.
+ * Not used as canonical claim naming.
+ */
+export const DocumentReferenceClaimToFhirPath = {
+    [DocumentReferenceClaim.Attester]: [
+        'DocumentReference.attester.party.reference',
+        'DocumentReference.attester.mode',
+    ],
+    [DocumentReferenceClaim.Author]: 'DocumentReference.author.reference',
+    [DocumentReferenceClaim.BasedOn]: 'DocumentReference.basedOn.reference',
+    [DocumentReferenceClaim.Category]: 'DocumentReference.category.coding',
+    [DocumentReferenceClaim.ContentData]: 'DocumentReference.content.attachment.data',
+    [DocumentReferenceClaim.ContentType]: 'DocumentReference.content.attachment.contentType',
+    [DocumentReferenceClaim.Context]: 'DocumentReference.context',
+    [DocumentReferenceClaim.Creation]: 'DocumentReference.content.attachment.creation',
+    [DocumentReferenceClaim.Date]: 'DocumentReference.date',
+    [DocumentReferenceClaim.Description]: 'DocumentReference.description',
+    [DocumentReferenceClaim.EventCode]: 'DocumentReference.context.event.coding',
+    [DocumentReferenceClaim.EventReference]: 'DocumentReference.context.related.reference',
+    [DocumentReferenceClaim.FormatUri]: 'DocumentReference.content.format.code',
+    [DocumentReferenceClaim.Identifier]: 'DocumentReference.identifier.value',
+    [DocumentReferenceClaim.Language]: 'DocumentReference.content.attachment.language',
+    [DocumentReferenceClaim.Location]: 'DocumentReference.content.attachment.url',
+    [DocumentReferenceClaim.Modality]: 'DocumentReference.modality',
+    [DocumentReferenceClaim.RelatesTo]: 'DocumentReference.relatesTo.target.reference',
+    [DocumentReferenceClaim.Relation]: 'DocumentReference.relatesTo.code',
+    [DocumentReferenceClaim.Subject]: 'DocumentReference.subject.reference',
+    [DocumentReferenceClaim.Type]: 'DocumentReference.type.coding',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdc-common-utils-ts",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "publishConfig": {
     "access": "public"
   },