MyHealth@Eu NCPeH API
10.0.0-ci - ci-build 150

MyHealth@Eu NCPeH API - Local Development build (v10.0.0-ci) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Patient Search

Business View

The overall business scenarios associated to this task is described in the Business view page

Application View

The implementation-independent sequence diagrams associated to this task is described in the Application view page

Implementation

The Patient Identification is realized by performing these steps:

  • The Requesting NCP sends a Patient search request to the Responding NCP.
  • The Responding NCP searches for the requested patient(s) and returns a HL7 FHIR Bundle containing Patient resources.
  • The returned Bundle contains all matching Patient entries, based on the provided search parameters.

Responding NCPRequesting NCPResponding NCPRequesting NCPRequesting NCPResponding NCPResponding NCPResponding NCPPatient SearchPatient SearcheHDSI Patient Identification RequesteHDSI Patient Identification Response

Figure 1 - Patient Identification

eHDSI Patient Identification Request

The Requesting NCP initiates a search query for a Patient using the FHIR API:

  GET $server/Patient?<searchParameters><modifiers>

The query includes search parameters and modifiers to refine the search criteria. Details below.

Search parameters
Note: The conformance verbs, such as SHALL, used in the "Requesting NCP" and "Responding NCP" optionality columns indicate the actor's capability to support that parameter, not whether the parameter is actually used in a given search.
Parameter searchParameter type Requesting NCP Responding NCP notes
business identifier identifier token SHALL SHALL
name name string SHALL SHOULD
birth date birthdate date SHALL SHOULD
gender gender token SHALL SHOULD

Search result parameters

Requesting NCP are encouraged to explicitly indicate the elements expected to be used for Patient Identification and to minimize the patient information exchanged by using the _elements search result parameter.

Modifiers

No modifers required

eHDSI Patient Identification Response

The Responding NCP processes the request and returns a FHIR Bundle containing the search results, in accordance with the rules specified in HL7 FHIR - RESTful Search) and in Search Results.

The Bundle contains entries of type Patient:

  Bundle.where(type='searchSet').entry.resource.ofType(Patient)

The Bundle of type 'searchSet' should be created

The National Infrastructure returns Patient resources conformant with the PatientMinimalMyHealthEu profile.

HTTP Error Response Codes

HTTP Response Description
401 Unauthorized authorization is required for the interaction that was attempted
404 Not Found resource type not supported, or not a FHIR end-point
410 Gone resource deleted or no more active

Examples

All patients with this identifier

GET $server/Patient?identifier=http://identifiers.mycountry|123456789

All patients with this identifier (only essential information returned)

GET $server/Patient?identifier=http://identifiers.mycountry|123456789&_elements=identifier,active,name,birthDate,gender

All patients with both identifiers

GET $server/Patient?identifier=http://first-id.mycountry|123456789&http://second-id.mycountry|987654321

All patients with in the name "doe" born the 1985-01-14 and of male gender

GET $server/Patient?name=doe&birthdate=eq1985-01-14&sex=male