eHealth Infrastructure (v2020.8)

Person name lookup

OPERATION: Person name lookup

The official URL for this operation definition is:

This operation is used to do a lookup on a citizen in the national infrastructure based on the identifier of the person unless the identifier can be resolved locally. The operation returns a 'limited' Person resource with the identifier and name of the person being the only returned attributes in the bundle. The operation is an implementation of on the Person resource.

URL: [base]/Person/$match



The social security number of the person on which this operation is executed, wrapped in a Person. If the person exists in the infrastructure a link to the patient is provided


A bundle containing a set of Person records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in person fragment - check against profile) Note: as this the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource.