RelatedPerson

Trial Use 2 Base

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.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/RelatedPerson

Interaction	Method	Path
Read	GET	/fhir/R4/RelatedPerson/[id]
Vread	GET	/fhir/R4/RelatedPerson/[id]/_history/[vid]
Update	PUT	/fhir/R4/RelatedPerson/[id]
Patch	PATCH	/fhir/R4/RelatedPerson/[id]
Delete	DELETE	/fhir/R4/RelatedPerson/[id]
Create	POST	/fhir/R4/RelatedPerson
Search	GET	/fhir/R4/RelatedPerson
History	GET	/fhir/R4/RelatedPerson/[id]/_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 nature of the relationship
name	HumanName	0..*	A name associated with the person
telecom	ContactPoint	0..*	A contact detail for the person
gender	code	0..1	male | female | other | unknown
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 about the patient's health

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
active	string	http://hl7.org/fhir/SearchParameter/RelatedPerson-active
address	string	http://hl7.org/fhir/SearchParameter/individual-address
address-city	string	http://hl7.org/fhir/SearchParameter/individual-address-city
address-country	string	http://hl7.org/fhir/SearchParameter/individual-address-country
address-postalcode	string	http://hl7.org/fhir/SearchParameter/individual-address-postalcode
address-state	string	http://hl7.org/fhir/SearchParameter/individual-address-state
address-use	string	http://hl7.org/fhir/SearchParameter/individual-address-use
birthdate	string	http://hl7.org/fhir/SearchParameter/individual-birthdate
email	string	http://hl7.org/fhir/SearchParameter/individual-email
gender	string	http://hl7.org/fhir/SearchParameter/individual-gender
identifier	string	http://hl7.org/fhir/SearchParameter/RelatedPerson-identifier
name	string	http://hl7.org/fhir/SearchParameter/RelatedPerson-name
patient	string	http://hl7.org/fhir/SearchParameter/RelatedPerson-patient
phone	string	http://hl7.org/fhir/SearchParameter/individual-phone
phonetic	string	http://hl7.org/fhir/SearchParameter/individual-phonetic
relationship	string	http://hl7.org/fhir/SearchParameter/RelatedPerson-relationship
telecom	string	http://hl7.org/fhir/SearchParameter/individual-telecom

Reference

• Official FHIR R4 spec: RelatedPerson
• Maturity: Trial Use 2 (FMM 2).