@nexalink/coding-contracts 0.3.0 → 0.4.0

package/schemas/rcm-reviewer-event.schema.json

@@ -0,0 +1,160 @@
+{
+  "$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",
+  "x-semantic": [
+    {
+      "rule": "reviewer_event_shape",
+      "code": "reviewer_event_shape",
+      "on": "eventName"
+    }
+  ],
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "eventName",
+    "occurredAt",
+    "tenantRef",
+    "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"
+    },
+    "tenantRef": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9_.:-]+$",
+      "x-code": "reviewer_event_tenant_ref"
+    },
+    "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,
+      "pattern": "^[A-Za-z0-9_.:-]+$",
+      "x-code": "reviewer_event_pack_id"
+    },
+    "packVersion": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 80,
+      "pattern": "^[A-Za-z0-9_.:-]+$",
+      "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"
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "eventName": {
+            "enum": ["evidence_opened", "evidence_copied"]
+          }
+        },
+        "required": ["eventName"]
+      },
+      "then": {
+        "required": ["evidenceId"]
+      },
+      "else": {
+        "not": {
+          "required": ["evidenceId"]
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "eventName": {
+            "const": "review_active_time"
+          }
+        },
+        "required": ["eventName"]
+      },
+      "then": {
+        "required": ["activeSeconds"]
+      },
+      "else": {
+        "not": {
+          "anyOf": [
+            {
+              "required": ["activeSeconds"]
+            },
+            {
+              "required": ["idlePaused"]
+            }
+          ]
+        }
+      }
+    }
+  ]
+}

package/schemas/rcm-workflow-catalog.schema.json

@@ -2,11 +2,18 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://nexalink.care/contracts/rcm-workflow-catalog.schema.json",
   "title": "RcmWorkflowCatalog",
-  "description": "A single authorized workflow entry. The catalog pins the workflow identifier, model policy, human-review policy, and output schema version that the runtime and portal may offer for the RCM coding-assistance workflow. Customer configuration can never redefine these immutable server-side values.",
-  "version": "1.0.0",
+  "description": "A single authorized workflow entry. The catalog pins the workflow identifier, model policy, human-review policy, and output schema version that the runtime and portal may offer for registered coding workflows (currently rcm-coding-assistance and monthly-pin-time-aggregation). Customer configuration can never redefine these immutable server-side values.",
+  "version": "1.1.0",
   "x-wire-version": "rcm-workflow-catalog-v1",
   "x-code": "workflow_catalog",
   "x-keys-code": "workflow_catalog_keys",
+  "x-semantic": [
+    {
+      "rule": "workflow_policy_binding",
+      "code": "workflow_policy_binding",
+      "on": "modelPolicy"
+    }
+  ],
   "type": "object",
   "additionalProperties": false,
   "required": [
@@ -21,7 +28,7 @@
   "properties": {
     "id": {
       "type": "string",
-      "enum": ["rcm-coding-assistance"],
+      "enum": ["rcm-coding-assistance", "monthly-pin-time-aggregation"],
       "x-code": "workflow_id"
     },
     "name": {
@@ -62,8 +69,11 @@
       "properties": {
         "policyId": {
           "type": "string",
-          "const": "carecompass-rcm-review-v1",
-          "x-code": "model_policy_id"
+          "x-code": "model_policy_id",
+          "enum": [
+            "carecompass-rcm-review-v1",
+            "carecompass-pin-time-policy-v1"
+          ]
         },
         "inferencePath": {
           "type": "string",
@@ -119,5 +129,52 @@
       "x-code": "workflow_output_schema_version"
     }
   },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "id": {
+            "const": "rcm-coding-assistance"
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "modelPolicy": {
+            "properties": {
+              "policyId": {
+                "const": "carecompass-rcm-review-v1"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "id": {
+            "const": "monthly-pin-time-aggregation"
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "modelPolicy": {
+            "properties": {
+              "policyId": {
+                "const": "carecompass-pin-time-policy-v1"
+              }
+            }
+          },
+          "environments": {
+            "items": {
+              "const": "development"
+            }
+          }
+        }
+      }
+    }
+  ],
   "x-wire-constant": "RCM_WORKFLOW_CATALOG_SCHEMA_VERSION"
 }

package/versions.json

@@ -1,7 +1,7 @@
 {
   "$comment": "GENERATED FILE. Schema registry derived from schemas/*.schema.json.",
   "packageName": "@nexalink/coding-contracts",
-  "packageVersion": "0.3.0",
+  "packageVersion": "0.4.0",
   "schemas": {
     "coding-case-context": {
       "file": "coding-case-context.schema.json",
@@ -55,7 +55,7 @@
     },
     "coding-reviewer-action": {
       "file": "coding-reviewer-action.schema.json",
-      "semver": "1.0.0",
+      "semver": "1.1.0",
       "wireVersion": "coding-reviewer-action-v1"
     },
     "coding-decision": {
@@ -88,6 +88,11 @@
       "semver": "1.0.0",
       "wireVersion": "rcm-retrieval-metadata-v1"
     },
+    "rcm-reviewer-event": {
+      "file": "rcm-reviewer-event.schema.json",
+      "semver": "1.0.0",
+      "wireVersion": "rcm-reviewer-event-v1"
+    },
     "rcm-runtime-event": {
       "file": "rcm-runtime-event.schema.json",
       "semver": "1.0.0",
@@ -95,7 +100,7 @@
     },
     "rcm-workflow-catalog": {
       "file": "rcm-workflow-catalog.schema.json",
-      "semver": "1.0.0",
+      "semver": "1.1.0",
       "wireVersion": "rcm-workflow-catalog-v1"
     }
   }

package/workflow-constants.json

@@ -5,6 +5,7 @@
     "rcmModelPolicyId": "carecompass-rcm-review-v1",
     "rcmHumanReviewPolicyId": "qualified-coder-review-v1",
     "rcmOutputSchemaName": "carecompass_rcm_grounded_review",
-    "rcmHumanReviewInstruction": "Qualified human coder review is required before billing, coding, or claim submission."
+    "rcmHumanReviewInstruction": "Qualified human coder review is required before billing, coding, or claim submission.",
+    "pinTimeWorkflowId": "monthly-pin-time-aggregation"
   }
 }