gdc-common-utils-ts 1.14.4 → 1.14.9

package/dist/constants/communication.d.ts

@@ -2,27 +2,57 @@ export declare const HL7_COMMUNICATION_CATEGORY_SYSTEM: "http://terminology.hl7.
 export type CommunicationCategoryDescriptor = Readonly<{
     system: typeof HL7_COMMUNICATION_CATEGORY_SYSTEM;
     code: string;
+    attributeValue: string;
+    /**
+     * @deprecated Use `attributeValue`.
+     * Kept as compatibility alias because this token is a reusable attribute
+     * value, not a claim key/attribute name.
+     */
     claim: string;
 }>;
 export declare const CommunicationCategoryCodes: Readonly<{
     readonly Alert: Readonly<{
         system: typeof HL7_COMMUNICATION_CATEGORY_SYSTEM;
         code: string;
+        attributeValue: string;
+        /**
+         * @deprecated Use `attributeValue`.
+         * Kept as compatibility alias because this token is a reusable attribute
+         * value, not a claim key/attribute name.
+         */
         claim: string;
     }>;
     readonly Notification: Readonly<{
         system: typeof HL7_COMMUNICATION_CATEGORY_SYSTEM;
         code: string;
+        attributeValue: string;
+        /**
+         * @deprecated Use `attributeValue`.
+         * Kept as compatibility alias because this token is a reusable attribute
+         * value, not a claim key/attribute name.
+         */
         claim: string;
     }>;
     readonly Reminder: Readonly<{
         system: typeof HL7_COMMUNICATION_CATEGORY_SYSTEM;
         code: string;
+        attributeValue: string;
+        /**
+         * @deprecated Use `attributeValue`.
+         * Kept as compatibility alias because this token is a reusable attribute
+         * value, not a claim key/attribute name.
+         */
         claim: string;
     }>;
     readonly Instruction: Readonly<{
         system: typeof HL7_COMMUNICATION_CATEGORY_SYSTEM;
         code: string;
+        attributeValue: string;
+        /**
+         * @deprecated Use `attributeValue`.
+         * Kept as compatibility alias because this token is a reusable attribute
+         * value, not a claim key/attribute name.
+         */
         claim: string;
     }>;
 }>;

package/dist/constants/communication.js

@@ -1,9 +1,11 @@
 export const HL7_COMMUNICATION_CATEGORY_SYSTEM = 'http://terminology.hl7.org/CodeSystem/communication-category';
 function defineCommunicationCategory(code) {
+    const attributeValue = `${HL7_COMMUNICATION_CATEGORY_SYSTEM}|${code}`;
     return Object.freeze({
         system: HL7_COMMUNICATION_CATEGORY_SYSTEM,
         code,
-        claim: `${HL7_COMMUNICATION_CATEGORY_SYSTEM}|${code}`,
+        attributeValue,
+        claim: attributeValue,
     });
 }
 export const CommunicationCategoryCodes = Object.freeze({

package/dist/constants/healthcare.d.ts

@@ -13,6 +13,22 @@ export type HealthcareSectionDescriptor = Readonly<{
     i18nKey: `org.loinc.${string}`;
     titleEn?: string;
 }>;
+export type HealthcareDocumentTypeDescriptor = Readonly<{
+    id: string;
+    system: typeof LOINC_SYSTEM_URL;
+    code: string;
+    attributeValue: string;
+    titleEn?: string;
+}>;
+/**
+ * Canonical logical identifiers for document types backed by the LOINC
+ * ontology. These keys are stable SDK-facing names; the concrete LOINC token
+ * lives in `HealthcareDocumentTypes`.
+ */
+export declare const DocumentTypeLoincOntology: Readonly<{
+    readonly IPS: "IPS";
+}>;
+export type DocumentTypeLoincOntologyKey = typeof DocumentTypeLoincOntology[keyof typeof DocumentTypeLoincOntology];
 export declare const ISCO08_CODING_SYSTEM: "org.ilo.isco";
 export declare const ISCO08_I18N_NAMESPACE: "org.ilo.isco-08";
 export declare const HealthcareRoleFamilies: Readonly<{
@@ -194,6 +210,15 @@ export declare const HealthcareBasicSections: Readonly<{
         titleEn?: string;
     }>;
 }>;
+export declare const HealthcareDocumentTypes: Readonly<{
+    readonly IPS: Readonly<{
+        id: string;
+        system: typeof LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        titleEn?: string;
+    }>;
+}>;
 export declare const HealthcareAdditionalSections: Readonly<{
     AdvanceDirectives: Readonly<{
         system: typeof LOINC_SYSTEM_URL;
@@ -573,16 +598,36 @@ export declare const HealthcareConsentPurposes: Readonly<{
 }>;
 export declare const HealthcareActorRoles: Readonly<{
     readonly Controller: "ISCO-08|1120";
+    readonly MedicalDoctors: "ISCO-08|221";
+    readonly GeneralistMedicalPractitioner: "ISCO-08|2211";
+    readonly SpecialistMedicalPractitioner: "ISCO-08|2212";
+    /**
+     * @deprecated Use `GeneralistMedicalPractitioner`.
+     * Kept as compatibility alias for the historical SDK name.
+     */
     readonly Physician: "ISCO-08|2211";
     readonly NursingProfessional: "ISCO-08|2221";
+    readonly MidwiferyProfessional: "ISCO-08|2222";
     readonly Paramedic: "ISCO-08|2240";
     readonly Veterinarian: "ISCO-08|2250";
 }>;
 export declare const HealthcareActorRoleCodes: Readonly<{
     readonly Controller: "1120";
+    readonly MedicalDoctors: "221";
+    readonly GeneralistMedicalPractitioner: "2211";
+    readonly SpecialistMedicalPractitioner: "2212";
+    /**
+     * @deprecated Use `GeneralistMedicalPractitioner`.
+     * Kept as compatibility alias for the historical SDK name.
+     */
     readonly Physician: "2211";
+    /**
+     * @deprecated Use `MedicalDoctors`.
+     * Kept as compatibility alias for the historical SDK name.
+     */
     readonly PhysicianBroad: "221";
     readonly NursingProfessional: "2221";
+    readonly MidwiferyProfessional: "2222";
     readonly Paramedic: "2240";
     readonly Veterinarian: "2250";
 }>;
@@ -617,15 +662,15 @@ export declare const HealthcareRolesByFamily: Readonly<{
 }>;
 export declare const HealthcareAllRolesByClaim: Readonly<Record<string, HealthcareActorRoleDescriptor>>;
 export declare const HealthcareProfessionalRoleCodesBySector: Readonly<{
-    readonly "health-care": readonly ("1120" | "2211" | "2221" | "2240")[];
-    readonly "health-research": readonly ("1120" | "2211")[];
+    readonly "health-care": readonly ("1120" | "221" | "2211" | "2212" | "2221" | "2222" | "2240")[];
+    readonly "health-research": readonly ("1120" | "221" | "2211" | "2212")[];
     readonly "health-tech": readonly "1120"[];
     readonly "health-insurance": readonly "1120"[];
     readonly "animal-care": readonly ("1120" | "2250")[];
     readonly "animal-research": readonly ("1120" | "2250")[];
     readonly "animal-insurance": readonly "1120"[];
     readonly "animal-tech": readonly "1120"[];
-    readonly "onehealth-research": readonly ("1120" | "2211" | "2250")[];
+    readonly "onehealth-research": readonly ("1120" | "221" | "2211" | "2212" | "2250")[];
     readonly "onehealth-tech": readonly "1120"[];
 }>;
 export declare const HealthcareProfessionalRolesBySector: Readonly<{
@@ -720,10 +765,12 @@ export declare const HealthcareProfessionalRolesBySector: Readonly<{
         definition?: string;
     }>>>;
 }>;
+export declare const HealthcareProfessionalRolesBySectorAndClaim: Readonly<Record<DataspaceSector, Readonly<Record<string, HealthcareActorRoleDescriptor>>>>;
 export declare const HealthcareRolesBySector: Readonly<Record<DataspaceSector, Readonly<Record<HealthcareRoleFamily, Readonly<Record<string, HealthcareActorRoleDescriptor>>>>>>;
 export declare function getHealthcareRolesByFamily(family: HealthcareRoleFamily): Readonly<Record<string, HealthcareActorRoleDescriptor>>;
 export declare function getHealthcareRoleByClaim(claim: string): HealthcareActorRoleDescriptor | undefined;
 export declare function getHealthcareProfessionalRolesBySector(sector: DataspaceSector): Readonly<Record<string, HealthcareActorRoleDescriptor>>;
+export declare function getHealthcareProfessionalRolesBySectorAndClaim(sector: DataspaceSector): Readonly<Record<string, HealthcareActorRoleDescriptor>>;
 export declare function getHealthcareRolesBySector(sector: DataspaceSector, family: HealthcareRoleFamily): Readonly<Record<string, HealthcareActorRoleDescriptor>>;
 export declare const HealthcareConsentActions: Readonly<{
     readonly PatientSummaryDocument: string;

package/dist/constants/healthcare.js

@@ -2,6 +2,14 @@ import { LOINC_SYSTEM_URL, loincI18nKey } from '../models/clinical-sections.js';
 import { clinicalDocTypes, clinicalSectionAdditional, clinicalSectionsBase, } from '../models/clinical-sections.en.js';
 import { HL7_CODING_SYSTEM_PERSONAL_RELATIONSHIP, HL7_CODING_SYSTEM_V3_ROLE_CODE, HL7_PERSONAL_RELATIONSHIP_ROLES, HL7_V3_ROLE_CODE_LEGAL_REPRESENTATIVE, } from './hl7-roles.js';
 import { DataspaceSectors } from './sectors.js';
+/**
+ * Canonical logical identifiers for document types backed by the LOINC
+ * ontology. These keys are stable SDK-facing names; the concrete LOINC token
+ * lives in `HealthcareDocumentTypes`.
+ */
+export const DocumentTypeLoincOntology = Object.freeze({
+    IPS: 'IPS',
+});
 export const ISCO08_CODING_SYSTEM = 'org.ilo.isco';
 export const ISCO08_I18N_NAMESPACE = 'org.ilo.isco-08';
 export const HealthcareRoleFamilies = Object.freeze({
@@ -20,6 +28,15 @@ function defineSection(code, titleEn) {
         titleEn,
     });
 }
+function defineDocumentType(id, code, titleEn) {
+    return Object.freeze({
+        id,
+        system: LOINC_SYSTEM_URL,
+        code,
+        attributeValue: `${LOINC_SYSTEM_URL}|${code}`,
+        titleEn,
+    });
+}
 export const HealthcareSectionFamilies = Object.freeze({
     Summary: 'summary',
     Management: 'management',
@@ -42,6 +59,9 @@ export const HealthcareBasicSections = Object.freeze({
     SocialHistory: defineSection('29762-2'),
     VitalSigns: defineSection('8716-3'),
 });
+export const HealthcareDocumentTypes = Object.freeze({
+    [DocumentTypeLoincOntology.IPS]: defineDocumentType(DocumentTypeLoincOntology.IPS, '60591-5', 'International Patient Summary'),
+});
 export const HealthcareAdditionalSections = Object.freeze({
     AdvanceDirectives: defineSection('42348-3'),
     DiagnosticImaging: defineSection('18726-0'),
@@ -89,16 +109,36 @@ export const HealthcareConsentPurposes = Object.freeze({
 });
 export const HealthcareActorRoles = Object.freeze({
     Controller: 'ISCO-08|1120',
+    MedicalDoctors: 'ISCO-08|221',
+    GeneralistMedicalPractitioner: 'ISCO-08|2211',
+    SpecialistMedicalPractitioner: 'ISCO-08|2212',
+    /**
+     * @deprecated Use `GeneralistMedicalPractitioner`.
+     * Kept as compatibility alias for the historical SDK name.
+     */
     Physician: 'ISCO-08|2211',
     NursingProfessional: 'ISCO-08|2221',
+    MidwiferyProfessional: 'ISCO-08|2222',
     Paramedic: 'ISCO-08|2240',
     Veterinarian: 'ISCO-08|2250',
 });
 export const HealthcareActorRoleCodes = Object.freeze({
     Controller: '1120',
+    MedicalDoctors: '221',
+    GeneralistMedicalPractitioner: '2211',
+    SpecialistMedicalPractitioner: '2212',
+    /**
+     * @deprecated Use `GeneralistMedicalPractitioner`.
+     * Kept as compatibility alias for the historical SDK name.
+     */
     Physician: '2211',
+    /**
+     * @deprecated Use `MedicalDoctors`.
+     * Kept as compatibility alias for the historical SDK name.
+     */
     PhysicianBroad: '221',
     NursingProfessional: '2221',
+    MidwiferyProfessional: '2222',
     Paramedic: '2240',
     Veterinarian: '2250',
 });
@@ -116,14 +156,36 @@ function buildProfessionalIscoRoles() {
             }),
         ],
         [
-            HealthcareActorRoleCodes.Physician,
+            HealthcareActorRoleCodes.MedicalDoctors,
+            Object.freeze({
+                family: HealthcareRoleFamilies.ProfessionalOccupationIsco08,
+                codingSystem: ISCO08_CODING_SYSTEM,
+                code: HealthcareActorRoleCodes.MedicalDoctors,
+                claim: HealthcareActorRoles.MedicalDoctors,
+                i18nKey: `${ISCO08_I18N_NAMESPACE}.${HealthcareActorRoleCodes.MedicalDoctors}`,
+                titleEn: 'Medical doctors',
+            }),
+        ],
+        [
+            HealthcareActorRoleCodes.GeneralistMedicalPractitioner,
             Object.freeze({
                 family: HealthcareRoleFamilies.ProfessionalOccupationIsco08,
                 codingSystem: ISCO08_CODING_SYSTEM,
-                code: HealthcareActorRoleCodes.Physician,
-                claim: HealthcareActorRoles.Physician,
-                i18nKey: `${ISCO08_I18N_NAMESPACE}.${HealthcareActorRoleCodes.Physician}`,
-                titleEn: 'Physician',
+                code: HealthcareActorRoleCodes.GeneralistMedicalPractitioner,
+                claim: HealthcareActorRoles.GeneralistMedicalPractitioner,
+                i18nKey: `${ISCO08_I18N_NAMESPACE}.${HealthcareActorRoleCodes.GeneralistMedicalPractitioner}`,
+                titleEn: 'Generalist medical practitioner',
+            }),
+        ],
+        [
+            HealthcareActorRoleCodes.SpecialistMedicalPractitioner,
+            Object.freeze({
+                family: HealthcareRoleFamilies.ProfessionalOccupationIsco08,
+                codingSystem: ISCO08_CODING_SYSTEM,
+                code: HealthcareActorRoleCodes.SpecialistMedicalPractitioner,
+                claim: HealthcareActorRoles.SpecialistMedicalPractitioner,
+                i18nKey: `${ISCO08_I18N_NAMESPACE}.${HealthcareActorRoleCodes.SpecialistMedicalPractitioner}`,
+                titleEn: 'Specialist medical practitioner',
             }),
         ],
         [
@@ -137,6 +199,17 @@ function buildProfessionalIscoRoles() {
                 titleEn: 'Nursing professional',
             }),
         ],
+        [
+            HealthcareActorRoleCodes.MidwiferyProfessional,
+            Object.freeze({
+                family: HealthcareRoleFamilies.ProfessionalOccupationIsco08,
+                codingSystem: ISCO08_CODING_SYSTEM,
+                code: HealthcareActorRoleCodes.MidwiferyProfessional,
+                claim: HealthcareActorRoles.MidwiferyProfessional,
+                i18nKey: `${ISCO08_I18N_NAMESPACE}.${HealthcareActorRoleCodes.MidwiferyProfessional}`,
+                titleEn: 'Midwifery professional',
+            }),
+        ],
         [
             HealthcareActorRoleCodes.Paramedic,
             Object.freeze({
@@ -203,16 +276,24 @@ function pickRoleCatalogByCodes(catalog, codes) {
         .map((code) => [code, catalog[code]])
         .filter((entry) => Boolean(entry[1]))));
 }
+function reindexRoleCatalogByClaim(catalog) {
+    return Object.freeze(Object.fromEntries(Object.values(catalog).map((descriptor) => [descriptor.claim, descriptor])));
+}
 export const HealthcareProfessionalRoleCodesBySector = Object.freeze({
     [DataspaceSectors.HealthCare]: Object.freeze([
         HealthcareActorRoleCodes.Controller,
-        HealthcareActorRoleCodes.Physician,
+        HealthcareActorRoleCodes.MedicalDoctors,
+        HealthcareActorRoleCodes.GeneralistMedicalPractitioner,
+        HealthcareActorRoleCodes.SpecialistMedicalPractitioner,
         HealthcareActorRoleCodes.NursingProfessional,
+        HealthcareActorRoleCodes.MidwiferyProfessional,
         HealthcareActorRoleCodes.Paramedic,
     ]),
     [DataspaceSectors.HealthResearch]: Object.freeze([
         HealthcareActorRoleCodes.Controller,
-        HealthcareActorRoleCodes.Physician,
+        HealthcareActorRoleCodes.MedicalDoctors,
+        HealthcareActorRoleCodes.GeneralistMedicalPractitioner,
+        HealthcareActorRoleCodes.SpecialistMedicalPractitioner,
     ]),
     [DataspaceSectors.HealthTech]: Object.freeze([HealthcareActorRoleCodes.Controller]),
     [DataspaceSectors.HealthInsurance]: Object.freeze([HealthcareActorRoleCodes.Controller]),
@@ -228,7 +309,9 @@ export const HealthcareProfessionalRoleCodesBySector = Object.freeze({
     [DataspaceSectors.AnimalTech]: Object.freeze([HealthcareActorRoleCodes.Controller]),
     [DataspaceSectors.OneHealthResearch]: Object.freeze([
         HealthcareActorRoleCodes.Controller,
-        HealthcareActorRoleCodes.Physician,
+        HealthcareActorRoleCodes.MedicalDoctors,
+        HealthcareActorRoleCodes.GeneralistMedicalPractitioner,
+        HealthcareActorRoleCodes.SpecialistMedicalPractitioner,
         HealthcareActorRoleCodes.Veterinarian,
     ]),
     [DataspaceSectors.OneHealthTech]: Object.freeze([HealthcareActorRoleCodes.Controller]),
@@ -245,6 +328,10 @@ export const HealthcareProfessionalRolesBySector = Object.freeze({
     [DataspaceSectors.OneHealthResearch]: pickRoleCatalogByCodes(HealthcareRolesByFamily[HealthcareRoleFamilies.ProfessionalOccupationIsco08], HealthcareProfessionalRoleCodesBySector[DataspaceSectors.OneHealthResearch]),
     [DataspaceSectors.OneHealthTech]: pickRoleCatalogByCodes(HealthcareRolesByFamily[HealthcareRoleFamilies.ProfessionalOccupationIsco08], HealthcareProfessionalRoleCodesBySector[DataspaceSectors.OneHealthTech]),
 });
+export const HealthcareProfessionalRolesBySectorAndClaim = Object.freeze(Object.fromEntries(Object.values(DataspaceSectors).map((sector) => [
+    sector,
+    reindexRoleCatalogByClaim(HealthcareProfessionalRolesBySector[sector] || {}),
+])));
 export const HealthcareRolesBySector = Object.freeze(Object.fromEntries(Object.values(DataspaceSectors).map((sector) => [
     sector,
     Object.freeze({
@@ -262,6 +349,9 @@ export function getHealthcareRoleByClaim(claim) {
 export function getHealthcareProfessionalRolesBySector(sector) {
     return HealthcareProfessionalRolesBySector[sector] || {};
 }
+export function getHealthcareProfessionalRolesBySectorAndClaim(sector) {
+    return HealthcareProfessionalRolesBySectorAndClaim[sector] || {};
+}
 export function getHealthcareRolesBySector(sector, family) {
     return HealthcareRolesBySector[sector]?.[family] || {};
 }

package/dist/examples/communication-bundle-document-request.d.ts

@@ -0,0 +1,24 @@
+export declare function buildExampleIpsBundleDocumentRequestFromController(): Readonly<{
+    thid?: string;
+    body: Readonly<{
+        data: ReadonlyArray<{
+            type: string;
+            meta: {
+                claims: Record<string, unknown>;
+            };
+            resource: Record<string, unknown>;
+        }>;
+    }>;
+}>;
+export declare function buildExampleIpsBundleDocumentRequestFromDoctor(): Readonly<{
+    thid?: string;
+    body: Readonly<{
+        data: ReadonlyArray<{
+            type: string;
+            meta: {
+                claims: Record<string, unknown>;
+            };
+            resource: Record<string, unknown>;
+        }>;
+    }>;
+}>;

package/dist/examples/communication-bundle-document-request.js

@@ -0,0 +1,59 @@
+// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
+import { DocumentTypeLoincOntology, HealthcareActorRoles, HealthcareBasicSections } from '../constants/healthcare.js';
+import { CommunicationClaim } from '../models/interoperable-claims/communication-claims.js';
+import { BundleDocumentRequesterKinds, communication, buildBundleDocumentRequestCommunicationPayload, createSummaryOperationRequestParameters, createSummaryOperationRequestReferencePath, } from '../utils/communication-bundle-document-request.js';
+import { EXAMPLE_EMAIL_CONTROLLER_INDIVIDUAL, EXAMPLE_EMAIL_PROFESSIONAL, EXAMPLE_SUBJECT_DID, } from './shared.js';
+export function buildExampleIpsBundleDocumentRequestFromController() {
+    const summaryOperationRequestParameters = createSummaryOperationRequestParameters(EXAMPLE_SUBJECT_DID);
+    const summaryOperationRequestReferencePath = createSummaryOperationRequestReferencePath(summaryOperationRequestParameters);
+    const claims = communication.newSearchWithReferencePath({
+        subjectDid: EXAMPLE_SUBJECT_DID,
+        sender: EXAMPLE_EMAIL_CONTROLLER_INDIVIDUAL,
+        requesterKind: BundleDocumentRequesterKinds.Controller,
+        requesterIdentifier: EXAMPLE_EMAIL_CONTROLLER_INDIVIDUAL,
+        requesterRole: HealthcareActorRoles.Controller,
+        documentType: DocumentTypeLoincOntology.IPS,
+        summaryOperationRequestReferencePath,
+    });
+    return buildBundleDocumentRequestCommunicationPayload({
+        subjectDid: EXAMPLE_SUBJECT_DID,
+        sender: EXAMPLE_EMAIL_CONTROLLER_INDIVIDUAL,
+        requesterKind: BundleDocumentRequesterKinds.Controller,
+        requesterIdentifier: EXAMPLE_EMAIL_CONTROLLER_INDIVIDUAL,
+        requesterRole: HealthcareActorRoles.Controller,
+        documentType: DocumentTypeLoincOntology.IPS,
+        text: String(claims[CommunicationClaim.Text] || ''),
+        noteText: String(claims[CommunicationClaim.NoteText] || ''),
+        summaryOperationRequestReferencePath: String(claims[CommunicationClaim.ContentReference] || ''),
+    });
+}
+export function buildExampleIpsBundleDocumentRequestFromDoctor() {
+    const sections = [
+        HealthcareBasicSections.AllergiesAndIntolerances.attributeValue,
+        HealthcareBasicSections.HistoryOfMedicationUse.attributeValue,
+    ];
+    const summaryOperationRequestParameters = createSummaryOperationRequestParameters(EXAMPLE_SUBJECT_DID, sections);
+    const summaryOperationRequestReferencePath = createSummaryOperationRequestReferencePath(summaryOperationRequestParameters);
+    const claims = communication.newSearchWithReferencePath({
+        subjectDid: EXAMPLE_SUBJECT_DID,
+        sender: EXAMPLE_EMAIL_PROFESSIONAL,
+        requesterKind: BundleDocumentRequesterKinds.Employee,
+        requesterIdentifier: EXAMPLE_EMAIL_PROFESSIONAL,
+        requesterRole: HealthcareActorRoles.Physician,
+        documentType: DocumentTypeLoincOntology.IPS,
+        sections,
+        summaryOperationRequestReferencePath,
+    });
+    return buildBundleDocumentRequestCommunicationPayload({
+        subjectDid: EXAMPLE_SUBJECT_DID,
+        sender: EXAMPLE_EMAIL_PROFESSIONAL,
+        requesterKind: BundleDocumentRequesterKinds.Employee,
+        requesterIdentifier: EXAMPLE_EMAIL_PROFESSIONAL,
+        requesterRole: HealthcareActorRoles.Physician,
+        documentType: DocumentTypeLoincOntology.IPS,
+        sections,
+        text: String(claims[CommunicationClaim.Text] || ''),
+        noteText: String(claims[CommunicationClaim.NoteText] || ''),
+        summaryOperationRequestReferencePath: String(claims[CommunicationClaim.ContentReference] || ''),
+    });
+}

package/dist/examples/communication-bundle-session.js

@@ -2,11 +2,11 @@
 // Always create JSDoc, do not use strings inline in keys nor values, use types instead, and reuse the data test examples.
 import { HealthcareBasicSections } from '../constants/healthcare.js';
 import { CommunicationCategoryCodes } from '../constants/communication.js';
-import { ClaimConsent } from '../models/consent-rule.js';
-import { CommunicationClaim } from '../models/interoperable-claims/communication-claims.js';
 import { MedicationStatementClaim } from '../models/interoperable-claims/medication-statement-claims.js';
 import { EXAMPLE_COMMUNICATION_IDENTIFIER, EXAMPLE_CONSENT_DATE, EXAMPLE_CONSENT_IDENTIFIER, EXAMPLE_CONSENT_PERIOD_END, EXAMPLE_CONSENT_PERIOD_START, EXAMPLE_CONSENT_PURPOSE_TREATMENT, EXAMPLE_EMAIL_PROFESSIONAL, EXAMPLE_HEALTHCARE_ACTOR_ROLE_PHYSICIAN, EXAMPLE_IPS_BUNDLE_NOTE_TEXT, EXAMPLE_MEDICATION_STATEMENT_IDENTIFIER, EXAMPLE_MEDICATION_STATEMENT_STATUS, EXAMPLE_MEDICATION_STATEMENT_TEXT, EXAMPLE_SUBJECT_DID, } from './shared.js';
 import { CommunicationBundleSession } from '../utils/communication-bundle-session.js';
+import { setCommunicationCategory, setCommunicationIdentifier, setCommunicationSubject, setCommunicationText, } from '../utils/communication-claim-helpers.js';
+import { setActorIdentifierList, setActorRoleList, setConsentDate, setConsentDecision, setConsentIdentifier, setConsentPeriodEnd, setConsentPeriodStart, setConsentSubject, setPurposeList, setSectionList, } from '../utils/consent-claim-helpers.js';
 /**
  * First developer use case:
  * - edit a Consent entry inside a Communication-attached Bundle
@@ -15,29 +15,29 @@ import { CommunicationBundleSession } from '../utils/communication-bundle-sessio
  * - release active entry memory when finished
  */
 export function buildConsentEditingCommunicationSessionExample() {
+    let communicationClaims = { '@context': 'org.hl7.fhir.r4' };
+    communicationClaims = setCommunicationIdentifier(communicationClaims, EXAMPLE_COMMUNICATION_IDENTIFIER);
+    communicationClaims = setCommunicationSubject(communicationClaims, EXAMPLE_SUBJECT_DID);
+    communicationClaims = setCommunicationCategory(communicationClaims, CommunicationCategoryCodes.Notification.attributeValue);
+    communicationClaims = setCommunicationText(communicationClaims, EXAMPLE_IPS_BUNDLE_NOTE_TEXT);
     const bundleEditor = new CommunicationBundleSession({
-        communicationClaims: {
-            '@context': 'org.hl7.fhir.r4',
-            [CommunicationClaim.Identifier]: EXAMPLE_COMMUNICATION_IDENTIFIER,
-            [CommunicationClaim.Subject]: EXAMPLE_SUBJECT_DID,
-            [CommunicationClaim.Category]: CommunicationCategoryCodes.Notification.claim,
-            [CommunicationClaim.Text]: EXAMPLE_IPS_BUNDLE_NOTE_TEXT,
-        },
+        communicationClaims,
     });
+    let consentClaims = { '@context': 'org.hl7.fhir.api' };
+    consentClaims = setConsentDecision(consentClaims, 'permit');
+    consentClaims = setConsentSubject(consentClaims, EXAMPLE_SUBJECT_DID);
+    consentClaims = setConsentIdentifier(consentClaims, EXAMPLE_CONSENT_IDENTIFIER);
+    consentClaims = setConsentDate(consentClaims, EXAMPLE_CONSENT_DATE);
+    consentClaims = setConsentPeriodStart(consentClaims, EXAMPLE_CONSENT_PERIOD_START);
+    consentClaims = setConsentPeriodEnd(consentClaims, EXAMPLE_CONSENT_PERIOD_END);
+    consentClaims = setPurposeList(consentClaims, [EXAMPLE_CONSENT_PURPOSE_TREATMENT]);
+    consentClaims = setSectionList(consentClaims, [
+        HealthcareBasicSections.AllergiesAndIntolerances.attributeValue,
+    ]);
+    consentClaims = setActorIdentifierList(consentClaims, [EXAMPLE_EMAIL_PROFESSIONAL]);
+    consentClaims = setActorRoleList(consentClaims, [EXAMPLE_HEALTHCARE_ACTOR_ROLE_PHYSICIAN]);
     bundleEditor.upsertActiveConsentEntry({
-        claims: {
-            '@context': 'org.hl7.fhir.api',
-            [ClaimConsent.decision]: 'permit',
-            [ClaimConsent.subject]: EXAMPLE_SUBJECT_DID,
-            [ClaimConsent.identifier]: EXAMPLE_CONSENT_IDENTIFIER,
-            [ClaimConsent.date]: EXAMPLE_CONSENT_DATE,
-            [ClaimConsent.periodStart]: EXAMPLE_CONSENT_PERIOD_START,
-            [ClaimConsent.periodEnd]: EXAMPLE_CONSENT_PERIOD_END,
-            [ClaimConsent.purpose]: EXAMPLE_CONSENT_PURPOSE_TREATMENT,
-            [ClaimConsent.action]: HealthcareBasicSections.AllergiesAndIntolerances.attributeValue,
-            [ClaimConsent.actorIdentifier]: EXAMPLE_EMAIL_PROFESSIONAL,
-            [ClaimConsent.actorRole]: EXAMPLE_HEALTHCARE_ACTOR_ROLE_PHYSICIAN,
-        },
+        claims: consentClaims,
         fullUrl: `urn:uuid:${EXAMPLE_CONSENT_IDENTIFIER}`,
     });
     bundleEditor.saveAndReleaseActiveEntry();
@@ -53,14 +53,13 @@ export function buildConsentEditingCommunicationSessionExample() {
  * - apply save/release lifecycle consistently
  */
 export function buildMedicationEditingCommunicationSessionExample() {
+    let communicationClaims = { '@context': 'org.hl7.fhir.r4' };
+    communicationClaims = setCommunicationIdentifier(communicationClaims, EXAMPLE_COMMUNICATION_IDENTIFIER);
+    communicationClaims = setCommunicationSubject(communicationClaims, EXAMPLE_SUBJECT_DID);
+    communicationClaims = setCommunicationCategory(communicationClaims, CommunicationCategoryCodes.Reminder.attributeValue);
+    communicationClaims = setCommunicationText(communicationClaims, EXAMPLE_IPS_BUNDLE_NOTE_TEXT);
     const bundleEditor = new CommunicationBundleSession({
-        communicationClaims: {
-            '@context': 'org.hl7.fhir.r4',
-            [CommunicationClaim.Identifier]: EXAMPLE_COMMUNICATION_IDENTIFIER,
-            [CommunicationClaim.Subject]: EXAMPLE_SUBJECT_DID,
-            [CommunicationClaim.Category]: CommunicationCategoryCodes.Reminder.claim,
-            [CommunicationClaim.Text]: EXAMPLE_IPS_BUNDLE_NOTE_TEXT,
-        },
+        communicationClaims,
     });
     bundleEditor.upsertActiveMedicationStatementEntry({
         claims: {

package/dist/examples/index.d.ts

@@ -12,4 +12,5 @@ export * from './lifecycle';
 export * from './api-flow-examples';
 export * from './contract-examples';
 export * from './communication-bundle-session';
+export * from './communication-bundle-document-request';
 export * from './ips-bundle';

package/dist/examples/index.js

@@ -12,4 +12,5 @@ export * from './lifecycle.js';
 export * from './api-flow-examples.js';
 export * from './contract-examples.js';
 export * from './communication-bundle-session.js';
+export * from './communication-bundle-document-request.js';
 export * from './ips-bundle.js';

package/dist/examples/shared.d.ts

@@ -40,6 +40,7 @@ export declare const EXAMPLE_DEFAULT_ICA_DID: "did:web:ica.example.org";
 export declare const EXAMPLE_HOSTING_OPERATOR_DID: "did:web:host.example.org";
 export declare const EXAMPLE_TENANT_SERVICE_DID: "did:web:provider.example.org";
 export declare const EXAMPLE_SECONDARY_TENANT_SERVICE_DID: "did:web:provider-b.example.org";
+export declare const EXAMPLE_INDEX_PROVIDER_SECTOR_DID_WEB: "did:web:provider.example.org:acme-id:cds-es:v1:health-care";
 export declare const EXAMPLE_HOSTING_OPERATOR_DSPACE_VERSION_URL: "https://host.example.org/host/cds-ES/v1/test/.well-known/dspace-version";
 export declare const EXAMPLE_HOSTING_OPERATOR_CATALOG_ARTIFACT_URL: "https://host.example.org/host/cds-ES/v1/test/dsp/catalog/dcat.json";
 /** @deprecated Use `EXAMPLE_HOSTING_OPERATOR_DSPACE_VERSION_URL`. */
@@ -72,12 +73,19 @@ export declare const EXAMPLE_CLINICAL_SECTION_HISTORY_MEDICATION: "LOINC|10160-0
 export declare const EXAMPLE_CLINICAL_SECTION_ALLERGIES: string;
 export declare const EXAMPLE_CLINICAL_CODE_PROBLEM: "LOINC|11450-4";
 export declare const EXAMPLE_CONSENT_DATE: "2026-05-20";
+/** @deprecated Use `ConsentDecisions.Permit`. */
+export declare const EXAMPLE_CONSENT_DECISION_PERMIT: "permit";
 export declare const EXAMPLE_CONSENT_PERIOD_END: "2026-05-01T00:00:00Z";
 export declare const EXAMPLE_CONSENT_PURPOSE_TREATMENT: "TREAT";
+export declare const EXAMPLE_CONSENT_UUID: "urn:uuid:consent-example-001";
 export declare const EXAMPLE_CONSENT_IDENTIFIER: "urn:uuid:consent-example-001";
+export declare const EXAMPLE_CONSENT_OPERATION_IDENTIFIER: "consent-operation-example-001";
+export declare const EXAMPLE_CONSENT_OPERATION_THREAD_ID: "thread-consent-example-001";
 export declare const EXAMPLE_CONSENT_PERIOD_START: "2026-05-20T00:00:00Z";
+export declare const EXAMPLE_COMMUNICATION_UUID: "urn:uuid:communication-example-001";
 export declare const EXAMPLE_COMMUNICATION_IDENTIFIER: "urn:uuid:communication-example-001";
 export declare const EXAMPLE_IPS_BUNDLE_NOTE_TEXT: "IPS ingestion request";
+export declare const EXAMPLE_MEDICATION_STATEMENT_UUID: "urn:uuid:medication-statement-example-001";
 export declare const EXAMPLE_MEDICATION_STATEMENT_IDENTIFIER: "urn:uuid:medication-statement-example-001";
 export declare const EXAMPLE_MEDICATION_STATEMENT_STATUS: "active";
 export declare const EXAMPLE_MEDICATION_STATEMENT_CODE: "http://www.nlm.nih.gov/research/umls/rxnorm|313782";
@@ -90,6 +98,20 @@ export declare const EXAMPLE_DOCUMENT_REFERENCE_DESCRIPTION: "Prescription PDF";
 export declare const EXAMPLE_DOCUMENT_REFERENCE_DATE: "2026-06-12T10:00:00Z";
 export declare const EXAMPLE_EMPLOYEE_ACTIVATION_CODE: "ACT-001";
 export declare const EXAMPLE_DEVICE_CLIENT_ID: "did:web:device-001";
+export declare const EXAMPLE_LIVE_GW_BASE_URL_LOCAL: "http://127.0.0.1:3000";
+export declare const EXAMPLE_LIVE_GW_BASE_URL_DOCKER: "http://127.0.0.1:8000";
+export declare const EXAMPLE_MEDICATION_DOSE_UNIT_MG: "mg";
+export declare const EXAMPLE_MEDICATION_TIMING_PERIOD_UNIT_HOURS: "h";
+export declare const EXAMPLE_MEDICATION_IBUPROFEN_TEXT: "Ibuprofen 400 mg";
+export declare const EXAMPLE_MEDICATION_IBUPROFEN_IDENTIFIER_PREFIX: "urn:uuid:med-ibuprofen";
+export declare const EXAMPLE_MEDICATION_IBUPROFEN_EFFECTIVE: "2026-06-01T08:00:00Z";
+export declare const EXAMPLE_MEDICATION_IBUPROFEN_NOTE: "Take every 8 hours as needed. Keep a 4 hour gap from paracetamol.";
+export declare const EXAMPLE_MEDICATION_PARACETAMOL_TEXT: "Paracetamol 600 mg";
+export declare const EXAMPLE_MEDICATION_PARACETAMOL_IDENTIFIER_PREFIX: "urn:uuid:med-paracetamol";
+export declare const EXAMPLE_MEDICATION_PARACETAMOL_EFFECTIVE: "2026-06-01T12:00:00Z";
+export declare const EXAMPLE_MEDICATION_PARACETAMOL_NOTE: "Take every 8 hours as needed. Keep a 4 hour gap from ibuprofen.";
+export declare const EXAMPLE_IPS_BUNDLE_REFERENCE_URL: "individual/org.hl7.fhir.r4/Bundle?type=document&composition.subject=did:web:api.acme.org:individual:123&composition.type=http://loinc.org|60591-5";
+export declare const EXAMPLE_IPS_BUNDLE_REFERENCE_ABSOLUTE_URL: "https://provider.example.org/acme-id/cds-ES/v1/health-care/individual/org.hl7.fhir.r4/Bundle?type=document&composition.subject=did:web:api.acme.org:individual:123&composition.type=http://loinc.org|60591-5";
 export type ExampleDateRange = Readonly<{
     start: string;
     end: string;
@@ -106,6 +128,19 @@ export type ExampleClinicalBundleSearchInput = Readonly<{
 export type ExampleLatestIpsSearchInput = Readonly<{
     subject: string;
 }>;
+export type ExampleLiveMedicationCase = Readonly<{
+    identifier: string;
+    effectiveDateTime: string;
+    text: string;
+    note: string;
+    doseQuantityValue: number;
+    doseQuantityUnit: string;
+    timingFrequency: number;
+    timingPeriod: number;
+    timingPeriodUnit: string;
+    dosageAsNeeded: boolean;
+    section: string;
+}>;
 export declare const EXAMPLE_CONTROLLER_SIGN_KEY: {
     readonly kid: "controller-es384-001";
     readonly kty: "EC";
@@ -217,6 +252,7 @@ export declare function buildExampleDocumentReferenceSearchPayload(subjectDid?:
     };
 };
 export declare function cloneExample<T>(value: T): T;
+export declare function buildExampleLiveMedicationCases(seed?: number): ExampleLiveMedicationCase[];
 export type ExampleHostedTenantRouteContext = Readonly<{
     alternateName: string;
     jurisdiction: string;