honeymoose
/
hapi-fhir
mirror of https://github.com/hapifhir/hapi-fhir.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Removed more EMPI refs from the docs

This commit is contained in:
NG 2020-11-19 14:56:18 -05:00
parent 3209faf2fb
commit 4378df7dcb
5 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa_mdm/mdm.md
View File

@ -44,9 +44,9 @@ precedence over automatic links. Once a link for a patient has been manually ver
Follow these steps to enable MDM on the server: Follow these steps to enable MDM on the server:
The [EmpiSettings](/hapi-fhir/apidocs/hapi-fhir-server-empi/ca/uhn/fhir/empi/rules/config/EmpiSettings.html) bean The [MdmSettings](/hapi-fhir/apidocs/hapi-fhir-server-mdm/ca/uhn/fhir/mdm/rules/config/MdmSettings.html) bean
contains configuration settings related to MDM within the server. To enable MDM, the contains configuration settings related to MDM within the server. To enable MDM, the
[setEnabled(boolean)](/hapi-fhir/apidocs/hapi-fhir-server-empi/ca/uhn/fhir/empi/rules/config/EmpiSettings.html#setEnabled(boolean)) [setEnabled(boolean)](/hapi-fhir/apidocs/hapi-fhir-server-mdm/ca/uhn/fhir/mdm/rules/config/MdmSettings.html#setEnabled(boolean))
property should be enabled. property should be enabled.
See [MDM EID Settings](/hapi-fhir/docs/server_jpa_mdm/mdm_eid.html#empi-eid-settings) for a description of the EID-related settings. See [MDM EID Settings](/hapi-fhir/docs/server_jpa_mdm/mdm_eid.html#mdm-eid-settings) for a description of the EID-related settings.

4
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa_mdm/mdm_details.md
View File

@ -45,7 +45,7 @@ Below are some simplifying principles HAPI MDM follows to reduce complexity and
1. Every Patient in the system has a MATCH link to at most one Golden Patient resource. 1. Every Patient in the system has a MATCH link to at most one Golden Patient resource.
1. The only Patient resources in the system that do not have a MATCH link are those that have the 'NO-EMPI' tag or 1. The only Patient resources in the system that do not have a MATCH link are those that have the 'NO-MDM' tag or
those that have POSSIBLE_MATCH links pending review. those that have POSSIBLE_MATCH links pending review.
1. The HAPI MDM rules define a single identifier system that holds the external enterprise id ("EID"). If a Patient has 1. The HAPI MDM rules define a single identifier system that holds the external enterprise id ("EID"). If a Patient has
@ -76,7 +76,7 @@ The outcome of each of these comparisons is either NO_MATCH, POSSIBLE_MATCH or M
<!--- <!---
1. Whenever a MATCH link is established between a Patient resource and a Golden Patient resource, that Patient is always 1. Whenever a MATCH link is established between a Patient resource and a Golden Patient resource, that Patient is always
added to that Golden Patient resource links. All MATCH links have corresponding Golden Patient resource links and all added to that Golden Patient resource links. All MATCH links have corresponding Golden Patient resource links and all
Golden Patient resource links have corresponding MATCH empi-link records. You can think of the fields of the empi-link Golden Patient resource links have corresponding MATCH mdm-link records. You can think of the fields of the mdm-link
records as extra meta-data associated with each Person.link.target. records as extra meta-data associated with each Person.link.target.
1. Each record in the `MPI_LINK` table corresponds to a `link.target` entry on a Person resource unless it is a NO_MATCH record. HAPI MDM uses the following convention for the Person.link.assurance level: 1. Each record in the `MPI_LINK` table corresponds to a `link.target` entry on a Person resource unless it is a NO_MATCH record. HAPI MDM uses the following convention for the Person.link.assurance level:

14
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa_mdm/mdm_eid.md
View File

@ -9,12 +9,12 @@ incoming Patient had no EID assigned, an internal EID will be created for it. Th
## MDM EID Settings ## MDM EID Settings
The [EmpiSettings](/hapi-fhir/apidocs/hapi-fhir-server-empi/ca/uhn/fhir/empi/rules/config/EmpiSettings.html) bean The [MdmSettings](/hapi-fhir/apidocs/hapi-fhir-server-mdm/ca/uhn/fhir/mdm/rules/config/MdmSettings.html) bean
contains two EID related settings. Both are enabled by default. contains two EID related settings. Both are enabled by default.
* **Prevent EID Updates** ([JavaDoc](/hapi-fhir/apidocs/hapi-fhir-server-empi/ca/uhn/fhir/empi/rules/config/EmpiSettings.html#setPreventEidUpdates(boolean))): If this is enabled, then once an EID is set on a resource, it cannot be changed. If disabled, patients may have their EID updated. * **Prevent EID Updates** ([JavaDoc](/hapi-fhir/apidocs/hapi-fhir-server-mdm/ca/uhn/fhir/mdm/rules/config/MdmSettings.html#setPreventEidUpdates(boolean))): If this is enabled, then once an EID is set on a resource, it cannot be changed. If disabled, patients may have their EID updated.
* **Prevent multiple EIDs**: ([JavaDoc](/hapi-fhir/apidocs/hapi-fhir-server-empi/ca/uhn/fhir/empi/rules/config/EmpiSettings.html#setPreventMultipleEids(boolean))): If this is enabled, then a resource cannot have more than one EID, and incoming resources that break this rule will be rejected. * **Prevent multiple EIDs**: ([JavaDoc](/hapi-fhir/apidocs/hapi-fhir-server-mdm/ca/uhn/fhir/mdm/rules/config/MdmSettings.html#setPreventMultipleEids(boolean))): If this is enabled, then a resource cannot have more than one EID, and incoming resources that break this rule will be rejected.
## MDM EID Scenarios ## MDM EID Scenarios
@ -26,13 +26,13 @@ diagrams outline how EIDs are replicated from Patient resources to their linked
<a href="/hapi-fhir/docs/images/empi-create-1.svg"><img src="/hapi-fhir/docs/images/empi-create-1.svg" alt="MDM Create 1" style="margin-left: 15px; margin-bottom: 15px;" /></a> <a href="/hapi-fhir/docs/images/empi-create-1.svg"><img src="/hapi-fhir/docs/images/empi-create-1.svg" alt="MDM Create 1" style="margin-left: 15px; margin-bottom: 15px;" /></a>
<a href="/hapi-fhir/docs/images/empi-create-2.svg"><img src="/hapi-fhir/docs/images/empi-create-2.svg" alt="MDM Create 1" style="margin-left: 15px; margin-bottom: 15px;" /></a> <a href="/hapi-fhir/docs/images/empi-create-2.svg"><img src="/hapi-fhir/docs/images/empi-create-2.svg" alt="MDM Create 2" style="margin-left: 15px; margin-bottom: 15px;" /></a>
<a href="/hapi-fhir/docs/images/empi-create-3.svg"><img src="/hapi-fhir/docs/images/empi-create-3.svg" alt="MDM Create 1" style="margin-left: 15px; margin-bottom: 15px;" /></a> <a href="/hapi-fhir/docs/images/empi-create-3.svg"><img src="/hapi-fhir/docs/images/empi-create-3.svg" alt="MDM Create 3" style="margin-left: 15px; margin-bottom: 15px;" /></a>
<a href="/hapi-fhir/docs/images/empi-create-4.svg"><img src="/hapi-fhir/docs/images/empi-create-4.svg" alt="MDM Create 1" style="margin-left: 15px; margin-bottom: 15px;" /></a> <a href="/hapi-fhir/docs/images/empi-create-4.svg"><img src="/hapi-fhir/docs/images/empi-create-4.svg" alt="MDM Create 4" style="margin-left: 15px; margin-bottom: 15px;" /></a>
<a href="/hapi-fhir/docs/images/empi-create-5.svg"><img src="/hapi-fhir/docs/images/empi-create-5.svg" alt="MDM Create 1" style="margin-left: 15px; margin-bottom: 15px;" /></a> <a href="/hapi-fhir/docs/images/empi-create-5.svg"><img src="/hapi-fhir/docs/images/empi-create-5.svg" alt="MDM Create 5" style="margin-left: 15px; margin-bottom: 15px;" /></a>
## MDM EID Update Scenarios ## MDM EID Update Scenarios

22
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa_mdm/mdm_operations.md
View File

@ -1,8 +1,8 @@
# MDM Operations # MDM Operations
MDM links are managed by MDM Operations. These operations are supplied by a [plain provider](/docs/server_plain/resource_providers.html#plain-providers) called [EmpiProvider](/hapi-fhir/apidocs/hapi-fhir-server-empi/ca/uhn/fhir/empi/provider/EmpiProviderR4.html). MDM links are managed by MDM Operations. These operations are supplied by a [plain provider](/docs/server_plain/resource_providers.html#plain-providers) called [MdmProvider](/hapi-fhir/apidocs/hapi-fhir-server-mdm/ca/uhn/fhir/mdm/provider/MdmProviderR4.html).
In cases where the operation changes data, if a resource id parameter contains a version (e.g. `Patient/123/_history/1`), then the operation will fail with a 409 CONFLICT if that is not the latest version of that resource. This feature can be used to prevent update conflicts in an environment where multiple users are working on the same set of empi links. In cases where the operation changes data, if a resource id parameter contains a version (e.g. `Patient/123/_history/1`), then the operation will fail with a 409 CONFLICT if that is not the latest version of that resource. This feature can be used to prevent update conflicts in an environment where multiple users are working on the same set of mdm links.
## Query links ## Query links
@ -108,7 +108,7 @@ This operation returns a `Parameters` resource that looks like the following:
## Query Duplicate Golden Resources ## Query Duplicate Golden Resources
Use the `$empi-duplicate-golden-resources` operation to request a list of duplicate golden resources. Use the `$mdm-duplicate-golden-resources` operation to request a list of duplicate golden resources.
This operation takes no parameters. This operation takes no parameters.
### Example ### Example
@ -116,7 +116,7 @@ This operation takes no parameters.
Use an HTTP GET to the following URL to invoke this operation: Use an HTTP GET to the following URL to invoke this operation:
```url ```url
http://example.com/$empi-duplicate-golden-resources http://example.com/$mdm-duplicate-golden-resources
``` ```
This operation returns `Parameters` similar to `$mdm-query-links`: This operation returns `Parameters` similar to `$mdm-query-links`:
@ -146,7 +146,7 @@ This operation returns `Parameters` similar to `$mdm-query-links`:
## Unduplicate Golden Resources ## Unduplicate Golden Resources
Use the `$empi-not-duplicate` operation to mark duplicate golden resources as not duplicates. Use the `$mdm-not-duplicate` operation to mark duplicate golden resources as not duplicates.
This operation takes the following parameters: This operation takes the following parameters:
<table class="table table-striped table-condensed"> <table class="table table-striped table-condensed">
@ -183,7 +183,7 @@ This operation takes the following parameters:
Use an HTTP POST to the following URL to invoke this operation: Use an HTTP POST to the following URL to invoke this operation:
```url ```url
http://example.com/$empi-not-duplicate http://example.com/$mdm-not-duplicate
``` ```
The following request body could be used: The following request body could be used:
@ -215,7 +215,7 @@ When the operation is successful, it returns the following `Parameters`:
## Update Link ## Update Link
Use the `$mdm-update-link` operation to change the `matchResult` update of an empi link. This operation takes the following parameters: Use the `$mdm-update-link` operation to change the `matchResult` update of an mdm link. This operation takes the following parameters:
<table class="table table-striped table-condensed"> <table class="table table-striped table-condensed">
<thead> <thead>
@ -254,14 +254,14 @@ Use the `$mdm-update-link` operation to change the `matchResult` update of an em
</tbody> </tbody>
</table> </table>
Empi links updated in this way will automatically have their `linkSource` set to `MANUAL`. Mdm links updated in this way will automatically have their `linkSource` set to `MANUAL`.
### Example ### Example
Use an HTTP POST to the following URL to invoke this operation: Use an HTTP POST to the following URL to invoke this operation:
```url ```url
http://example.com/$empi-update-link http://example.com/$mdm-update-link
``` ```
The following request body could be used: The following request body could be used:
@ -557,6 +557,6 @@ This operation can also be done at the Instance level. When this is the case, th
The following are examples of Instance level POSTs, which require no parameters. The following are examples of Instance level POSTs, which require no parameters.
```url ```url
http://example.com/Patient/123/$empi-submit http://example.com/Patient/123/$mdm-submit
http://example.com/Practitioner/456/$empi-submit http://example.com/Practitioner/456/$mdm-submit
``` ```

4
pom.xml
View File

@ -2082,7 +2082,7 @@
<copy todir="target/site/apidocs-jpaserver"> <copy todir="target/site/apidocs-jpaserver">
<fileset dir="hapi-fhir-jpaserver-base/target/site/apidocs"/> <fileset dir="hapi-fhir-jpaserver-base/target/site/apidocs"/>
</copy> </copy>
<copy todir="target/site/apidocs-jpaserver-empi"> <copy todir="target/site/apidocs-jpaserver-mdm">
<fileset dir="hapi-fhir-jpaserver-mdm/target/site/apidocs"/> <fileset dir="hapi-fhir-jpaserver-mdm/target/site/apidocs"/>
</copy> </copy>
<copy todir="target/site/apidocs-jpaserver-batch"> <copy todir="target/site/apidocs-jpaserver-batch">
@ -2094,7 +2094,7 @@
<copy todir="target/site/apidocs-server"> <copy todir="target/site/apidocs-server">
<fileset dir="hapi-fhir-server/target/site/apidocs"/> <fileset dir="hapi-fhir-server/target/site/apidocs"/>
</copy> </copy>
<copy todir="target/site/apidocs-server-empi"> <copy todir="target/site/apidocs-server-mdm">
<fileset dir="hapi-fhir-server-mdm/target/site/apidocs"/> <fileset dir="hapi-fhir-server-mdm/target/site/apidocs"/>
</copy> </copy>
<copy todir="target/site/xref-jpaserver"> <copy todir="target/site/xref-jpaserver">