gdc-common-utils-ts 2.0.18 → 2.2.2

package/dist/utils/communication-attached-bundle-session.d.ts

@@ -1,123 +1,9 @@
-import { type HealthcareCanonicalSectionFamily, type HealthcareActorRoleDescriptor, type HealthcareRoleFamily, type HealthcareSectionDescriptor } from '../constants/healthcare';
-import { type DataspaceSector } from '../constants/sectors';
-import { BundleEntry, BundleJsonApi, BundleRequest } from '../models/bundle';
+import { BundleEntry, BundleJsonApi } from '../models/bundle';
+import { type ActiveEntrySelection, type AddContainedDocumentToActiveEntryInput, type CommunicationAttachedBundleSessionOptions, type UpsertClaimsResourceEntryInput, type UpsertEntryInput } from '../models/communication-attached-bundle-session';
 import { type BundleResourceIdFilters } from './bundle-query';
-import { type ConsentDuplicateRuleConflict } from './consent-duplicate-rules.js';
-import { type MedicationStatementClaimsFlat } from '../models/interoperable-claims/medication-statement-claims';
-export type CommunicationAttachedBundleSessionMode = 'strict' | 'normalize';
-export type CommunicationAttachedBundleSessionOptions = Readonly<{
-    communicationClaims?: Record<string, unknown>;
-    initialBundle?: BundleJsonApi<BundleEntry>;
-    mode?: CommunicationAttachedBundleSessionMode;
-}>;
-export type ActiveEntrySelection = Readonly<{
-    index?: number;
-    fullUrl?: string;
-}>;
-export type UpsertEntryInput = Readonly<{
-    resourceType: string;
-    claims: Record<string, unknown>;
-    type?: string;
-    fullUrl?: string;
-    request?: BundleRequest;
-}>;
-export type AddContainedDocumentToActiveEntryInput = Readonly<{
-    identifier?: string;
-    fullUrl?: string;
-    claims?: Record<string, unknown>;
-    attachmentContentType?: string;
-    attachmentDataBase64?: string;
-    attachmentUrl?: string;
-    description?: string;
-    date?: string;
-    language?: string;
-}>;
-export declare const ConsentEditorTargetKinds: Readonly<{
-    readonly Section: "section";
-    readonly ResourceType: "resource-type";
-}>;
-export type ConsentEditorTargetKind = typeof ConsentEditorTargetKinds[keyof typeof ConsentEditorTargetKinds];
-export declare const ConsentEditorScopeCodes: Readonly<{
-    readonly Search: "s";
-    readonly Read: "r";
-    readonly Create: "c";
-    readonly Update: "u";
-    readonly Delete: "d";
-}>;
-export type ConsentEditorScopeCode = typeof ConsentEditorScopeCodes[keyof typeof ConsentEditorScopeCodes];
-export type ConsentEditorClassifiedScope = Readonly<{
-    code: ConsentEditorScopeCode;
-    display?: string;
-}>;
-export type ConsentEditorClassifiedTarget = Readonly<{
-    target: Readonly<{
-        kind: ConsentEditorTargetKind;
-        code: string;
-        display?: string;
-        sectionFamily?: HealthcareCanonicalSectionFamily;
-    }>;
-    scopes: readonly ConsentEditorClassifiedScope[];
-}>;
-export type ConsentEditorClassifiedActorRole = Readonly<{
-    codingSystem: string;
-    code: string;
-    display?: string;
-}>;
-export type ConsentEditorClassifiedRole = Readonly<{
-    family?: HealthcareRoleFamily;
-    codingSystem: string;
-    code: string;
-    display?: string;
-    definition?: string;
-}>;
-export type ConsentEditorClassifiedRoles = Readonly<{
-    professional: readonly ConsentEditorClassifiedRole[];
-    relationship: readonly ConsentEditorClassifiedRole[];
-    legalRepresentative: readonly ConsentEditorClassifiedRole[];
-    other: readonly ConsentEditorClassifiedRole[];
-}>;
-export type ConsentEditorClassifiedDepartment = Readonly<{
-    code: string;
-    display?: string;
-}>;
-export type ConsentEditorClassifiedLocation = Readonly<{
-    code: string;
-    display?: string;
-}>;
-export type ConsentEditorClassifiedOrganization = Readonly<{
-    domain: string;
-    display?: string;
-    departments: readonly ConsentEditorClassifiedDepartment[];
-    locations: readonly ConsentEditorClassifiedLocation[];
-}>;
-export type ConsentEditorClassifiedJurisdiction = Readonly<{
-    code: string;
-    display?: string;
-}>;
-export type ConsentEditorClassifiedUser = Readonly<{
-    email?: string;
-    phone?: string;
-    role?: ConsentEditorClassifiedActorRole;
-}>;
-export type ConsentEditorClassifiedActors = Readonly<{
-    jurisdictions: readonly ConsentEditorClassifiedJurisdiction[];
-    organizations: readonly ConsentEditorClassifiedOrganization[];
-    users: readonly ConsentEditorClassifiedUser[];
-}>;
-export type ConsentEditorClassifiedPurpose = Readonly<{
-    code: string;
-    display?: string;
-}>;
-export type ConsentViewModel = Readonly<{
-    fullUrl?: string;
-    identifier: string;
-    subject: string;
-    decision: string;
-    classifiedActors: ConsentEditorClassifiedActors;
-    classifiedRoles: ConsentEditorClassifiedRoles;
-    classifiedPurposes: readonly ConsentEditorClassifiedPurpose[];
-    classifiedTargets: readonly ConsentEditorClassifiedTarget[];
-}>;
+import type { MedicationStatementClaimsFlat } from '../models/interoperable-claims/medication-statement-claims';
+export { BundleEntryClaimsContext, CommunicationClaimsContext, CommunicationAttachmentClaimsContext, ConsentEditorScopeCodes, ConsentEditorTargetKinds, } from '../models/communication-attached-bundle-session';
+export type { ActiveEntrySelection, AddContainedDocumentToActiveEntryInput, CommunicationAttachedBundleSessionMode, CommunicationAttachedBundleSessionOptions, ConsentEditorClassifiedActors, ConsentEditorClassifiedPurpose, ConsentEditorClassifiedRole, ConsentEditorClassifiedRoles, ConsentEditorClassifiedTarget, ConsentEditorScopeCode, ConsentEditorTargetKind, ConsentViewModel, UpsertClaimsResourceEntryInput, UpsertEntryInput, } from '../models/communication-attached-bundle-session';
 /**
  * Communication editing session with bundle-in-memory as source of truth.
  *
@@ -138,12 +24,40 @@ export declare class CommunicationAttachedBundleSession {
     constructor(options?: CommunicationAttachedBundleSessionOptions);
     /** Returns a deep copy of communication claims. */
     getCommunicationClaims(): Record<string, unknown>;
+    /** Returns the canonical outer Communication identifier. */
+    getCommunicationIdentifier(): string;
+    /** Sets the canonical outer Communication identifier. */
+    setCommunicationIdentifier(value: unknown): this;
+    /** Returns the canonical outer Communication subject. */
+    getCommunicationSubject(): string;
+    /** Sets the canonical outer Communication subject. */
+    setCommunicationSubject(value: unknown): this;
+    /** Returns the canonical outer Communication categories. */
+    getCommunicationCategoryList(): string[];
+    /** Replaces the canonical outer Communication categories. */
+    setCommunicationCategory(value: string | readonly string[]): this;
+    /** Returns the canonical outer Communication topic. */
+    getCommunicationTopic(): string;
+    /** Sets the canonical outer Communication topic. */
+    setCommunicationTopic(value: unknown): this;
+    /** Returns the canonical outer Communication text. */
+    getCommunicationText(): string;
+    /** Sets the canonical outer Communication text. */
+    setCommunicationText(value: unknown): this;
     /** Returns a deep copy of the current in-memory bundle. */
     getBundleInMemory(): BundleJsonApi<BundleEntry>;
+    /** Replaces the attached clinical bundle and resyncs the outer Communication attachment. */
+    setAttachedBundle(bundle: BundleJsonApi<BundleEntry>): this;
+    /** Alias of `getBundleInMemory()` with communication wording. */
+    getAttachedBundle(): BundleJsonApi<BundleEntry>;
     /** Returns the active entry index, or null when no entry is selected. */
     getActiveEntryIndex(): number | null;
+    /** Returns the active entry position, or null when no entry is selected. */
+    getActiveEntryPosition(): number | null;
     /** Alias of `getActiveEntryIndex()` with entry-selection wording. */
     getSelectedEntryIndex(): number | null;
+    /** Alias of `getActiveEntryPosition()` with entry-selection wording. */
+    getSelectedEntryPosition(): number | null;
     /** Returns a deep copy of the active entry when selected. */
     getActiveEntry(): BundleEntry | null;
     /** Alias of `getActiveEntry()` with entry-selection wording. */
@@ -164,7 +78,7 @@ export declare class CommunicationAttachedBundleSession {
     addActiveEntryClaim(key: string, value: unknown): this;
     /** Removes one claim from the currently selected active entry and syncs the bundle attachment. */
     removeActiveEntryClaim(key: string): this;
-    /** Selects an active entry by index or fullUrl. */
+    /** Selects an active entry by position or fullUrl. */
     selectActiveEntry(selection: ActiveEntrySelection): this;
     /** Alias of `selectActiveEntry()` with entry-selection wording. */
     selectEntry(selection: ActiveEntrySelection): this;
@@ -175,91 +89,89 @@ export declare class CommunicationAttachedBundleSession {
      * Matching priority: `fullUrl` if present, then resource claim identifier.
      */
     upsertActiveEntry(input: UpsertEntryInput): this;
+    /**
+     * Reusable resource-typed wrapper around `upsertActiveEntry(...)`.
+     *
+     * Resource-specific helpers should delegate here instead of re-embedding the
+     * same `resourceType/fullUrl/type/request/claims` plumbing.
+     */
+    private upsertActiveClaimsResourceEntry;
     /**
      * Consent-first helper for developer onboarding.
      *
      * Expected keys should come from `ClaimConsent` in caller code.
      */
-    upsertActiveConsentEntry(input: Readonly<{
-        claims: Record<string, unknown>;
-        fullUrl?: string;
-        type?: string;
-        request?: BundleRequest;
-    }>): this;
+    upsertActiveConsentEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
     /**
      * MedicationStatement helper for IPS-in-Communication use cases.
      *
      * Expected keys should come from MedicationStatement claims constants.
      */
-    upsertActiveMedicationStatementEntry(input: Readonly<{
-        claims: MedicationStatementClaimsFlat | Record<string, unknown>;
-        fullUrl?: string;
-        type?: string;
-        request?: BundleRequest;
-    }>): this;
+    upsertActiveMedicationStatementEntry(input: UpsertClaimsResourceEntryInput<MedicationStatementClaimsFlat | Record<string, unknown>>): this;
     /**
      * DocumentReference helper for bundle-contained attachments linked from
-     * other clinical resources through `*.contained-documents`.
+     * other clinical resources through `*.contained-reference-list`
+     * (with `*.contained-documents` kept as legacy compatibility alias).
      */
-    upsertActiveDocumentReferenceEntry(input: Readonly<{
-        claims: Record<string, unknown>;
-        fullUrl?: string;
-        type?: string;
-        request?: BundleRequest;
-    }>): this;
+    upsertActiveDocumentReferenceEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
     /**
      * Condition helper for IPS-in-Communication use cases.
      *
      * Expected keys should come from Condition claims constants.
      */
-    upsertActiveConditionEntry(input: Readonly<{
-        claims: Record<string, unknown>;
-        fullUrl?: string;
-        type?: string;
-        request?: BundleRequest;
-    }>): this;
+    upsertActiveConditionEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /**
+     * Appointment helper for schedule/event flows carried inside Communication.
+     *
+     * Expected keys should come from Appointment claims constants.
+     */
+    upsertActiveAppointmentEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
     /**
      * Observation helper for IPS-style and sectioned bundle authoring.
      *
      * Expected keys should come from Observation claims constants.
      */
-    upsertActiveObservationEntry(input: Readonly<{
-        claims: Record<string, unknown>;
-        fullUrl?: string;
-        type?: string;
-        request?: BundleRequest;
-    }>): this;
+    upsertActiveObservationEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
     /**
      * AllergyIntolerance helper for IPS-in-Communication use cases.
      *
      * Expected keys should come from AllergyIntolerance claims constants.
      */
-    upsertActiveAllergyIntoleranceEntry(input: Readonly<{
-        claims: Record<string, unknown>;
-        fullUrl?: string;
-        type?: string;
-        request?: BundleRequest;
-    }>): this;
-    /**
-     * TODO(ips-next):
-     * Add `upsertActiveDiagnosticReportEntry(...)` once the shared claim helpers
-     * for `DiagnosticReport` are in place.
-     *
-     * Expected shape should mirror the existing resource helpers:
-     * - `claims` authored with `@context = org.hl7.fhir.api`
-     * - matching priority by `DiagnosticReport.identifier`
-     * - support for linked `DocumentReference` ids through
-     *   `DiagnosticReport.contained-documents`
-     *
-     * Intentionally not implemented in this pass:
-     * - IPS authoring already works for the currently documented resources
-     * - GW Core can already consume bundle-contained `DocumentReference` rows
-     * - adding the DiagnosticReport editing surface now would expand the IPS
-     *   contract further than intended for this release slice
-     */
+    upsertActiveAllergyIntoleranceEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** DiagnosticReport helper for report-in-Communication use cases. */
+    upsertActiveDiagnosticReportEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** CarePlan helper for plan-in-Communication use cases. */
+    upsertActiveCarePlanEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** Procedure helper for procedure-in-Communication use cases. */
+    upsertActiveProcedureEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** Immunization helper for immunization-in-Communication use cases. */
+    upsertActiveImmunizationEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** Encounter helper for visit/event flows carried inside Communication. */
+    upsertActiveEncounterEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** Device helper for device catalog or implant/device context flows. */
+    upsertActiveDeviceEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** DeviceUseStatement helper for device usage flows carried inside Communication. */
+    upsertActiveDeviceUseStatementEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** Flag helper for alert/banner flows carried inside Communication. */
+    upsertActiveFlagEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** ClinicalImpression helper for assessment flows carried inside Communication. */
+    upsertActiveClinicalImpressionEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** Coverage helper for entitlement/insurance flows carried inside Communication. */
+    upsertActiveCoverageEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** AppointmentResponse helper for schedule-response flows carried inside Communication. */
+    upsertActiveAppointmentResponseEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** Composition helper for document-structure flows carried inside Communication. */
+    upsertActiveCompositionEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** Location helper for schedule/place flows carried inside Communication. */
+    upsertActiveLocationEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** Organization helper for provider/payer/department flows carried inside Communication. */
+    upsertActiveOrganizationEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
+    /** RelatedPerson helper for relationship/member flows carried inside Communication. */
+    upsertActiveRelatedPersonEntry(input: UpsertClaimsResourceEntryInput<Record<string, unknown>>): this;
     /**
      * Creates or updates a linked `DocumentReference` entry and stores its
-     * identifier under the active resource `*.contained-documents` claim.
+     * identifier/reference under the active resource
+     * `*.contained-reference-list` claim.
      */
     addContainedDocumentToActiveEntry(input: AddContainedDocumentToActiveEntryInput): this;
     /**
@@ -299,132 +211,3 @@ export declare class CommunicationAttachedBundleSession {
     private resolveEntryCanonicalIdValue;
     private assertEntryIndex;
 }
-/**
- * High-level consent-access editor alias for onboarding and app-facing code.
- *
- * This keeps the business intent explicit for developers who are editing
- * Consent access rules inside a Communication-carried bundle and should not
- * need to start from the lower-level generic session name.
- */
-export declare class ConsentAccessEditor extends CommunicationAttachedBundleSession {
-    /** Returns duplicate atomic consent-rule conflicts across the current bundle. */
-    getConsentRuleDuplicateConflicts(): ConsentDuplicateRuleConflict[];
-    /** Returns duplicate atomic consent-rule conflicts affecting the active Consent entry. */
-    getActiveConsentRuleDuplicateConflicts(): ConsentDuplicateRuleConflict[];
-    /** Returns one frontend-facing editable view model for the active Consent entry. */
-    getConsentViewModel(): ConsentViewModel;
-    /** Applies one frontend-facing editable view model back into the active Consent entry. */
-    applyConsentViewModel(viewModel: ConsentViewModel): this;
-    /** Returns the canonical permit/deny decision from the active Consent entry. */
-    getDecision(): string;
-    /**
-     * @deprecated Use `getDecision()`.
-     * Kept as a compatibility alias for the previous helper name.
-     */
-    getPermit(): string;
-    /**
-     * Returns target classification derived from the current consent claim
-     * contract without altering or extending the persisted claim keys.
-     */
-    getTargetsClassified(): ConsentEditorClassifiedTarget[];
-    /** Returns the catalog of core-section targets available for picker UIs. */
-    getCoreSectionOptions(): readonly ConsentEditorClassifiedTarget[];
-    /** Returns the core-section catalog keyed by LOINC code. */
-    getCoreSectionCatalog(): Readonly<Record<string, HealthcareSectionDescriptor>>;
-    /** Returns the catalog of kind-of-document targets available for picker UIs. */
-    getKindOfDocumentOptions(): readonly ConsentEditorClassifiedTarget[];
-    /** Returns the kind-of-document catalog keyed by LOINC code. */
-    getKindOfDocumentCatalog(): Readonly<Record<string, HealthcareSectionDescriptor>>;
-    /** Returns the catalog of type-of-service targets available for picker UIs. */
-    getTypeOfServiceOptions(): readonly ConsentEditorClassifiedTarget[];
-    /** Returns the type-of-service catalog keyed by LOINC code. */
-    getTypeOfServiceCatalog(): Readonly<Record<string, HealthcareSectionDescriptor>>;
-    /** Returns the catalog of subject-matter-domain targets available for picker UIs. */
-    getSubjectMatterDomainOptions(): readonly ConsentEditorClassifiedTarget[];
-    /** Returns the subject-matter-domain catalog keyed by LOINC code. */
-    getSubjectMatterDomainCatalog(): Readonly<Record<string, HealthcareSectionDescriptor>>;
-    /** Returns resource-type targets currently known in the active consent entry. */
-    getResourceTypeOptions(): readonly ConsentEditorClassifiedTarget[];
-    /** Returns the supported resource-type catalog. */
-    getResourceTypeCatalog(): readonly string[];
-    /** Returns the available professional roles for one sector. */
-    getAvailableProfessionalRolesBySector(sector: DataspaceSector): Readonly<Record<string, HealthcareActorRoleDescriptor>>;
-    /** Returns the available HL7 relationship roles. */
-    getAvailableRelationshipRoles(): Readonly<Record<string, HealthcareActorRoleDescriptor>>;
-    /** Returns selected core-section claim values. */
-    getSelectedCoreSections(): string[];
-    /** Returns selected kind-of-document claim values. */
-    getSelectedKindOfDocuments(): string[];
-    /** Returns selected type-of-service claim values. */
-    getSelectedTypeOfServices(): string[];
-    /** Returns selected subject-matter-domain claim values. */
-    getSelectedSubjectMatterDomains(): string[];
-    /** Returns selected resource-type claim values. */
-    getSelectedResourceTypes(): string[];
-    /** Replaces selected core-section claim values while preserving other families. */
-    setSelectedCoreSections(codes: readonly string[]): this;
-    /** Replaces selected kind-of-document claim values. */
-    setSelectedKindOfDocuments(codes: readonly string[]): this;
-    /** Replaces selected type-of-service claim values while preserving other families. */
-    setSelectedTypeOfServices(codes: readonly string[]): this;
-    /** Replaces selected subject-matter-domain claim values while preserving other families. */
-    setSelectedSubjectMatterDomains(codes: readonly string[]): this;
-    /** Replaces selected resource-type claim values. */
-    setSelectedResourceTypes(codes: readonly string[]): this;
-    /** Adds core-section claim values without removing other selected targets. */
-    addCoreSections(codes: readonly string[]): this;
-    /** Removes selected core-section claim values. */
-    removeCoreSections(codes: readonly string[]): this;
-    /** Adds kind-of-document claim values. */
-    addKindOfDocuments(codes: readonly string[]): this;
-    /** Removes kind-of-document claim values. */
-    removeKindOfDocuments(codes: readonly string[]): this;
-    /** Adds type-of-service claim values without removing other selected targets. */
-    addTypeOfServices(codes: readonly string[]): this;
-    /** Removes selected type-of-service claim values. */
-    removeTypeOfServices(codes: readonly string[]): this;
-    /** Adds subject-matter-domain claim values without removing other selected targets. */
-    addSubjectMatterDomains(codes: readonly string[]): this;
-    /** Removes selected subject-matter-domain claim values. */
-    removeSubjectMatterDomains(codes: readonly string[]): this;
-    /** Adds resource-type claim values. */
-    addResourceTypes(codes: readonly string[]): this;
-    /** Removes resource-type claim values. */
-    removeResourceTypes(codes: readonly string[]): this;
-    /** Returns purposes as explicit classified items. */
-    getPurposesClassified(): ConsentEditorClassifiedPurpose[];
-    /** Returns selected purpose claim values. */
-    getSelectedPurposes(): string[];
-    /** Replaces selected purpose claim values. */
-    setSelectedPurposes(codes: readonly string[]): this;
-    /** Adds purpose claim values. */
-    addPurposes(codes: readonly string[]): this;
-    /** Removes purpose claim values. */
-    removePurposes(codes: readonly string[]): this;
-    /** Returns selected actor roles as explicit classified items. */
-    getRolesClassified(): ConsentEditorClassifiedRoles;
-    /** Returns selected actor-role claim values. */
-    getSelectedRoles(): string[];
-    /** Replaces selected actor-role claim values. */
-    setSelectedRoles(codes: readonly string[]): this;
-    /** Adds actor-role claim values. */
-    addRoles(codes: readonly string[]): this;
-    /** Removes actor-role claim values. */
-    removeRoles(codes: readonly string[]): this;
-    /** Returns consent actors grouped by jurisdiction, organization, and user. */
-    getActorsClassified(): ConsentEditorClassifiedActors;
-    private getSelectedSectionCodesByFamily;
-    private setSelectedSectionCodesByFamily;
-    private addSectionCodesByFamily;
-    private removeSectionCodesByFamily;
-    private setActiveEntryClaimList;
-    private addActiveEntryClaimList;
-    private removeActiveEntryClaimList;
-}
-/**
- * High-level factory for consent-access editing.
- *
- * Prefer this name in onboarding docs when the developer intent is:
- * "edit a Consent access bundle carried by a Communication".
- */
-export declare function createConsentAccessEditor(options?: CommunicationAttachedBundleSessionOptions): ConsentAccessEditor;