v1

latestOpenAPI 3.0.12026-07-261252271.9 KB
Patient

search-type: Search for Patient instances

This is a search type

get/Patient

Query parameters

_idstring

The ID of the resource

activestring

Whether the patient record is active

addressstring

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

address-citystring

A city specified in an address

address-countrystring

A country specified in an address

address-postalcodestring

A postalCode specified in an address

address-statestring

A state specified in an address

address-usestring

A use code specified in an address

string date-time
OR
string date

The patient's date of birth

deceasedstring

This patient has been marked as deceased, or as a death date entered

emailstring

A value in an email contact

familystring

A portion of the family name of the patient

genderstring

Gender of the patient

general-practitionerstring

Patient's nominated general practitioner, not the organization that manages the record

givenstring

A portion of the given name of the patient

identifierstring

A patient identifier

languagestring

Language code (irrespective of use value)

linkstring

All patients linked to the given patient

link-typestring
namestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

phonestring

A value in a phone contact

telecomstring

The value in any kind of telecom details of the patient

Response

Success