Search RelatedPersons

get

https://fhir-api.zapehr.com/r4b/RelatedPerson

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Query Params

identifier

string

An Identifier of the RelatedPerson

address

string

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

birthdate

string

The Related Person's date of birth

address-state

string

A state specified in an address

gender

string

Gender of the related person

active

string

Indicates if the related person record is active

address-postalcode

string

A postal code specified in an address

address-country

string

A country specified in an address

phonetic

string

A portion of name using some kind of phonetic matching algorithm

phone

string

A value in a phone contact

patient

string

The patient this related person is related to

address-use

string

A use code specified in an address

name

string

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

telecom

string

The value in any kind of contact

address-city

string

A city specified in an address

relationship

string

The relationship between the patient and the relatedperson

string

A value in an email contact

Responses

401

Unauthorized

403

Forbidden

500

Internal server error

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of RelatedPersons

400Bad request

404Not found