MyHealth@Eu NCPeH API
0.0.1 - ci-build 150

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

Patient Search

The Patient Search is common to all the options and it is documented in this common page.

Business View

The overall business scenarios are described in the Scenarios page

Hereafter the Patient Search fragment

<?xml version="1.0" encoding="us-ascii" standalone="no"?>RequestorRequestorRequesting NCPRequesting NCPResponding NCPResponding NCPNational InfrastructureNational InfrastructurePatient SearchPatient IdentificationIdentification RequestPatient SearchPatient SearchPatient Minimal DataPatient Minimal DataPatient Minimal DataPatient OK

Application View

Interaction diagram

<?xml version="1.0" encoding="us-ascii" standalone="no"?>Requesting NCPRequesting NCPResponding NCPResponding NCPPatient SearchPatient Search$server/Patient?<searchParameters><modifiers>Bundle.where(type='searchSet').entry.resource.ofType(Patient)

Request

Search parameters
Parameter Opt searchParameter type notes
business identifier SHOULD identifier token  
name MAY name string  
birth date MAY birthdate date  
gender MAY gender token  
Modifiers

No modifers required

Search result parameters

Consumers are suggested to explictly indicate the elements that are expected to be used for the Patient Identification and minimize the patient information exchanged, by using the _elements Search result parameter.

Examples

All the Patient having this identifier

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

All the Patient having this identifier (only essential information returned)

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

All the Patient having in the name "doe" born the 1985-01-14 and of male gender

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

Response

Returned Patient Data
Parameter Opt
business identifier SHALL
name SHALL
birth date SHALL
gender SHALL

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