{ "opencollection": "1.0.0", "info": { "name": "Certify API Layer Facility Credentialing Workflow API", "version": "1.0.0" }, "items": [ { "info": { "name": "FacilityCredentialingWorkflow", "type": "folder" }, "items": [ { "info": { "name": "Get facility credentialing workflows", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/facility-credentialing-workflows", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "endAtId", "value": "", "type": "query", "description": "End at document ID, for backward cursor-based pagination" }, { "name": "filter", "value": "", "type": "query", "description": "## Filter Criteria\n\nThe filter parameter must be URL encoded when sent. Filters are specified as JSON objects where each field can have\none or more filter operations.\n\n### Filterable Fields\n\n#### Core Workflow Fields\n- **id**: Workflow unique identifier (String)\n- **createdAt**: Workflow creation timestamp (Timestamp)\n- **updatedAt**: Workflow last update timestamp (Timestamp)\n\n#### Data Fields - Workflow Information\n- **data.credentialingCycle**: Credentialing cycle (String)\n- **data.facilityFileType**: Type of facility file (String)\n- **data.assignedTo**: User assigned to the workflow (String)\n- **data.assignedBy**: User who assigned the workflow (String)\n\n#### Data Fields - Status & Dates\n- **data.credentialingStatus**: Current workflow status (String)\n- **data.psvReadyDate**: PSV ready date (Timestamp)\n- **data.psvCompletedDate**: PSV completed date (Timestamp)\n- **data.credentialingStatusLastUpdatedDate**: Status last updated date (Timestamp)\n- **data.previousCredentialedDate**: Previous credentialing date (Date)\n- **data.credentialingDueDate**: Credentialing due date (Date)\n- **data.nextCredentialingDate**: Next credentialing date (Date)\n- **data.credentialingDecisionDate**: Credentialing decision date (Date)\n\n#### Data Fields - Facility Information\n- **data.facility.npi**: National Provider Identifier (String)\n- **data.facility.name**: Facility name (String)\n- **data.facility.tin**: Tax Identification Number (String)\n- **data.facility.externalId**: External identifier (String)\n- **data.facility.primaryEmail**: Primary email address (String)\n- **data.facility.facilityType**: Type of facility (String)\n- **data.facility.lineOfBusiness**: Array of lines of business (Array - eq/in only)\n- **data.facility.licensedStates**: Array of licensed states (Array - eq/in only)\n\n### Supported Filter Operations\n\n#### String Fields (eq, neq, in, nin, contains)\n- **eq**: Exact match - `{\"field\":{\"eq\":\"value\"}}`\n- **neq**: Not equal - `{\"field\":{\"neq\":\"value\"}}`\n- **in**: Match any value in array - `{\"field\":{\"in\":[\"value1\",\"value2\"]}}`\n- **nin**: Not match any value in array - `{\"field\":{\"nin\":[\"value1\",\"value2\"]}}`\n- **contains**: Substring match - `{\"field\":{\"contains\":\"partial\"}}`\n\n#### Timestamp/Date Fields (eq, neq, gt, gte, lt, lte)\n- **eq**: Exact match - `{\"field\":{\"eq\":\"2023-01-01T00:00:00Z\"}}`\n- **neq**: Not equal - `{\"field\":{\"neq\":\"2023-01-01T00:00:00Z\"}}`\n- **gt**: Greater than - `{\"field\":{\"gt\":\"2023-01-01T00:00:00Z\"}}`\n- **gte**: Greater than or equal - `{\"field\":{\"gte\":\"2023-01-01T00:00:00Z\"}}`\n- **lt**: Less than - `{\"field\":{\"lt\":\"2023-01-01T00:00:00Z\"}}`\n- **lte**: Less than or equal - `{\"field\":{\"lte\":\"2023-01-01T00:00:00Z\"}}`\n\n#### Array Fields (eq, in only)\n- **eq**: Array contains value - `{\"field\":{\"eq\":\"value\"}}`\n- **in**: Array contains any of these values - `{\"field\":{\"in\":[\"value1\",\"value2\"]}}`\n\n### Filter Examples\n\n#### Basic Filters (before URL encoding)\n```json\n// Filter by id\n{\"id\":{\"eq\":\"123\"}}\n\n// Filter by credentialing status\n{\"data.credentialingStatus\":{\"eq\":\"PSV_READY\"}}\n\n// Filter by assigned user\n{\"data.assignedTo\":{\"eq\":\"user123\"}}\n\n// Filter by facility file type\n{\"data.facilityFileType\":{\"eq\":\"INITIAL\"}}\n```\n\n#### Facility Filters\n```json\n// Search by facility name\n{\"data.facility.name\":{\"contains\":\"Hospital\"}}\n\n// Filter by NPI (exact match)\n{\"data.facility.npi\":{\"eq\":\"1234567890\"}}\n\n// Filter by TIN\n{\"data.facility.tin\":{\"eq\":\"12-3456789\"}}\n\n// Filter by email\n{\"data.facility.primaryEmail\":{\"contains\":\"@example.com\"}}\n\n// Filter by facility type\n{\"data.facility.facilityType\":{\"eq\":\"HOSPITAL\"}}\n\n// Filter by external ID\n{\"data.facility.externalId\":{\"eq\":\"EXT123\"}}\n```\n\n#### Array Field Filters\n```json\n// Filter by line of business\n{\"data.facility.lineOfBusiness\":{\"eq\":\"MEDICARE\"}}\n\n// Filter by multiple lines of business\n{\"data.facility.lineOfBusiness\":{\"in\":[\"MEDICARE\",\"MEDICAID\"]}}\n\n// Filter by licensed states\n{\"data.facility.licensedStates\":{\"in\":[\"CA\",\"NY\",\"TX\"]}}\n```\n\n#### Date/Timestamp Filters\n```json\n// Workflows created after a date\n{\"createdAt\":{\"gt\":\"2023-01-01T00:00:00Z\"}}\n\n// PSV ready within a date range\n{\"data.psvReadyDate\":{\"gte\":\"2023-01-01T00:00:00Z\",\"lte\":\"2023-12-31T23:59:59Z\"}}\n\n// Workflows updated in last 7 days\n{\"updatedAt\":{\"gte\":\"2023-01-15T00:00:00Z\"}}\n\n// Credentialing due date in range\n{\"data.credentialingDueDate\":{\"gte\":\"2023-01-01\",\"lte\":\"2023-12-31\"}}\n```\n\n#### Combined Filters\n```json\n// Multiple conditions (AND logic)\n{\n \"data.facility.name\":{\"contains\":\"Hospital\"},\n \"data.facility.npi\":{\"eq\":\"1234567890\"},\n \"data.credentialingStatus\":{\"eq\":\"PSV_READY\"}\n}\n\n// Filter by status and date range\n{\n \"data.credentialingStatus\":{\"eq\":\"CRED_APPROVED\"},\n \"data.credentialingDecisionDate\":{\"gte\":\"2023-01-01\",\"lte\":\"2023-12-31\"}\n}\n\n// Filter by facility type and line of business\n{\n \"data.facility.facilityType\":{\"eq\":\"HOSPITAL\"},\n \"data.facility.lineOfBusiness\":{\"in\":[\"MEDICARE\",\"MEDICAID\"]}\n}\n```\n\n### cURL Examples\n```bash\n# Filter by id\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?filter=%7B%22id%22%3A%7B%22eq%22%3A%22123%22%7D%7D'\n\n# Filter by facility name (case-sensitive)\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?filter=%7B%22data.facility.name%22%3A%7B%22contains%22%3A%22Hospital%22%7D%7D'\n\n# Filter by NPI\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?filter=%7B%22data.facility.npi%22%3A%7B%22eq%22%3A%221234567890%22%7D%7D'\n\n# Filter by licensed states\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?filter=%7B%22data.facility.licensedStates%22%3A%7B%22in%22%3A%5B%22CA%22%2C%22NY%22%5D%7D%7D'\n\n# Filter by credentialing status\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?filter=%7B%22data.credentialingStatus%22%3A%7B%22eq%22%3A%22PSV_READY%22%7D%7D'\n\n# Combined filter\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?filter=%7B%22data.facility.name%22%3A%7B%22contains%22%3A%22Hospital%22%7D%2C%22data.credentialingStatus%22%3A%7B%22eq%22%3A%22PSV_READY%22%7D%7D'\n```\n\n**Note**: Always URL encode the JSON filter string before sending the request.\n" }, { "name": "order", "value": "", "type": "query", "description": "## Sorting/Ordering\n\nSort results by specifying a field name and direction. The order parameter must be URL encoded when sent.\n\n### Sortable Fields\nYou can sort by any of the following fields:\n- **id**: Workflow unique identifier\n- **createdAt**: Workflow creation timestamp\n- **createdBy**: User who created the workflow (sortable only, not filterable)\n- **updatedAt**: Last update timestamp\n- **updatedBy**: User who last updated the workflow (sortable only, not filterable)\n- **data**: JSON data field (lexicographic ordering)\n\n### Sort Direction\n- **ASC**: Ascending order (default)\n- **DESC**: Descending order\n\n**Note**: Sort direction is case-insensitive, but uppercase is recommended (ASC/DESC).\n\n### Sort Format\n```json\n{\n \"orderBy\": \"fieldName\",\n \"orderByDirection\": \"ASC|DESC\"\n}\n```\n\n### Sort Examples\n\n#### Basic Sorting (before URL encoding)\n```json\n// Sort by creation date (newest first)\n{\"orderBy\":\"createdAt\",\"orderByDirection\":\"DESC\"}\n\n// Sort by id (ascending)\n{\"orderBy\":\"id\",\"orderByDirection\":\"ASC\"}\n\n// Sort by last update (newest first)\n{\"orderBy\":\"updatedAt\",\"orderByDirection\":\"DESC\"}\n```\n\n### cURL Examples\n```bash\n# Sort by creation date (newest first)\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?order=%7B%22orderBy%22%3A%22createdAt%22%2C%22orderByDirection%22%3A%22DESC%22%7D'\n\n# Sort by id (ascending)\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?order=%7B%22orderBy%22%3A%22id%22%2C%22orderByDirection%22%3A%22ASC%22%7D'\n\n# Sort by last update (newest first)\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?order=%7B%22orderBy%22%3A%22updatedAt%22%2C%22orderByDirection%22%3A%22DESC%22%7D'\n\n# Combine filter and sort\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?filter=%7B%22data.credentialingStatus%22%3A%7B%22eq%22%3A%22PSV_READY%22%7D%7D&order=%7B%22orderBy%22%3A%22createdAt%22%2C%22orderByDirection%22%3A%22DESC%22%7D'\n\n# Combine filter, sort, and pagination\ncurl -X GET 'http://localhost:8080/facility-credentialing-workflows?filter=%7B%22data.facility.name%22%3A%7B%22contains%22%3A%22Hospital%22%7D%7D&order=%7B%22orderBy%22%3A%22updatedAt%22%2C%22orderByDirection%22%3A%22DESC%22%7D&size=20&page=0'\n```\n\n**Note**: Always URL encode the JSON order string before sending the request.\n" }, { "name": "page", "value": "", "type": "query", "description": "Page number (0-based), for offset-based pagination" }, { "name": "size", "value": "", "type": "query", "description": "Page size" }, { "name": "startAfterId", "value": "", "type": "query", "description": "Start after document ID, for forward cursor-based pagination" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a list of facility credentialing workflows based on filter criteria" }, { "info": { "name": "Create a facility credentialing workflow", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows", "headers": [ { "name": "tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new facility credentialing workflow" }, { "info": { "name": "Create assignments for multiple facility credentialing workflows", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/assignments", "headers": [ { "name": "tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates assignments for multiple facility credentialing workflows in a single operation. Workflows are evenly distributed across the provided user IDs using round-robin distribution. To unassign workflows, provide an empty array for assignedTo. Each workflow is processed independently, and results include both successful and failed assignments." }, { "info": { "name": "Create facility credentialing workflows for multiple facilities (async)", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/bulk-create", "headers": [ { "name": "tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Asynchronously creates facility credentialing workflows for multiple facilities. The request is accepted and processing begins immediately in the background. Each workflow is processed independently with automatic facility data hydration. Results are logged but not returned in the response." }, { "info": { "name": "Cloud Task callback for creating a single facility credentialing workflow", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/cloud-create", "headers": [ { "name": "tenant-id", "value": "" }, { "name": "user-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Called by Cloud Tasks as part of the v2 bulk-create flow. Creates a single facility credentialing workflow and updates the bulk request item status. Required body fields: certifyFacilityId (string), tenantFacilityId (string), credentialingWorkflowBulkRequestId (string), credentialingWorkflowBulkRequestItemId (string). Optional body field: data (object) - workflow creation payload." }, { "info": { "name": "Replay missed webhooks for facility credentialing workflows", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/replay-webhooks", "headers": [ { "name": "tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replay missed webhooks for facility credentialing workflows" }, { "info": { "name": "Change status of multiple facility credentialing workflows", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/timeline-events", "headers": [ { "name": "tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates timeline events for multiple facility credentialing workflows in a single operation. This allows changing the status of multiple workflows at once. Each workflow is processed independently, and the response includes both successful and failed operations." }, { "info": { "name": "Create facility credentialing workflows for multiple facilities via Cloud Tasks (v2)", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/v2/bulk-create", "headers": [ { "name": "tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Accepts a bulk workflow creation request, creates a tracking entry in the database, and enqueues individual workflow creation tasks via Cloud Tasks for reliable processing. Each facility workflow is created independently through the cloud-create callback. Returns immediately with 202 Accepted." }, { "info": { "name": "Create assignment for facility credentialing workflow", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/:id/assignments", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new assignment for the specified facility credentialing workflow" }, { "info": { "name": "Generate PSV for facility credentialing workflow", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/:id/generate-psv", "headers": [ { "name": "tenant-id", "value": "" }, { "name": "user-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generates a Provider Summary Verification (PSV) document for the specified facility workflow" }, { "info": { "name": "Get latest PSV PDF for facility credentialing workflow", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/facility-credentialing-workflows/:id/latest-psv-pdf", "headers": [ { "name": "tenant-id", "value": "" }, { "name": "user-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves the latest PSV PDF path from timeline events for the specified facility credentialing workflow" }, { "info": { "name": "Get facility credentialing workflow by ID", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a single facility credentialing workflow by its ID" }, { "info": { "name": "Update a facility credentialing workflow", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates an existing facility credentialing workflow" }, { "info": { "name": "Delete a facility credentialing workflow", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes an existing facility credentialing workflow" }, { "info": { "name": "Update facility accreditations", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/accreditations", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all accreditations for a facility credentialing workflow" }, { "info": { "name": "Update addresses of a facility in a credentialing workflow", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/addresses", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "fcw_1234567890", "type": "path", "description": "Facility credentialing workflow ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replaces the entire addresses array with the provided list (RESTful PUT semantics)." }, { "info": { "name": "Update facility app verifications", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/app-verifications", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all app verifications for a facility credentialing workflow" }, { "info": { "name": "Upload attachment to facility credentialing workflow row", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/attachments", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "id", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" }, { "name": "expirationDate", "type": "text", "value": "" } ] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upload attachment to facility credentialing workflow row" }, { "info": { "name": "Delete attachment from facility credentialing workflow row", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/attachments", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete attachment from facility credentialing workflow row" }, { "info": { "name": "Update facility certificates", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/certificates", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all certificates for a facility credentialing workflow" }, { "info": { "name": "Update credentialing cycle", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/credentialing-cycle", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the credentialing cycle for a facility credentialing workflow. Valid values include INITIAL and RECREDENTIALING." }, { "info": { "name": "Update emails in a facility credentialing workflow", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/emails", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "fcw_1234567890", "type": "path", "description": "Facility credentialing workflow ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the emails for a facility credentialing workflow. This is a complete replacement operation. Send an empty array to clear all emails." }, { "info": { "name": "Update facility file type", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/facility-file-type", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the facility file type for a facility credentialing workflow. Valid values are CLEAN, NON_CLEAN, and PENDING." }, { "info": { "name": "Update facility overview fields", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/facility-overview", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "fcw_1234567890", "type": "path", "description": "Facility credentialing workflow ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the facility overview fields (dba, name, primaryEmail, npi, tin, externalId, facilityType, attestationDate) for a facility credentialing workflow. Only provided fields will be updated; null fields are ignored." }, { "info": { "name": "Update facility liability insurance", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/liability-insurance", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all liability insurance for a facility credentialing workflow" }, { "info": { "name": "Update facility state licenses", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/licenses", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all state licenses for a facility credentialing workflow" }, { "info": { "name": "Update line of business", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/line-of-business", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the line of business for a facility credentialing workflow. Accepts an array of line of business values (e.g., [\"MEDICAID\", \"COMMERCIAL\"]). An empty array [] will unset/remove the line of business field. Valid values include MEDICAID, MEDICARE, COMMERCIAL, etc." }, { "info": { "name": "Update facility Medicare star ratings", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/medicare-star-ratings", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all Medicare star ratings for a facility credentialing workflow" }, { "info": { "name": "Update facility NPDB reports", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/npdb-reports", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all NPDB reports for a facility credentialing workflow" }, { "info": { "name": "Create an override timeline event for a facility credentialing workflow", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/override-timeline-events", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates an override timeline event for the specified facility credentialing workflow" }, { "info": { "name": "Update facility performance indicators", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/performance-indicators", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all performance indicators for a facility credentialing workflow" }, { "info": { "name": "Update phone numbers in a facility credentialing workflow", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/phone-numbers", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "fcw_1234567890", "type": "path", "description": "Facility credentialing workflow ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the phone numbers for a facility credentialing workflow. This is a complete replacement operation. Send an empty array to clear all phone numbers." }, { "info": { "name": "Verify a record in a facility credentialing workflow section", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/records/:recordId/verify", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "recordId", "value": "specialties-0", "type": "path", "description": "Record identifier in format '{section}-{index}' (e.g., 'specialties-0', 'licenses-1', 'accreditations-2')" }, { "name": "workflowId", "value": "fcw_1234567890", "type": "path", "description": "Facility credentialing workflow ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Marks a specific record as verified by setting verifiedBy (current user) and verifiedDate (current timestamp). The recordId format is '{section}-{index}' (e.g., 'specialties-0', 'licenses-1'). Note: This operation uses a read-modify-write pattern on the entire workflow document. While only verification fields are modified, concurrent updates to other parts of the document may result in lost updates." }, { "info": { "name": "Update facility sanctions", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/sanctions", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all sanctions for a facility credentialing workflow" }, { "info": { "name": "Update facility site visits", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/site-visits", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all site visits for a facility credentialing workflow" }, { "info": { "name": "Update facility specialties", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/specialties", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all specialties for a facility credentialing workflow" }, { "info": { "name": "Create facility supporting document", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/supporting-documents", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "fcw_1234567890", "type": "path", "description": "Facility credentialing workflow ID" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "fileType", "type": "text", "value": "" }, { "name": "state", "type": "text", "value": "" }, { "name": "expirationDate", "type": "text", "value": "" } ] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upload a new supporting document for a facility credentialing workflow" }, { "info": { "name": "Update facility supporting documents using replace-all pattern", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/supporting-documents", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "fcw_1234567890", "type": "path", "description": "Facility credentialing workflow ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update supporting documents for the specified facility credentialing workflow using replace-all pattern. Replaces the entire supporting documents array with the provided list (RESTful PUT semantics)." }, { "info": { "name": "Get facility timeline events", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/timeline-events", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" }, { "name": "endAtId", "value": "", "type": "query", "description": "End at document ID, for backward cursor-based pagination" }, { "name": "filter", "value": "", "type": "query", "description": "Filter criteria as JSON string" }, { "name": "order", "value": "", "type": "query", "description": "Sort order as JSON string" }, { "name": "page", "value": "", "type": "query", "description": "Page number (0-based), for offset-based pagination" }, { "name": "size", "value": "", "type": "query", "description": "Page size" }, { "name": "startAfterId", "value": "", "type": "query", "description": "Start after document ID, for forward cursor-based pagination" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a list of facility timeline events for a facility credentialing workflow" }, { "info": { "name": "Create a timeline event for a facility credentialing workflow", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/timeline-events", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new timeline event for the specified facility credentialing workflow" }, { "info": { "name": "Get timeline event status options", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/timeline-events/status-options", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves available status options and required parameters for timeline events" }, { "info": { "name": "Update a timeline event and workflow in batch", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/timeline-events/:eventId", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "eventId", "value": "", "type": "path", "description": "ID of the timeline event to update" }, { "name": "workflowId", "value": "", "type": "path", "description": "ID of the facility credentialing workflow" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates specific fields of an existing timeline event and its associated workflow in a single atomic transaction. Supports partial updates of nextCredentialingDate, nextCredentialingDateSource, changeReason, and nextCredentialingDateChangeLog fields. Only works with CRED_APPROVED timeline events. Both timeline and workflow are updated in a single transaction batch for data consistency." }, { "info": { "name": "Update user defined fields of a facility in a credentialing workflow", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/facility-credentialing-workflows/:workflowId/userdefinedfields", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "workflowId", "value": "fcw_1234567890", "type": "path", "description": "Facility credentialing workflow ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replaces the entire userDefinedFields object with the provided object (RESTful PUT semantics)." } ] } ], "bundled": true }