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

Merge pull request #2314 from hapifhir/2313/error-in-mdm-docs 

Add documentation fixes for MDM-match
This commit is contained in:
Tadgh 2021-01-22 09:26:20 -05:00 committed by GitHub
parent d5250e6f1a edd9769686
commit 71c76e3ea1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -350,9 +350,9 @@ This operation returns the merged Golden Resource (`toGoldenResourceId`).
## Querying the Patient Resource
When MDM is enabled, the [$match operation](http://hl7.org/fhir/patient-operation-match.html) will be enabled on the JPA Server.
When MDM is enabled, the [$match operation](http://hl7.org/fhir/patient-operation-match.html) will be enabled on the JPA Server for Patient and Practitioner resources.
This operation allows a Patient resource to be submitted to the endpoint, and the system will attempt to find and return any Patient resources that match it according to the matching rules. The response includes a search score field that is calculated by averaging the number of matched rules against total rules checked for the Patient resource. Appropriate match grade extension is also included.
This operation allows a Patient or Practitioner resource to be submitted to the endpoint, and the system will attempt to find and return any Patient resources that match it according to the matching rules. The response includes a search score field that is calculated by averaging the number of matched rules against total rules checked for the Patient resource. Appropriate match grade extension is also included.
For example, the following request may be submitted:
@ -420,12 +420,12 @@ Sample response for the Patient match is included below:
## Querying the Other Supported MDM Resources via `/$mdm-match`
Query operations on any other supported MDM type is also allowed. This operation will find resources that match the provided parameters according to the matching rules. The response includes a search score field that is calculated by averaging the number of matched rules against total rules checked for the Patient resource. Appropriate match grade extension is also included in the response.
Query operations on any other supported MDM type are also allowed via the server-level operation `/$mdm-match`. This operation will find resources that match the provided parameters according to the matching rules. The response includes a search score field that is calculated by averaging the number of matched rules against total rules checked for the Patient resource. Appropriate match grade extension is also included in the response.
The request below may be submitted to search for `Orgaization` in case it defined as a supported MDM type:
The request below may be submitted to search for `Organization` in case it defined as a supported MDM type:
```http
POST /Organization/$mdm-match
POST /$mdm-match
Content-Type: application/fhir+json; charset=UTF-8
{
@ -441,9 +441,10 @@ Content-Type: application/fhir+json; charset=UTF-8
]
}
```
MDM will respond with the appropriate resource bundle.
Note that the request goes to the root of the FHIR server, and not the `Organization` endpoint. Since this is not in the FHIR spec directly, it was decided that this would be a separate operation from the Patient/Practitioner `/$match` operation.
## Clearing MDM Links
The `$mdm-clear` operation is used to batch-delete MDM links and related Golden Resources from the database. This operation is meant to be used during the rules-tuning phase of the MDM implementation so that you can quickly test your ruleset. It permits the user to reset the state of their MDM system without manual deletion of all related links and Golden Resources.

3
hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/provider/ProviderConstants.java
View File

@ -62,12 +62,9 @@ public class ProviderConstants {
* EMPI Operations
*/
public static final String EMPI_MATCH = "$match";
//TODO GGG MDM: implement a server-level MDM match to complement the FHIR-spec $match for /Patient
public static final String MDM_MATCH = "$mdm-match";
public static final String MDM_MATCH_RESOURCE = "resource";
public static final String MDM_RESOURCE_TYPE = "resourceType";
//TODO GGG MDM: rename all these vars
public static final String MDM_MERGE_GOLDEN_RESOURCES = "$mdm-merge-golden-resources";
public static final String MDM_MERGE_GR_FROM_GOLDEN_RESOURCE_ID = "fromGoldenResourceId";
public static final String MDM_MERGE_GR_TO_GOLDEN_RESOURCE_ID = "toGoldenResourceId";