You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/bulk-match.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,13 +41,13 @@ The Admin UI at `/admin/bulk-match` is the recommended way to run bulk matching.
41
41
### Step 1: Prepare the flat table
42
42
43
43
```http
44
-
POST /api/bulk-match/patient-bulk/prepare
44
+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/prepare
45
45
```
46
46
47
47
This creates the flat table, populates it from FHIR resources, and creates indexes. The operation runs asynchronously. Poll the status endpoint to track progress:
48
48
49
49
```http
50
-
GET /api/bulk-match/patient-bulk/status
50
+
GET https://<mdmbox-host>/api/bulk-match/patient-bulk/status
51
51
```
52
52
53
53
The response is an OperationOutcome. The `diagnostics` field contains preparation details as a string:
@@ -71,13 +71,13 @@ Possible statuses: `pending`, `preparing`, `ready`, `failed`.
71
71
To force re-creation of the flat table (e.g., after data changes):
72
72
73
73
```http
74
-
POST /api/bulk-match/patient-bulk/prepare?force=true
74
+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/prepare?force=true
75
75
```
76
76
77
77
### Step 2: Start the bulk match
78
78
79
79
```http
80
-
POST /api/bulk-match/patient-bulk/start
80
+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/start
81
81
Content-Type: application/json
82
82
```
83
83
@@ -118,7 +118,7 @@ Poll the status endpoint or use the Admin UI which auto-refreshes every 2 second
118
118
Once the job completes:
119
119
120
120
```http
121
-
GET /api/bulk-match/patient-bulk/download/{job-id}
121
+
GET https://<mdmbox-host>/api/bulk-match/patient-bulk/download/{job-id}
122
122
```
123
123
124
124
Returns a CSV file with columns:
@@ -135,27 +135,27 @@ Returns a CSV file with columns:
135
135
### Stop a running job
136
136
137
137
```http
138
-
POST /api/bulk-match/patient-bulk/stop
138
+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/stop
139
139
```
140
140
141
141
Workers finish their current batch and exit. For immediate cancellation:
142
142
143
143
```http
144
-
POST /api/bulk-match/patient-bulk/stop?force=true
144
+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/stop?force=true
145
145
```
146
146
147
147
### Resume a stopped job
148
148
149
149
```http
150
-
POST /api/bulk-match/patient-bulk/continue
150
+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/continue
151
151
```
152
152
153
153
Resumes from where it left off — completed batches are not reprocessed.
154
154
155
155
### Archive a job
156
156
157
157
```http
158
-
POST /api/bulk-match/patient-bulk/archive
158
+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/archive
159
159
```
160
160
161
161
Moves a completed, stopped, or failed job to archived status.
0 commit comments