RelatedPerson

Normative Base

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/RelatedPerson

Interaction	Method	Path
Read	GET	/fhir/R5/RelatedPerson/[id]
Vread	GET	/fhir/R5/RelatedPerson/[id]/_history/[vid]
Update	PUT	/fhir/R5/RelatedPerson/[id]
Patch	PATCH	/fhir/R5/RelatedPerson/[id]
Delete	DELETE	/fhir/R5/RelatedPerson/[id]
Create	POST	/fhir/R5/RelatedPerson
Search	GET	/fhir/R5/RelatedPerson?...
History	GET	/fhir/R5/RelatedPerson/[id]/_history
Type-history	GET	/fhir/R5/RelatedPerson/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	A human identifier for this person
active	boolean	0..1	Whether this related person's record is in active use modifier
patient	Reference	1..1	The patient this person is related to
relationship	CodeableConcept	0..*	The relationship of the related person to the patient
name	HumanName	0..*	A name associated with the person
telecom	ContactPoint	0..*	A contact detail for the person
gender	code	0..1	male
birthDate	date	0..1	The date on which the related person was born
address	Address	0..*	Address where the related person can be contacted or visited
photo	Attachment	0..*	Image of the person
period	Period	0..1	Period of time that this relationship is considered valid
communication	BackboneElement	0..*	A language which may be used to communicate with the related person about the patient's health

Resource-specific search parameters

Parameter	Type	Description
active	token	Indicates if the related person record is active
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
address-city	string	A city specified in an address
address-country	string	A country specified in an address
address-postalcode	string	A postalCode specified in an address
address-state	string	A state specified in an address
address-use	token	A use code specified in an address
birthdate	date	The patient's date of birth
email	token	A value in an email contact
family	string	A portion of the family name of the related person
gender	token	Gender of the patient
given	string	A portion of the given name of the related person
identifier	token	Account number
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
patient	reference	The entity that caused the expenses
phone	token	A value in a phone contact
phonetic	string	A portion of either family or given name using some kind of phonetic matching algorithm
relationship	token	The relationship between the patient and the relatedperson
telecom	token	The value in any kind of telecom details of the patient

Reference

• Official FHIR R5 spec: RelatedPerson
• Maturity: Normative (FMM 5).