patient.match

Native Request Elements

Name	Description	Required	Is Array	Types
Patient	A complete set of patient details for MPI matching (e.g., Patient resource)	✓	false	Resource
onlySingleMatch	If true, returns only the single most appropriate match when multiple potential matches exist	false	false	boolean
onlyCertainMatches	If true, returns only matches that the server is certain belong to the same patient	false	false	boolean
count	Maximum number of records to return. Server determines default if not specified	false	false	integer

Native Response Elements

Name	Description	Required	Is Array	Types
return	A Bundle of type "searchset" containing potential patient matches	✓	false	Bundle

Bundle Contents

The searchset Bundle may contain:

Patient resources representing possible matches
Optional OperationOutcome resource with additional information about the search results (e.g., warnings, match count information)

If the operation fails, it will return:

OperationOutcome resource
HTTP 400 Bad Request status code (e.g., for security issues or insufficient patient properties)

Example Payload


{
  "resourceType": "Bundle",
  "id": "26419249-18b3-45de-b10e-dca0b2e72b",
  "meta": {
    "lastUpdated": "2016-03-18T03:28:49Z"
  },
  "type": "searchset",
  "total": 2,
  "entry": [{
    "fullUrl": "http://server/path/Patient/example",
    "resource": {
      "resourceType": "Patient",
      "id": "example",
      .. snip ...
    },
    "search": {
      "extension": [{
        "url": "http://hl7.org/fhir/StructureDefinition/match-grade",
        "valueCode": "certain"
      }],
      "mode": "match",
      "score": 0.9
    }
  },{
    "fullUrl": "http://server/path/Patient/292",
    "resource": {
      "resourceType": "Patient",
      "id": "292",
      .. snip ...
    },
    "search": {
      "extension": [{
        "url": "http://hl7.org/fhir/StructureDefinition/match-grade",
        "valueCode": "possible"
      }],
      "mode": "match",
      "score": 0.2
    }
  }]
}

patient.match

Native Request Elements

Native Response Elements

Bundle Contents

Example Payload

On this page