Skip to content

Commit 80b326a

Browse files
Prefix URLs with <mdmbox-host> in all examples
1 parent b67ebbf commit 80b326a

5 files changed

Lines changed: 15 additions & 17 deletions

File tree

docs/bulk-match.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ The Admin UI at `/admin/bulk-match` is the recommended way to run bulk matching.
4141
### Step 1: Prepare the flat table
4242

4343
```http
44-
POST /api/bulk-match/patient-bulk/prepare
44+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/prepare
4545
```
4646

4747
This creates the flat table, populates it from FHIR resources, and creates indexes. The operation runs asynchronously. Poll the status endpoint to track progress:
4848

4949
```http
50-
GET /api/bulk-match/patient-bulk/status
50+
GET https://<mdmbox-host>/api/bulk-match/patient-bulk/status
5151
```
5252

5353
The response is an OperationOutcome. The `diagnostics` field contains preparation details as a string:
@@ -71,13 +71,13 @@ Possible statuses: `pending`, `preparing`, `ready`, `failed`.
7171
To force re-creation of the flat table (e.g., after data changes):
7272

7373
```http
74-
POST /api/bulk-match/patient-bulk/prepare?force=true
74+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/prepare?force=true
7575
```
7676

7777
### Step 2: Start the bulk match
7878

7979
```http
80-
POST /api/bulk-match/patient-bulk/start
80+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/start
8181
Content-Type: application/json
8282
```
8383

@@ -118,7 +118,7 @@ Poll the status endpoint or use the Admin UI which auto-refreshes every 2 second
118118
Once the job completes:
119119

120120
```http
121-
GET /api/bulk-match/patient-bulk/download/{job-id}
121+
GET https://<mdmbox-host>/api/bulk-match/patient-bulk/download/{job-id}
122122
```
123123

124124
Returns a CSV file with columns:
@@ -135,27 +135,27 @@ Returns a CSV file with columns:
135135
### Stop a running job
136136

137137
```http
138-
POST /api/bulk-match/patient-bulk/stop
138+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/stop
139139
```
140140

141141
Workers finish their current batch and exit. For immediate cancellation:
142142

143143
```http
144-
POST /api/bulk-match/patient-bulk/stop?force=true
144+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/stop?force=true
145145
```
146146

147147
### Resume a stopped job
148148

149149
```http
150-
POST /api/bulk-match/patient-bulk/continue
150+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/continue
151151
```
152152

153153
Resumes from where it left off — completed batches are not reprocessed.
154154

155155
### Archive a job
156156

157157
```http
158-
POST /api/bulk-match/patient-bulk/archive
158+
POST https://<mdmbox-host>/api/bulk-match/patient-bulk/archive
159159
```
160160

161161
Moves a completed, stopped, or failed job to archived status.

docs/match-operation.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,14 @@ description: Use the $match operation to find potential duplicate FHIR resources
66

77
The `$match` operation performs a probabilistic search using a matching model and returns potential duplicates ranked by match score.
88

9-
{% hint style="warning" %}
10-
A MatchingModel must be created before using `$match`. See [Matching models](matching-models.md).
11-
{% endhint %}
9+
A [MatchingModel](matching-models.md) must be created before using `$match`.
1210

1311
## Match a resource
1412

1513
Send a FHIR Parameters resource containing the record to match:
1614

1715
```http
18-
POST /api/fhir/Patient/$match
16+
POST https://<mdmbox-host>/api/fhir/Patient/$match
1917
Content-Type: application/json
2018
```
2119

@@ -42,7 +40,7 @@ Content-Type: application/json
4240
To match an existing resource against all others:
4341

4442
```http
45-
POST /api/fhir/Patient/123/$match?model-id=patient-model
43+
POST https://<mdmbox-host>/api/fhir/Patient/123/$match?model-id=patient-model
4644
```
4745

4846
No request body is needed — MDMbox retrieves the resource by ID and runs the match.

docs/matching-models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Used by the `$match` operation for online queries. Works directly against FHIR r
9494
### Create a model
9595

9696
```http
97-
POST /api/models
97+
POST https://<mdmbox-host>/api/models
9898
Content-Type: application/json
9999
```
100100

docs/merge-operation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `$merge` operation merges two FHIR resources by executing a client-provided
1616
## Request
1717

1818
```http
19-
POST /api/$merge
19+
POST https://<mdmbox-host>/api/$merge
2020
Content-Type: application/json
2121
```
2222

docs/referencing-operation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The `$referencing` operation finds all FHIR resources in the database that refer
99
## Request
1010

1111
```http
12-
POST /api/fhir/Patient/123/$referencing
12+
POST https://<mdmbox-host>/api/fhir/Patient/123/$referencing
1313
Content-Type: application/json
1414
```
1515

0 commit comments

Comments
 (0)