Partial addition of docs for batch run

This commit is contained in:
Tadgh 2020-07-30 18:21:35 -07:00
parent 07f9e8466b
commit f731e44303
1 changed files with 64 additions and 0 deletions

View File

@ -512,5 +512,69 @@ This operation returns the number of EMPI links that were cleared. The following
} }
``` ```
## Batch-creating EMPI Links
The `$empi-batch-run` operation is used to batch-process patients and practitioners. In normal operation, an interceptor will
run EMPI processing over Resources when they are updated or created, but this is not the only context in which you would want to
execute EMPI processing against resources. In the rules-tuning phase of your setup, you may use `$empi-batch-run` to quickly apply EMPI rules across multiple Resources.
After the operation is complete, all targeted EMPI links will be removed from the system, and the Person resources which were involves in those links will be deleted and expunged
from the server.
This operation takes a single optional Parameter.
<table class="table table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Cardinality</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>resourceType</td>
<td>String</td>
<td>0..1</td>
<td>
The target Resource type you would like to clear. Currently limited to Patient/Practitioner. If omitted, will operate over all links.
</td>
</tr>
</tbody>
</table>
### Example
Use an HTTP POST to the following URL to invoke this operation:
```url
http://example.com/$empi-clear
```
The following request body could be used:
```json
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resourceType",
"valueString": "Patient"
} ]
}
```
This operation returns the number of EMPI links that were cleared. The following is a sample response:
```json
{
"resourceType": "Parameters",
"parameter": [ {
"name": "reset",
"valueDecimal": 5
} ]
}
```