@nexalink/carecompass-sdk 0.6.1 → 0.7.0

package/node_modules/@nexalink/coding-contracts/schemas/coding-rule-result.schema.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nexalink.care/contracts/coding-rule-result.schema.json",
+  "title": "CodingRuleResult",
+  "description": "One deterministic rule execution trace attached to a decision. Rules never rely on the model for validity, bundling, sequencing, modifiers, units, or time calculations; each trace records the rule identity, version, inputs, outcome, and explanation needed to replay the decision.",
+  "version": "1.0.0",
+  "x-wire-version": "coding-rule-result-v1",
+  "x-wire-constant": "CODING_RULE_RESULT_SCHEMA_VERSION",
+  "x-code": "rule_result",
+  "x-keys-code": "rule_result_keys",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["ruleId", "ruleVersion", "outcome"],
+  "properties": {
+    "ruleId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 120,
+      "x-code": "rule_result_id"
+    },
+    "ruleVersion": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 40,
+      "x-code": "rule_result_version"
+    },
+    "outcome": {
+      "type": "string",
+      "enum": [
+        "satisfied",
+        "failed",
+        "rejected",
+        "escalated",
+        "conflicted",
+        "warning"
+      ],
+      "x-code": "rule_result_outcome"
+    },
+    "severity": {
+      "type": "string",
+      "enum": ["info", "warning", "blocking"],
+      "x-code": "rule_result_severity"
+    },
+    "inputs": {
+      "type": "array",
+      "maxItems": 30,
+      "x-code": "rule_result_inputs",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["name", "value"],
+        "x-code": "rule_result_input",
+        "x-keys-code": "rule_result_input_keys",
+        "properties": {
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 80,
+            "x-code": "rule_result_input_name"
+          },
+          "value": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 2000,
+            "x-code": "rule_result_input_value"
+          }
+        }
+      }
+    },
+    "reason": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 120,
+      "x-code": "rule_result_reason"
+    },
+    "explanation": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1000,
+      "x-strip-nonempty": true,
+      "x-code": "rule_result_explanation"
+    },
+    "evidence": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000,
+      "x-code": "rule_result_evidence"
+    }
+  }
+}

package/node_modules/@nexalink/coding-contracts/schemas/coding-service-line.schema.json

@@ -0,0 +1,120 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nexalink.care/contracts/coding-service-line.schema.json",
+  "title": "CodingServiceLine",
+  "description": "One existing (submitted) claim line on a CodingCase. Decisions reference these lines by lineId; the line action is chosen by the decision, never stored here.",
+  "version": "1.0.0",
+  "x-wire-version": "coding-service-line-v1",
+  "x-wire-constant": "CODING_SERVICE_LINE_SCHEMA_VERSION",
+  "x-code": "service_line",
+  "x-keys-code": "service_line_keys",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["lineId", "submittedCode"],
+  "properties": {
+    "lineId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 60,
+      "x-code": "service_line_id"
+    },
+    "submittedCode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["code", "codeSystem"],
+      "x-code": "service_line_submitted_code",
+      "x-keys-code": "service_line_submitted_code_keys",
+      "properties": {
+        "code": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "x-strip-nonempty": true,
+          "x-code": "service_line_code"
+        },
+        "codeSystem": {
+          "type": "string",
+          "enum": [
+            "ICD-10-CM",
+            "ICD-10-PCS",
+            "CPT",
+            "HCPCS",
+            "NDC",
+            "CDT",
+            "OTHER"
+          ],
+          "x-code": "service_line_code_system"
+        },
+        "codeVersion": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 40,
+          "x-code": "service_line_code_version"
+        }
+      }
+    },
+    "modifiers": {
+      "type": "array",
+      "maxItems": 8,
+      "x-code": "service_line_modifiers",
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 8,
+        "x-code": "service_line_modifiers"
+      }
+    },
+    "units": {
+      "type": "object",
+      "additionalProperties": false,
+      "x-code": "service_line_units",
+      "x-keys-code": "service_line_units_keys",
+      "properties": {
+        "count": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 999999,
+          "x-code": "service_line_units_count"
+        },
+        "unitOfMeasure": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 20,
+          "x-code": "service_line_units_measure"
+        }
+      }
+    },
+    "linkedDiagnoses": {
+      "type": "array",
+      "maxItems": 20,
+      "x-code": "service_line_linked_diagnoses",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["diagnosisRef"],
+        "x-code": "service_line_linked_diagnosis",
+        "x-keys-code": "service_line_linked_diagnosis_keys",
+        "properties": {
+          "diagnosisRef": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 60,
+            "x-code": "service_line_diagnosis_ref"
+          },
+          "sequence": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 99,
+            "x-code": "service_line_diagnosis_sequence"
+          }
+        }
+      }
+    },
+    "serviceDate": {
+      "type": "string",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+      "format": "date",
+      "x-code": "service_line_service_date"
+    }
+  }
+}

package/node_modules/@nexalink/coding-contracts/schemas/rcm-coding-input.schema.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nexalink.care/contracts/rcm-coding-input.schema.json",
+  "title": "RcmCodingInput",
+  "description": "Structured coding-case context for a single encounter-based RCM coding-review request. Canonical source for the SDK input shape, the portal request context, and the cloud-hosted encounter payload.",
+  "version": "1.0.0",
+  "x-wire-version": "rcm-coding-input-v1",
+  "x-code": "coding_input",
+  "x-keys-code": "coding_input_keys",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["encounterId", "diagnosisNarrative"],
+  "properties": {
+    "encounterId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 160,
+      "x-code": "encounter_id"
+    },
+    "diagnosisNarrative": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000,
+      "x-code": "diagnosis_narrative"
+    },
+    "procedureNarrative": {
+      "type": "string",
+      "maxLength": 2000,
+      "x-code": "procedure_narrative"
+    },
+    "serviceDate": {
+      "type": "string",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+      "x-code": "service_date"
+    },
+    "placeOfService": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 20,
+      "x-code": "place_of_service"
+    },
+    "claimContext": {
+      "type": "object",
+      "additionalProperties": false,
+      "x-code": "claim_context",
+      "x-keys-code": "claim_context",
+      "properties": {
+        "stage": {
+          "type": "string",
+          "enum": ["development", "staging", "production"],
+          "x-code": "claim_context_stage"
+        },
+        "payerName": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 160,
+          "x-code": "claim_context_payer_name"
+        },
+        "submittedCodes": {
+          "type": "array",
+          "maxItems": 20,
+          "x-code": "claim_context_submitted_codes",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 20,
+            "x-code": "claim_context_submitted_codes"
+          }
+        }
+      }
+    },
+    "supportingReferences": {
+      "type": "array",
+      "maxItems": 10,
+      "x-code": "supporting_references",
+      "items": {
+        "$ref": "rcm-supporting-reference.schema.json"
+      }
+    }
+  },
+  "x-wire-constant": "RCM_INPUT_SCHEMA_VERSION"
+}

package/node_modules/@nexalink/coding-contracts/schemas/rcm-coding-output.schema.json

@@ -0,0 +1,146 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nexalink.care/contracts/rcm-coding-output.schema.json",
+  "title": "RcmCodingOutput",
+  "description": "Grounded RCM coding-review result returned by the hosted runtime. This is the stable compatibility contract behind the legacy rcm-grounded-human-review-v2 output schema version. The runtime postcondition fails closed: any structural or grounding violation is replaced with an escalate response carrying rcm_validation_error.",
+  "version": "1.0.0",
+  "x-wire-version": "rcm-grounded-human-review-v2",
+  "x-code": "not_object",
+  "x-keys-code": "top_level_keys",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "disposition",
+    "humanReviewRequired",
+    "recommendations",
+    "documentationGaps",
+    "rationale"
+  ],
+  "properties": {
+    "disposition": {
+      "type": "string",
+      "enum": ["review_required", "abstain", "escalate"],
+      "x-code": "disposition"
+    },
+    "humanReviewRequired": {
+      "type": "boolean",
+      "const": true,
+      "x-code": "human_review_required"
+    },
+    "rationale": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 4000,
+      "x-strip-nonempty": true,
+      "x-code": "rationale"
+    },
+    "recommendations": {
+      "type": "array",
+      "maxItems": 20,
+      "x-code": "recommendations",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "x-code": "recommendation_keys",
+        "x-keys-code": "recommendation_keys",
+        "required": [
+          "code",
+          "codeSystem",
+          "confidence",
+          "rationale",
+          "evidenceIds"
+        ],
+        "properties": {
+          "code": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 64,
+            "x-strip-nonempty": true,
+            "x-code": "recommendation_code"
+          },
+          "codeSystem": {
+            "type": "string",
+            "enum": ["ICD-10-CM", "CPT", "HCPCS"],
+            "x-code": "recommendation_code_system"
+          },
+          "confidence": {
+            "type": "string",
+            "enum": ["low", "medium", "high"],
+            "x-code": "recommendation_confidence"
+          },
+          "rationale": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 2000,
+            "x-strip-nonempty": true,
+            "x-code": "recommendation_rationale"
+          },
+          "evidenceIds": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 5,
+            "x-code": "recommendation_evidence_ids",
+            "items": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 128,
+              "x-strip-nonempty": true,
+              "x-code": "recommendation_evidence_ids"
+            }
+          }
+        }
+      }
+    },
+    "documentationGaps": {
+      "type": "array",
+      "maxItems": 20,
+      "x-code": "documentation_gaps",
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 1000,
+        "x-strip-nonempty": true,
+        "x-code": "documentation_gaps"
+      }
+    }
+  },
+  "if": {
+    "properties": {
+      "disposition": {
+        "const": "review_required"
+      }
+    },
+    "required": ["disposition"]
+  },
+  "then": {
+    "properties": {
+      "recommendations": {
+        "minItems": 1
+      }
+    },
+    "x-code": "review_required_recommendations"
+  },
+  "else": {
+    "properties": {
+      "recommendations": {
+        "maxItems": 0
+      }
+    },
+    "x-code": "disposition_recommendations"
+  },
+  "x-semantic": [
+    {
+      "rule": "grounded_evidence_ids",
+      "code": "recommendation_unapproved_evidence",
+      "on": "recommendations",
+      "option": "allowedReferenceIds"
+    },
+    {
+      "rule": "code_in_cited_excerpt",
+      "code": "recommendation_code_not_in_evidence",
+      "on": "recommendations",
+      "options": ["allowedReferenceIds", "referenceTextById"]
+    }
+  ],
+  "x-wire-constant": "RCM_OUTPUT_SCHEMA_VERSION"
+}

package/node_modules/@nexalink/coding-contracts/schemas/rcm-model-prompt.schema.json

@@ -0,0 +1,91 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nexalink.care/contracts/rcm-model-prompt.schema.json",
+  "title": "RcmModelPrompt",
+  "description": "Structured JSON presented to the coding model. The encounter carries the request case fields and supportingReferences carry server-resolved or development-approved evidence. The hosted runtime builds this itself from retrieval and never accepts caller-supplied references outside development.",
+  "version": "1.0.0",
+  "x-wire-version": "rcm-model-prompt-v1",
+  "x-code": "model_prompt",
+  "x-keys-code": "model_prompt_keys",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["encounter", "supportingReferences"],
+  "properties": {
+    "encounter": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["encounterId", "diagnosisNarrative"],
+      "x-code": "encounter",
+      "x-keys-code": "encounter_keys",
+      "properties": {
+        "encounterId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 160,
+          "x-code": "encounter_id"
+        },
+        "diagnosisNarrative": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2000,
+          "x-code": "diagnosis_narrative"
+        },
+        "procedureNarrative": {
+          "type": "string",
+          "maxLength": 2000,
+          "x-code": "procedure_narrative"
+        },
+        "serviceDate": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+          "x-code": "service_date"
+        },
+        "placeOfService": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 20,
+          "x-code": "place_of_service"
+        },
+        "claimContext": {
+          "type": "object",
+          "additionalProperties": false,
+          "x-code": "claim_context",
+          "x-keys-code": "claim_context",
+          "properties": {
+            "stage": {
+              "type": "string",
+              "enum": ["development", "staging", "production"],
+              "x-code": "claim_context_stage"
+            },
+            "payerName": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 160,
+              "x-code": "claim_context_payer_name"
+            },
+            "submittedCodes": {
+              "type": "array",
+              "maxItems": 20,
+              "x-code": "claim_context_submitted_codes",
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 20,
+                "x-code": "claim_context_submitted_codes"
+              }
+            }
+          }
+        }
+      }
+    },
+    "supportingReferences": {
+      "type": "array",
+      "maxItems": 5,
+      "x-code": "model_prompt_references",
+      "items": {
+        "$ref": "rcm-supporting-reference.schema.json"
+      }
+    }
+  },
+  "x-wire-constant": "RCM_MODEL_PROMPT_SCHEMA_VERSION"
+}

package/node_modules/@nexalink/coding-contracts/schemas/rcm-retrieval-metadata.schema.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nexalink.care/contracts/rcm-retrieval-metadata.schema.json",
+  "title": "RcmRetrievalMetadata",
+  "description": "Bounded metadata attached to a hosted RCM retrieval outcome. The client-visible shape omits tenantId and knowledgeBaseId; both are included here as optional so the full runtime envelope and the persisted client-facing metadata validate against the same contract.",
+  "version": "1.0.0",
+  "x-wire-version": "rcm-retrieval-metadata-v1",
+  "x-code": "retrieval_metadata",
+  "x-keys-code": "retrieval_metadata_keys",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "corpusId",
+    "corpusVersion",
+    "outcome",
+    "latencyMs",
+    "references"
+  ],
+  "properties": {
+    "corpusId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "x-code": "corpus_id"
+    },
+    "corpusVersion": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "x-code": "corpus_version"
+    },
+    "outcome": {
+      "type": "string",
+      "enum": ["completed", "empty", "failed"],
+      "x-code": "retrieval_outcome"
+    },
+    "latencyMs": {
+      "type": "integer",
+      "minimum": 0,
+      "x-code": "retrieval_latency_ms"
+    },
+    "knowledgeBaseId": {
+      "type": "string",
+      "maxLength": 128,
+      "x-code": "knowledge_base_id"
+    },
+    "tenantId": {
+      "type": "string",
+      "maxLength": 128,
+      "x-code": "retrieval_tenant_id"
+    },
+    "references": {
+      "type": "array",
+      "x-code": "retrieval_references",
+      "items": {
+        "$ref": "rcm-supporting-reference.schema.json"
+      }
+    }
+  },
+  "x-wire-constant": "RCM_RETRIEVAL_SCHEMA_VERSION"
+}

package/node_modules/@nexalink/coding-contracts/schemas/rcm-reviewer-event.schema.json

@@ -0,0 +1,92 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nexalink.care/contracts/rcm-reviewer-event.schema.json",
+  "title": "RcmReviewerEvent",
+  "description": "Tenant-scoped, PHI-free reviewer engagement event for CareCompass RCM workflows. Events carry only an opaque case reference, categorical engagement facts, and aggregate durations. They never carry prompts, model responses, document contents, patient or member identifiers, claim identifiers, or free text.",
+  "version": "1.0.0",
+  "x-wire-version": "rcm-reviewer-event-v1",
+  "x-wire-constant": "RCM_REVIEWER_EVENT_SCHEMA_VERSION",
+  "x-code": "reviewer_event",
+  "x-keys-code": "reviewer_event_keys",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["eventName", "occurredAt", "caseRef", "workflowId", "source"],
+  "properties": {
+    "eventName": {
+      "type": "string",
+      "enum": [
+        "review_opened",
+        "decision_shown",
+        "evidence_opened",
+        "evidence_copied",
+        "review_active_time"
+      ],
+      "x-code": "reviewer_event_name"
+    },
+    "occurredAt": {
+      "type": "string",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$",
+      "format": "date-time",
+      "maxLength": 64,
+      "x-code": "reviewer_event_occurred_at"
+    },
+    "caseRef": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9_.:-]+$",
+      "x-code": "reviewer_event_case_ref"
+    },
+    "reviewId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9_.:-]+$",
+      "x-code": "reviewer_event_review_id"
+    },
+    "workflowId": {
+      "type": "string",
+      "enum": ["rcm-coding-assistance", "monthly-pin-time-aggregation"],
+      "x-code": "reviewer_event_workflow_id"
+    },
+    "packId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 80,
+      "x-code": "reviewer_event_pack_id"
+    },
+    "packVersion": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 80,
+      "x-code": "reviewer_event_pack_version"
+    },
+    "environment": {
+      "type": "string",
+      "enum": ["development", "staging", "production"],
+      "x-code": "reviewer_event_environment"
+    },
+    "source": {
+      "type": "string",
+      "enum": ["portal", "embed"],
+      "x-code": "reviewer_event_source"
+    },
+    "evidenceId": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[A-Za-z0-9_.:-]{1,64}$",
+      "maxLength": 64,
+      "x-code": "reviewer_event_evidence_id"
+    },
+    "activeSeconds": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 86400,
+      "x-code": "reviewer_event_active_seconds"
+    },
+    "idlePaused": {
+      "type": "boolean",
+      "x-code": "reviewer_event_idle_paused"
+    }
+  }
+}