@nexalink/coding-contracts 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,252 @@
+import { z } from "zod";
+export declare const RCM_WORKFLOW_ID: "rcm-coding-assistance";
+export declare const RCM_MODEL_POLICY_ID: "carecompass-rcm-review-v1";
+export declare const RCM_HUMAN_REVIEW_POLICY_ID: "qualified-coder-review-v1";
+export declare const RCM_OUTPUT_SCHEMA_NAME: "carecompass_rcm_grounded_review";
+export declare const RCM_HUMAN_REVIEW_INSTRUCTION: "Qualified human coder review is required before billing, coding, or claim submission.";
+export declare const RCM_REFERENCE_SCHEMA_VERSION: "rcm-supporting-reference-v1";
+export declare const RCM_INPUT_SCHEMA_VERSION: "rcm-coding-input-v1";
+export declare const RCM_OUTPUT_SCHEMA_VERSION: "rcm-grounded-human-review-v2";
+export declare const RCM_MODEL_PROMPT_SCHEMA_VERSION: "rcm-model-prompt-v1";
+export declare const RCM_RETRIEVAL_SCHEMA_VERSION: "rcm-retrieval-metadata-v1";
+export declare const RCM_RUNTIME_EVENT_SCHEMA_VERSION: "rcm-runtime-event-v1";
+export declare const RCM_WORKFLOW_CATALOG_SCHEMA_VERSION: "rcm-workflow-catalog-v1";
+export declare const rcmSupportingReferenceSchema: z.ZodObject<{
+    referenceId: z.ZodString;
+    documentId: z.ZodOptional<z.ZodString>;
+    title: z.ZodString;
+    excerpt: z.ZodString;
+    version: z.ZodOptional<z.ZodString>;
+    corpusScope: z.ZodOptional<z.ZodEnum<{
+        base: "base";
+        tenant: "tenant";
+    }>>;
+    publisher: z.ZodOptional<z.ZodString>;
+    effectiveDate: z.ZodOptional<z.ZodString>;
+    retrievalDate: z.ZodOptional<z.ZodString>;
+    coveredPayerProgram: z.ZodOptional<z.ZodString>;
+    sourceUrl: z.ZodOptional<z.ZodString>;
+    humanReviewRequired: z.ZodOptional<z.ZodLiteral<true>>;
+}, z.core.$strict>;
+export type RcmSupportingReference = z.infer<typeof rcmSupportingReferenceSchema>;
+export declare function rcmSupportingReferenceValidationError(value: unknown): string | null;
+export declare const validRcmSupportingReference: (value: unknown) => boolean;
+export declare const RcmSupportingReferenceSchemaJson: Record<string, unknown>;
+export declare const rcmCodingInputSchema: z.ZodObject<{
+    encounterId: z.ZodString;
+    diagnosisNarrative: z.ZodString;
+    procedureNarrative: z.ZodOptional<z.ZodString>;
+    serviceDate: z.ZodOptional<z.ZodString>;
+    placeOfService: z.ZodOptional<z.ZodString>;
+    claimContext: z.ZodOptional<z.ZodObject<{
+        stage: z.ZodOptional<z.ZodEnum<{
+            development: "development";
+            staging: "staging";
+            production: "production";
+        }>>;
+        payerName: z.ZodOptional<z.ZodString>;
+        submittedCodes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    supportingReferences: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        referenceId: z.ZodString;
+        documentId: z.ZodOptional<z.ZodString>;
+        title: z.ZodString;
+        excerpt: z.ZodString;
+        version: z.ZodOptional<z.ZodString>;
+        corpusScope: z.ZodOptional<z.ZodEnum<{
+            base: "base";
+            tenant: "tenant";
+        }>>;
+        publisher: z.ZodOptional<z.ZodString>;
+        effectiveDate: z.ZodOptional<z.ZodString>;
+        retrievalDate: z.ZodOptional<z.ZodString>;
+        coveredPayerProgram: z.ZodOptional<z.ZodString>;
+        sourceUrl: z.ZodOptional<z.ZodString>;
+        humanReviewRequired: z.ZodOptional<z.ZodLiteral<true>>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export type RcmCodingInput = z.infer<typeof rcmCodingInputSchema>;
+export declare function rcmCodingInputValidationError(value: unknown): string | null;
+export declare const validRcmCodingInput: (value: unknown) => boolean;
+export declare const RcmCodingInputSchemaJson: Record<string, unknown>;
+export declare const rcmCodingOutputSchema: z.ZodObject<{
+    disposition: z.ZodEnum<{
+        review_required: "review_required";
+        abstain: "abstain";
+        escalate: "escalate";
+    }>;
+    humanReviewRequired: z.ZodLiteral<true>;
+    rationale: z.ZodString;
+    recommendations: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        codeSystem: z.ZodEnum<{
+            "ICD-10-CM": "ICD-10-CM";
+            CPT: "CPT";
+            HCPCS: "HCPCS";
+        }>;
+        confidence: z.ZodEnum<{
+            low: "low";
+            medium: "medium";
+            high: "high";
+        }>;
+        rationale: z.ZodString;
+        evidenceIds: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+    documentationGaps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+export type RcmCodingOutput = z.infer<typeof rcmCodingOutputSchema>;
+export declare function rcmCodingOutputValidationError(value: unknown, options?: {
+    allowedReferenceIds?: Set<string>;
+    referenceTextById?: Record<string, string>;
+}): string | null;
+export declare const validRcmCodingOutput: (value: unknown) => boolean;
+export declare const RcmCodingOutputSchemaJson: Record<string, unknown>;
+export declare const rcmModelPromptSchema: z.ZodObject<{
+    encounter: z.ZodObject<{
+        encounterId: z.ZodString;
+        diagnosisNarrative: z.ZodString;
+        procedureNarrative: z.ZodOptional<z.ZodString>;
+        serviceDate: z.ZodOptional<z.ZodString>;
+        placeOfService: z.ZodOptional<z.ZodString>;
+        claimContext: z.ZodOptional<z.ZodObject<{
+            stage: z.ZodOptional<z.ZodEnum<{
+                development: "development";
+                staging: "staging";
+                production: "production";
+            }>>;
+            payerName: z.ZodOptional<z.ZodString>;
+            submittedCodes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    supportingReferences: z.ZodArray<z.ZodObject<{
+        referenceId: z.ZodString;
+        documentId: z.ZodOptional<z.ZodString>;
+        title: z.ZodString;
+        excerpt: z.ZodString;
+        version: z.ZodOptional<z.ZodString>;
+        corpusScope: z.ZodOptional<z.ZodEnum<{
+            base: "base";
+            tenant: "tenant";
+        }>>;
+        publisher: z.ZodOptional<z.ZodString>;
+        effectiveDate: z.ZodOptional<z.ZodString>;
+        retrievalDate: z.ZodOptional<z.ZodString>;
+        coveredPayerProgram: z.ZodOptional<z.ZodString>;
+        sourceUrl: z.ZodOptional<z.ZodString>;
+        humanReviewRequired: z.ZodOptional<z.ZodLiteral<true>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type RcmModelPrompt = z.infer<typeof rcmModelPromptSchema>;
+export declare function rcmModelPromptValidationError(value: unknown): string | null;
+export declare const validRcmModelPrompt: (value: unknown) => boolean;
+export declare const RcmModelPromptSchemaJson: Record<string, unknown>;
+export declare const rcmRetrievalMetadataSchema: z.ZodObject<{
+    corpusId: z.ZodString;
+    corpusVersion: z.ZodString;
+    outcome: z.ZodEnum<{
+        completed: "completed";
+        empty: "empty";
+        failed: "failed";
+    }>;
+    latencyMs: z.ZodNumber;
+    knowledgeBaseId: z.ZodOptional<z.ZodString>;
+    tenantId: z.ZodOptional<z.ZodString>;
+    references: z.ZodArray<z.ZodObject<{
+        referenceId: z.ZodString;
+        documentId: z.ZodOptional<z.ZodString>;
+        title: z.ZodString;
+        excerpt: z.ZodString;
+        version: z.ZodOptional<z.ZodString>;
+        corpusScope: z.ZodOptional<z.ZodEnum<{
+            base: "base";
+            tenant: "tenant";
+        }>>;
+        publisher: z.ZodOptional<z.ZodString>;
+        effectiveDate: z.ZodOptional<z.ZodString>;
+        retrievalDate: z.ZodOptional<z.ZodString>;
+        coveredPayerProgram: z.ZodOptional<z.ZodString>;
+        sourceUrl: z.ZodOptional<z.ZodString>;
+        humanReviewRequired: z.ZodOptional<z.ZodLiteral<true>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type RcmRetrievalMetadata = z.infer<typeof rcmRetrievalMetadataSchema>;
+export declare function rcmRetrievalMetadataValidationError(value: unknown): string | null;
+export declare const validRcmRetrievalMetadata: (value: unknown) => boolean;
+export declare const RcmRetrievalMetadataSchemaJson: Record<string, unknown>;
+export declare const rcmRuntimeEventSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        audit: "audit";
+        safety: "safety";
+    }>;
+    outcome: z.ZodEnum<{
+        authorized: "authorized";
+        validated: "validated";
+        escalated: "escalated";
+    }>;
+    reason: z.ZodEnum<{
+        workflow_authorized: "workflow_authorized";
+        output_validated: "output_validated";
+        output_invalid: "output_invalid";
+        workflow_escalated: "workflow_escalated";
+        guardrail_blocked: "guardrail_blocked";
+        retrieval_completed: "retrieval_completed";
+        retrieval_failed: "retrieval_failed";
+    }>;
+    occurredAt: z.ZodString;
+    workflowId: z.ZodEnum<{
+        "rcm-coding-assistance": "rcm-coding-assistance";
+    }>;
+    guardrail: z.ZodOptional<z.ZodObject<{
+        stopReason: z.ZodOptional<z.ZodString>;
+        actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            scope: z.ZodString;
+            policyType: z.ZodString;
+            rule: z.ZodString;
+            action: z.ZodString;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>>;
+    retrieval: z.ZodOptional<z.ZodObject<{
+        corpusId: z.ZodString;
+        corpusVersion: z.ZodString;
+        outcome: z.ZodString;
+        referenceCount: z.ZodNumber;
+        latencyMs: z.ZodNumber;
+        references: z.ZodArray<z.ZodObject<{
+            referenceId: z.ZodString;
+            documentId: z.ZodString;
+            version: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type RcmRuntimeEvent = z.infer<typeof rcmRuntimeEventSchema>;
+export declare function rcmRuntimeEventValidationError(value: unknown): string | null;
+export declare const validRcmRuntimeEvent: (value: unknown) => boolean;
+export declare const RcmRuntimeEventSchemaJson: Record<string, unknown>;
+export declare const rcmWorkflowCatalogSchema: z.ZodObject<{
+    id: z.ZodEnum<{
+        "rcm-coding-assistance": "rcm-coding-assistance";
+    }>;
+    name: z.ZodString;
+    description: z.ZodString;
+    environments: z.ZodArray<z.ZodEnum<{
+        development: "development";
+        production: "production";
+    }>>;
+    modelPolicy: z.ZodObject<{
+        policyId: z.ZodLiteral<"carecompass-rcm-review-v1">;
+        inferencePath: z.ZodString;
+        maxNewTokens: z.ZodNumber;
+        temperature: z.ZodNumber;
+        outputSchemaVersion: z.ZodLiteral<"rcm-grounded-human-review-v2">;
+        requireHumanReview: z.ZodLiteral<true>;
+    }, z.core.$strict>;
+    humanReviewPolicy: z.ZodObject<{
+        policyId: z.ZodLiteral<"qualified-coder-review-v1">;
+        humanReviewRequired: z.ZodLiteral<true>;
+    }, z.core.$strict>;
+    outputSchemaVersion: z.ZodLiteral<"rcm-grounded-human-review-v2">;
+}, z.core.$strict>;
+export type RcmWorkflowCatalog = z.infer<typeof rcmWorkflowCatalogSchema>;
+export declare function rcmWorkflowCatalogValidationError(value: unknown): string | null;
+export declare const validRcmWorkflowCatalog: (value: unknown) => boolean;
+export declare const RcmWorkflowCatalogSchemaJson: Record<string, unknown>;