gdc-common-utils-ts 2.0.7 → 2.0.9

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

@@ -4,6 +4,8 @@ export const ProcedureClaim = {
     BasedOn: 'Procedure.based-on',
     BodySite: 'Procedure.body-site',
     Code: 'Procedure.code',
+    CodeText: 'Procedure.code-text',
+    CodeDisplay: 'Procedure.code-display',
     Date: 'Procedure.date',
     Encounter: 'Procedure.encounter',
     Identifier: 'Procedure.identifier',
@@ -23,6 +25,8 @@ export const ProcedureClaimSpecs = [
     { key: ProcedureClaim.BasedOn, meaning: 'Request or order reference.', example: 'ServiceRequest/sr-1' },
     { key: ProcedureClaim.BodySite, meaning: 'Body site token.', example: 'http://snomed.info/sct|66754008' },
     { key: ProcedureClaim.Code, meaning: 'Procedure code token.', example: 'http://snomed.info/sct|80146002' },
+    { key: ProcedureClaim.CodeText, meaning: 'Local-language procedure label used by forms/UI.', example: 'Apendicectomia' },
+    { key: ProcedureClaim.CodeDisplay, meaning: 'Canonical/international procedure display label.', example: 'Appendectomy' },
     { key: ProcedureClaim.Date, meaning: 'Performed date/time.', example: '2026-06-01T10:00:00Z' },
     { key: ProcedureClaim.Encounter, meaning: 'Encounter reference.', example: 'Encounter/enc-1' },
     { key: ProcedureClaim.Identifier, meaning: 'Business identifier.', example: 'procedure-001' },

package/dist/utils/bundle-editor.d.ts

@@ -7,6 +7,20 @@ export declare const BundleEditableResourceTypes: Readonly<{
     readonly consent: "Consent";
     readonly observation: "Observation";
     readonly vitalSign: "Observation";
+    readonly allergyIntolerance: "AllergyIntolerance";
+    readonly condition: "Condition";
+    readonly medicationStatement: "MedicationStatement";
+    readonly documentReference: "DocumentReference";
+    readonly carePlan: "CarePlan";
+    readonly flag: "Flag";
+    readonly clinicalImpression: "ClinicalImpression";
+    readonly device: "Device";
+    readonly deviceUseStatement: "DeviceUseStatement";
+    readonly encounter: "Encounter";
+    readonly coverage: "Coverage";
+    readonly immunization: "Immunization";
+    readonly procedure: "Procedure";
+    readonly diagnosticReport: "DiagnosticReport";
 }>;
 export type AllowedResourceType = string;
 export type BuiltBundleEntry = {
@@ -134,6 +148,34 @@ export declare class BundleEntryEditor {
     asVitalSign(): VitalSignEntryEditor;
     /** Opens the current entry as one general Observation editor. */
     asObservation(): ObservationEntryEditor;
+    /** Opens the current entry as one AllergyIntolerance editor. */
+    asAllergy(): AllergyIntoleranceEntryEditor;
+    /** Opens the current entry as one Condition editor. */
+    asCondition(): ConditionEntryEditor;
+    /** Opens the current entry as one MedicationStatement editor. */
+    asMedicationStatement(): MedicationStatementEntryEditor;
+    /** Opens the current entry as one DocumentReference editor. */
+    asDocumentReference(): DocumentReferenceEntryEditor;
+    /** Opens the current entry as one CarePlan editor. */
+    asCarePlan(): CarePlanEntryEditor;
+    /** Opens the current entry as one Flag editor. */
+    asFlag(): FlagEntryEditor;
+    /** Opens the current entry as one ClinicalImpression editor. */
+    asClinicalImpression(): ClinicalImpressionEntryEditor;
+    /** Opens the current entry as one Device editor. */
+    asDevice(): DeviceEntryEditor;
+    /** Opens the current entry as one DeviceUseStatement editor. */
+    asDeviceUseStatement(): DeviceUseStatementEntryEditor;
+    /** Opens the current entry as one Encounter editor. */
+    asEncounter(): EncounterEntryEditor;
+    /** Opens the current entry as one Coverage editor. */
+    asCoverage(): CoverageEntryEditor;
+    /** Opens the current entry as one Immunization editor. */
+    asImmunization(): ImmunizationEntryEditor;
+    /** Opens the current entry as one Procedure editor. */
+    asProcedure(): ProcedureEntryEditor;
+    /** Opens the current entry as one DiagnosticReport editor. */
+    asDiagnosticReport(): DiagnosticReportEntryEditor;
     /** Reads one claim from this entry. */
     getClaim(key: string): unknown;
     /** Checks whether this entry contains one claim key. */
@@ -157,6 +199,27 @@ export declare class BundleEntryEditor {
     protected getMutableEntry(): BuiltBundleEntry;
     protected getClaims(): EmployeeClaims;
 }
+/**
+ * Shared claims-first editor utilities for IPS clinical resource families.
+ *
+ * The concrete resource type changes, but the editing contract stays aligned:
+ * identifier + subject + status + date + optional CSV-backed reference lists.
+ */
+declare class ClinicalResourceEntryEditor extends BundleEntryEditor {
+    protected getIdentifierValue(claimKey: string): string | undefined;
+    protected setIdentifierValue(claimKey: string, identifier?: string | null): this;
+    protected setSubjectClaims(subjectClaimKey: string, patientClaimKey: string, subject?: string | null): this;
+    protected getSubjectClaims(subjectClaimKey: string, patientClaimKey: string): string | undefined;
+    protected setScalarClaim(claimKey: string, value?: string | null): this;
+    protected getScalarClaim(claimKey: string): string | undefined;
+    protected setNumberClaim(claimKey: string, value?: number | null): this;
+    protected getNumberClaim(claimKey: string): number | undefined;
+    protected setBooleanClaim(claimKey: string, value?: boolean | null): this;
+    protected getBooleanClaim(claimKey: string): boolean | undefined;
+    protected setCsvClaimList(claimKey: string, values: readonly string[]): this;
+    protected getCsvClaimList(claimKey: string): string[];
+    protected ensureIdentifierValue(claimKey: string): string;
+}
 /**
  * Reduced Observation component-style editor surface.
  *
@@ -172,8 +235,23 @@ export declare class ObservationComponentEntryEditor extends BundleEntryEditor {
     getCodeValue(): string | undefined;
     setCodeDisplay(display: string): this;
     getCodeDisplay(): string | undefined;
-    /** Local-language label intended for forms and local UI. */
+    /**
+     * Stores the local-language label used by forms and local UI copy.
+     *
+     * Keep this distinct from `setCodeDisplay(...)`, which is the canonical
+     * English/international display carried by the coded concept.
+     */
+    setCodeTextLocal(text: string): this;
+    /**
+     * Returns the local-language label used by forms and local UI copy.
+     *
+     * Keep this distinct from `getCodeDisplay()`, which returns the canonical
+     * English/international display when present.
+     */
+    getCodeTextLocal(): string | undefined;
+    /** Compatibility alias for older examples/tests. Prefer `setCodeTextLocal(...)`. */
     setLocalText(text: string): this;
+    /** Compatibility alias for older examples/tests. Prefer `getCodeTextLocal()`. */
     getLocalText(): string | undefined;
     setValueQuantityNumber(value: number): this;
     getValueQuantityNumber(): number | undefined;
@@ -229,6 +307,382 @@ export declare class ObservationEntryEditor extends VitalSignEntryEditor {
     getPerformer(): string | undefined;
     setHasMember(reference: string): this;
     getHasMember(): string | undefined;
+    setHasMemberList(references: readonly string[]): this;
+    getHasMemberList(): string[];
+}
+/** Claims-first editor for one staged AllergyIntolerance entry. */
+export declare class AllergyIntoleranceEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setCode(code?: string | null): this;
+    getCode(): string | undefined;
+    setClinicalStatus(status?: string | null): this;
+    getClinicalStatus(): string | undefined;
+    setVerificationStatus(status?: string | null): this;
+    getVerificationStatus(): string | undefined;
+    setCategory(category?: string | null): this;
+    getCategory(): string | undefined;
+    setCriticality(criticality?: string | null): this;
+    getCriticality(): string | undefined;
+    setOnsetDateTime(value?: string | null): this;
+    getOnsetDateTime(): string | undefined;
+    setRecorder(reference?: string | null): this;
+    getRecorder(): string | undefined;
+    setContainedDocumentIdentifierList(identifiers: readonly string[]): this;
+    getContainedDocumentIdentifierList(): string[];
+}
+/** Claims-first editor for one staged Condition entry. */
+export declare class ConditionEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setCode(code?: string | null): this;
+    getCode(): string | undefined;
+    setClinicalStatus(status?: string | null): this;
+    getClinicalStatus(): string | undefined;
+    setVerificationStatus(status?: string | null): this;
+    getVerificationStatus(): string | undefined;
+    setCategory(category?: string | null): this;
+    getCategory(): string | undefined;
+    setSeverity(severity?: string | null): this;
+    getSeverity(): string | undefined;
+    setOnsetDateTime(value?: string | null): this;
+    getOnsetDateTime(): string | undefined;
+    setRecorder(reference?: string | null): this;
+    getRecorder(): string | undefined;
+    setContainedDocumentIdentifierList(identifiers: readonly string[]): this;
+    getContainedDocumentIdentifierList(): string[];
+}
+/** Claims-first editor for one staged MedicationStatement entry. */
+export declare class MedicationStatementEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setStatus(status?: string | null): this;
+    getStatus(): string | undefined;
+    setEffective(value?: string | null): this;
+    getEffective(): string | undefined;
+    setCode(code?: string | null): this;
+    getCode(): string | undefined;
+    setMedicationText(text?: string | null): this;
+    getMedicationText(): string | undefined;
+    setNote(note?: string | null): this;
+    getNote(): string | undefined;
+    setDosageInstruction(value?: string | null): this;
+    getDosageInstruction(): string | undefined;
+    setCategoryList(values: readonly string[]): this;
+    getCategoryList(): string[];
+    setDoseQuantityValue(value?: number | null): this;
+    getDoseQuantityValue(): number | undefined;
+    setDoseQuantityUnit(value?: string | null): this;
+    getDoseQuantityUnit(): string | undefined;
+    setTimingFrequency(value?: number | null): this;
+    getTimingFrequency(): number | undefined;
+    setTimingPeriod(value?: number | null): this;
+    getTimingPeriod(): number | undefined;
+    setTimingPeriodUnit(value?: string | null): this;
+    getTimingPeriodUnit(): string | undefined;
+    setDosageAsNeeded(value?: boolean | null): this;
+    getDosageAsNeeded(): boolean | undefined;
+}
+/** Claims-first editor for one staged DocumentReference entry. */
+export declare class DocumentReferenceEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setType(value?: string | null): this;
+    getType(): string | undefined;
+    setCategory(value?: string | null): this;
+    getCategory(): string | undefined;
+    setContentType(value?: string | null): this;
+    getContentType(): string | undefined;
+    setContentData(value?: string | null): this;
+    getContentData(): string | undefined;
+    setContentHash(value?: string | null): this;
+    getContentHash(): string | undefined;
+    setLocation(value?: string | null): this;
+    getLocation(): string | undefined;
+    setDescription(value?: string | null): this;
+    getDescription(): string | undefined;
+    setDate(value?: string | null): this;
+    getDate(): string | undefined;
+    setAuthor(value?: string | null): this;
+    getAuthor(): string | undefined;
+}
+/** Claims-first editor for one staged CarePlan entry. */
+export declare class CarePlanEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setStatus(value?: string | null): this;
+    getStatus(): string | undefined;
+    setIntent(value?: string | null): this;
+    getIntent(): string | undefined;
+    setCategory(value?: string | null): this;
+    getCategory(): string | undefined;
+    setEncounter(value?: string | null): this;
+    getEncounter(): string | undefined;
+    setDate(value?: string | null): this;
+    getDate(): string | undefined;
+    setNote(value?: string | null): this;
+    getNote(): string | undefined;
+}
+/** Claims-first editor for one staged Flag entry. */
+export declare class FlagEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setStatus(value?: string | null): this;
+    getStatus(): string | undefined;
+    setCategory(value?: string | null): this;
+    getCategory(): string | undefined;
+    setCode(value?: string | null): this;
+    getCode(): string | undefined;
+    setDate(value?: string | null): this;
+    getDate(): string | undefined;
+    setEncounter(value?: string | null): this;
+    getEncounter(): string | undefined;
+    setPeriodStart(value?: string | null): this;
+    getPeriodStart(): string | undefined;
+    setPeriodEnd(value?: string | null): this;
+    getPeriodEnd(): string | undefined;
+}
+/** Claims-first editor for one staged ClinicalImpression entry. */
+export declare class ClinicalImpressionEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setStatus(value?: string | null): this;
+    getStatus(): string | undefined;
+    setDescription(value?: string | null): this;
+    getDescription(): string | undefined;
+    setEncounter(value?: string | null): this;
+    getEncounter(): string | undefined;
+    setEffectiveDateTime(value?: string | null): this;
+    getEffectiveDateTime(): string | undefined;
+    setAssessor(value?: string | null): this;
+    getAssessor(): string | undefined;
+    setSummary(value?: string | null): this;
+    getSummary(): string | undefined;
+}
+/** Claims-first editor for one staged Device entry. */
+export declare class DeviceEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setPatient(value?: string | null): this;
+    getPatient(): string | undefined;
+    setStatus(value?: string | null): this;
+    getStatus(): string | undefined;
+    setType(value?: string | null): this;
+    getType(): string | undefined;
+    setManufacturer(value?: string | null): this;
+    getManufacturer(): string | undefined;
+    setModel(value?: string | null): this;
+    getModel(): string | undefined;
+    setDeviceName(value?: string | null): this;
+    getDeviceName(): string | undefined;
+    setSerialNumber(value?: string | null): this;
+    getSerialNumber(): string | undefined;
+    setOrganization(value?: string | null): this;
+    getOrganization(): string | undefined;
+    setLocation(value?: string | null): this;
+    getLocation(): string | undefined;
+    setUrl(value?: string | null): this;
+    getUrl(): string | undefined;
+    setNote(value?: string | null): this;
+    getNote(): string | undefined;
+}
+/** Claims-first editor for one staged DeviceUseStatement entry. */
+export declare class DeviceUseStatementEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setStatus(value?: string | null): this;
+    getStatus(): string | undefined;
+    setDevice(value?: string | null): this;
+    getDevice(): string | undefined;
+    setRecordedOn(value?: string | null): this;
+    getRecordedOn(): string | undefined;
+    setTimingDateTime(value?: string | null): this;
+    getTimingDateTime(): string | undefined;
+    setReasonCode(value?: string | null): this;
+    getReasonCode(): string | undefined;
+    setSource(value?: string | null): this;
+    getSource(): string | undefined;
+}
+/** Claims-first editor for one staged Encounter entry. */
+export declare class EncounterEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setStatus(value?: string | null): this;
+    getStatus(): string | undefined;
+    setClass(value?: string | null): this;
+    getClass(): string | undefined;
+    setType(value?: string | null): this;
+    getType(): string | undefined;
+    setParticipantList(values: readonly string[]): this;
+    getParticipantList(): string[];
+    setServiceProvider(value?: string | null): this;
+    getServiceProvider(): string | undefined;
+    setPeriodStart(value?: string | null): this;
+    getPeriodStart(): string | undefined;
+    setPeriodEnd(value?: string | null): this;
+    getPeriodEnd(): string | undefined;
+    setReasonCode(value?: string | null): this;
+    getReasonCode(): string | undefined;
+}
+/** Claims-first editor for one staged Coverage entry. */
+export declare class CoverageEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setStatus(value?: string | null): this;
+    getStatus(): string | undefined;
+    setType(value?: string | null): this;
+    getType(): string | undefined;
+    setPolicyHolder(value?: string | null): this;
+    getPolicyHolder(): string | undefined;
+    setSubscriber(value?: string | null): this;
+    getSubscriber(): string | undefined;
+    setBeneficiary(value?: string | null): this;
+    getBeneficiary(): string | undefined;
+    setRelationship(value?: string | null): this;
+    getRelationship(): string | undefined;
+    setPeriodStart(value?: string | null): this;
+    getPeriodStart(): string | undefined;
+    setPeriodEnd(value?: string | null): this;
+    getPeriodEnd(): string | undefined;
+    setPayorList(values: readonly string[]): this;
+    getPayorList(): string[];
+}
+/** Claims-first editor for one staged Immunization entry. */
+export declare class ImmunizationEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setStatus(status?: string | null): this;
+    getStatus(): string | undefined;
+    setDate(date?: string | null): this;
+    getDate(): string | undefined;
+    setVaccineCode(code?: string | null): this;
+    getVaccineCode(): string | undefined;
+    setVaccineCodeTextLocal(text?: string | null): this;
+    getVaccineCodeTextLocal(): string | undefined;
+    setVaccineCodeDisplay(display?: string | null): this;
+    getVaccineCodeDisplay(): string | undefined;
+    setLocation(reference?: string | null): this;
+    getLocation(): string | undefined;
+    setManufacturer(reference?: string | null): this;
+    getManufacturer(): string | undefined;
+    setLotNumber(lotNumber?: string | null): this;
+    getLotNumber(): string | undefined;
+    setPerformerList(references: readonly string[]): this;
+    getPerformerList(): string[];
+    setReasonCode(code?: string | null): this;
+    getReasonCode(): string | undefined;
+    setStatusReason(reason?: string | null): this;
+    getStatusReason(): string | undefined;
+    setTargetDisease(code?: string | null): this;
+    getTargetDisease(): string | undefined;
+    setDoseSequence(sequence?: string | null): this;
+    getDoseSequence(): string | undefined;
+    setSeries(series?: string | null): this;
+    getSeries(): string | undefined;
+    setReactionDate(date?: string | null): this;
+    getReactionDate(): string | undefined;
+    setNote(note?: string | null): this;
+    getNote(): string | undefined;
+    setClinicalNote(note?: string | null): this;
+    getClinicalNote(): string | undefined;
+}
+/** Claims-first editor for one staged Procedure entry. */
+export declare class ProcedureEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setStatus(status?: string | null): this;
+    getStatus(): string | undefined;
+    setDate(date?: string | null): this;
+    getDate(): string | undefined;
+    setCode(code?: string | null): this;
+    getCode(): string | undefined;
+    setCodeTextLocal(text?: string | null): this;
+    getCodeTextLocal(): string | undefined;
+    setCodeDisplay(display?: string | null): this;
+    getCodeDisplay(): string | undefined;
+    setEncounter(reference?: string | null): this;
+    getEncounter(): string | undefined;
+    setLocation(reference?: string | null): this;
+    getLocation(): string | undefined;
+    setReasonCode(code?: string | null): this;
+    getReasonCode(): string | undefined;
+    setNote(note?: string | null): this;
+    getNote(): string | undefined;
+    setClinicalNote(note?: string | null): this;
+    getClinicalNote(): string | undefined;
+    setPerformerList(references: readonly string[]): this;
+    getPerformerList(): string[];
+    setBasedOnList(references: readonly string[]): this;
+    getBasedOnList(): string[];
+    setReasonReferenceList(references: readonly string[]): this;
+    getReasonReferenceList(): string[];
+}
+/** Claims-first editor for one staged DiagnosticReport entry. */
+export declare class DiagnosticReportEntryEditor extends ClinicalResourceEntryEditor {
+    setIdentifier(identifier?: string | null): this;
+    getIdentifier(): string | undefined;
+    ensureIdentifier(): string;
+    setSubject(subject?: string | null): this;
+    getSubject(): string | undefined;
+    setStatus(status?: string | null): this;
+    getStatus(): string | undefined;
+    setDate(date?: string | null): this;
+    getDate(): string | undefined;
+    setCategory(category?: string | null): this;
+    getCategory(): string | undefined;
+    setCode(code?: string | null): this;
+    getCode(): string | undefined;
+    setEncounter(reference?: string | null): this;
+    getEncounter(): string | undefined;
+    setPerformerList(references: readonly string[]): this;
+    getPerformerList(): string[];
+    setResultList(references: readonly string[]): this;
+    getResultList(): string[];
+    setSpecimenList(references: readonly string[]): this;
+    getSpecimenList(): string[];
+    setContainedDocumentIdentifierList(identifiers: readonly string[]): this;
+    getContainedDocumentIdentifierList(): string[];
+    setPresentedFormContentType(contentType?: string | null): this;
+    getPresentedFormContentType(): string | undefined;
+    setPresentedFormData(data?: string | null): this;
+    getPresentedFormData(): string | undefined;
+    setPresentedFormUrl(url?: string | null): this;
+    getPresentedFormUrl(): string | undefined;
 }
 /**
  * Employee-specific editor for one staged bundle entry.
@@ -265,3 +719,4 @@ export declare class EmployeeEntryEditor extends BundleEntryEditor {
     /** Writes the canonical employee organization tax id claim on this entry. */
     setMemberOfOrgTaxId(taxId: string): this;
 }
+export {};