match
Searches for patients that match the given demographics using Orchestrate Identity (MPI). Returns a searchset Bundle of candidate matching patients. When exactly one person matches, entries are marked match-grade 'certain' with a search score of 1.0; when more than one person matches, entries are marked match-grade 'possible' with no score. In 'Separate' patient-records mode a single matched person may expand into multiple per-source Patient records, each returned as its own entry.
Applies to: Patient
Requires the operation URL (http://hl7.org/fhir/OperationDefinition/Patient-match) as a scope, or a SMART scope granting read access to the resource type the operation is executed against.
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| count | 0..1 | Integer |
The maximum number of records to return. Defaults to all matched records. |
| onlyCertainMatches | 0..1 | Boolean |
If true, only return results where the match is certain. When true, results are returned only if exactly one person was matched; otherwise an empty searchset is returned. |
| resource | 1..1 | Patient |
The Patient resource containing the demographics to match against the server's patient records. |
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| result | 1..1 | Bundle |
A searchset Bundle containing Patient resources that match the supplied demographics. Each entry includes a match-grade extension ('certain' for a single unambiguous match, otherwise 'possible') and, for a certain match, a search score of 1.0. |