RelatedPerson

ResourceBase · IndividualsTrial useMaturity 2

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

17 of 17 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	A human identifier for this person
active?!Σ	0..1	boolean	Whether this related person's record is in active use
patientRequiredΣ	1..1	Reference(Patient)	The patient this person is related to
relationshipΣ	0..*	CodeableConcept	The nature of the relationshipBinding (preferred): relatedperson-relationshiptype
nameΣ	0..*	HumanName	A name associated with the person
telecomΣ	0..*	ContactPoint	A contact detail for the person
genderΣ	0..1	code	male | female | other | unknownBinding (required): administrative-gender
birthDateΣ	0..1	date	The date on which the related person was born
addressΣ	0..*	Address	Address where the related person can be contacted or visited
photo	0..*	Attachment	Image of the person
period	0..1	Period	Period of time that this relationship is considered valid
communication	0..*	BackboneElement	A language which may be used to communicate with about the patient's health
languageRequired	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her healthBinding (preferred): languages
preferred	0..1	boolean	Language preference indicator

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/RelatedPerson?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
active	token	Indicates if the related person record is active RelatedPerson.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 RelatedPerson.address
address-city	string	A city specified in an address RelatedPerson.address.city
address-country	string	A country specified in an address RelatedPerson.address.country
address-postalcode	string	A postal code specified in an address RelatedPerson.address.postalCode
address-state	string	A state specified in an address RelatedPerson.address.state
address-use	token	A use code specified in an address RelatedPerson.address.use
birthdate	date	The Related Person's date of birth RelatedPerson.birthDate
email	token	A value in an email contact RelatedPerson.telecom.where(system='email')
gender	token	Gender of the related person RelatedPerson.gender
identifier	token	An Identifier of the RelatedPerson RelatedPerson.identifier
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 RelatedPerson.name
patient	reference	The patient this related person is related to RelatedPerson.patient
phone	token	A value in a phone contact RelatedPerson.telecom.where(system='phone')
phonetic	string	A portion of name using some kind of phonetic matching algorithm RelatedPerson.name
relationship	token	The relationship between the patient and the relatedperson RelatedPerson.relationship
telecom	token	The value in any kind of contact RelatedPerson.telecom

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition