Care Connect API
4.0.0 - CI Build

Care Connect API - Local Development build (v4.0.0). See the Directory of published versions

Patient

Search Parameters

Name Type Description Conformance Path
address-postalcode string A postalCode specified in an address MAY Patient.address.postalCode
birthdate date The patient's date of birth SHALL Patient.birthDate
email token A value in an email contact MAY Patient.telecom
(system=email)
family string A portion of the family name of the patient SHALL Patient.name.family
gender token Gender of the patient SHALL Patient.gender
given string A portion of the given name of the patient SHALL Patient.name.given
identifier token A patient identifier (NHS Number, Hospital Number, etc) SHALL Patient.identifier
name string A portion of either family or given name of the patient SHALL Patient.name
phone token A value in a phone contact MAY Patient.telecom(system=phone)

Client systems SHALL provide at least two parameters of differing types, unless searching on identifier where one parameter is permitted. Systems SHALL support the following search combinations:

  • name + gender
  • name + birthdate
  • family + gender
  • given + gender