Patient
Link to FHIR STU3 Patient Resource
Link to HL7 UK INTEROpen CareConnect FHIR Patient Profile
Read
GET [baseUrl]/Patient/[id] Return a single Patient for the specified id.
All requests SHALL contain a valid Authorization header and SHALL contain an Accept header. The Accept header indicates the format of the response the client is able to understand, this will be one of the following application/json+fhir or application/xml+fhir.
Search Parameters
GET [baseUrl]/Patient?[searchParameters] Fetches a bundle of all Patient resources for the specified patient or search criteria.
All requests SHALL contain a valid Authorization header and SHALL contain an Accept header. The Accept header indicates the format of the response the client is able to understand, this will be one of the following application/json+fhir or application/xml+fhir.
This implementation guide outlines some suggested search parameters for the Patient resource in the table below.
| Name | Type | Description | Path |
|---|---|---|---|
| address-postalcode | string | A postalCode specified in an address | Patient.address.postalCode |
| birthdate | date | The patient's date of birth | Patient.birthDate |
| token | A value in an email contact | Patient.telecom | |
| (system=email) | |||
| family | string | A portion of the family name of the patient | Patient.name.family |
| gender | token | Gender of the patient | Patient.gender |
| given | string | A portion of the given name of the patient | Patient.name.given |
| identifier | token | A patient identifier (NHS Number, Hospital Number, etc) | Patient.identifier |
| name | string | A portion of either family or given name of the patient | Patient.name |
| phone | token | A value in a phone contact | Patient.telecom(system=phone) |
We support the following search combinations:
name + gender
name + birthdate
family + gender
given + gender
address-postalcode
GET [baseUrl]/Patient?address-postalcode=address-postalcode
GET [baseUrl]/Patient?address-postalcode=NG10%201ZZ
Return all Patient resources with Post Code of NG10 1ZZ.
birthdate
GET [baseUrl]/Patient?birthdate=[date] See date for details on this parameter. ‘birthdate’ can be used multiple times as a search parameter
GET [baseUrl]/Patient?birthdate=ge2010-01-01&birthdate=le2011-12-31
Return all Patient resources that have a birthdate greater than or equal to 1st Jan 2010, a birthdate less than or equal to 31st Dec 2011.
GET [baseUrl]/Patient?email=email See string for details on this parameter.
GET [baseUrl]/Patient?email=bernie.kanfeld@chumhum.com
Return all Patient resources with email address of bernie.kanfeld@chumhum.com.
family
GET [baseUrl]/Patient?family=family See string for details on this parameter.
GET [baseUrl]/Patient?family=kanfeld
Return all Patient resources with surname of Kanfeld.
gender
GET [baseUrl]/Patient?gender=[system]|[code] GET [baseUrl]/Patient?gender=[code] See token for details on this parameter.
GET [baseUrl]/Patient?gender=female
Return all Patient resources with Administrative Sex of female.
given
GET [baseUrl]/Patient?given=given See string for details on this parameter.
GET [baseUrl]/Patient?given=bernie
Return all Patient resources with forename of Bernie.
identifier (NHS Number, Hospital Number, etc)
GET [baseUrl]/Patient?identifier=[system]|[code] GET [baseUrl]/Patient?identifier=[code]
GET [baseUrl]/Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210
Return all Patient resources with NHS Number of 9876543210.
name
GET [baseUrl]/Patient?name=name
GET [baseUrl]/Patient?name=bernie%20kanfeld
Return all Patient resources with name of Bernie Kanfeld.
phone
GET [baseUrl]/Patient?phone=phone
GET [baseUrl]/Patient?phone=07999123456
Return all Patient resources with phone number of 07999 123456.
Search Response
If the search fails (cannot be executed, not that there is no matches), the return value is a status code 4xx or 5xx with an OperationOutcome.
If the search succeeds, the return content is a Bundle with type = searchset containing the results of the search as a paged list of resources.