$match
FHIR match operation is defined on Patient resource. Aidbox extends it to all resource types for which MDM is configured.
This operation finds all resources which match (i.e. are similar to) the given resource.
This operation translates to aidbox.mdm/match RPC call. The RPC has simpler syntax and you can adjust threshold values. Consider using it if you are not required to use FHIR syntax.
POST /fhir/<resourceType>/$match
resourceType: Parameters
parameter:
- name: resource
resource:
# Resource in FHIR format to match against.
# This must be the resource contents,
# not a reference to another resource
- name: onlyCertainMatches # This parameter is optional
valueBoolean: true # or false
POST /<resourceType>/$match?threshold=<threshold-value>
# Resource in Aidbox format to match against.
# This must be the resource contents,
# not a reference to another resource.
The
threshold parameter is not required. It specifies minimum score for a match to be returned.POST /fhir/Patient/$match
resourceType: Parameters
parameter:
- name: resource
resource:
name:
- given:
- John
family: Smith-Johnson-Williams
birthDate: "2000-01-01"
- name: onlyCertainMatches
valueBoolean: true
Example output
resourceType: Bundle
type: searchset
entry:
- score: 0.99
resource:
name:
- given:
- John
family: Smith-Johnson-Williams
address:
- city: London
birthDate: "2000-01-01"
resourceType: Patient
id: pt-1
POST /Patient/$match?threshold=0.95
name:
- given:
- John
family: Smith-Johnson-Williams
birthDate: "2000-01-01"
Example output
resourceType: Bundle
type: searchset
entry:
- score: 0.99
resource:
name:
- given:
- John
family: Smith-Johnson-Williams
address:
- city: London
birthDate: "2000-01-01"
resourceType: Patient
id: pt-1
Last modified 20d ago