Person

ResourceBase · IndividualsTrial useMaturity 2

Demographics and administrative information about a person independent of a specific health-related context.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

19 of 19 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifier	0..*	Identifier	A human identifier for this person
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 person was born
address	0..*	Address	One or more addresses for the person
photo	0..1	Attachment	Image of the person
managingOrganizationΣ	0..1	Reference(Organization)	The organization that is the custodian of the person record
active?!Σ	0..1	boolean	This person's record is in active use
link	0..*	BackboneElement	Link to a resource that concerns the same actual person
targetRequired	1..1	Reference(Patient | Practitioner | RelatedPerson | Person)	The resource to which this actual person is associated
assurance	0..1	code	level1 | level2 | level3 | level4Binding (required): identity-assuranceLevel

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

Search parameters

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

Parameter	Type	Description	PG	ES
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 Person.address
address-city	string	A city specified in an address Person.address.city
address-country	string	A country specified in an address Person.address.country
address-postalcode	string	A postal code specified in an address Person.address.postalCode
address-state	string	A state specified in an address Person.address.state
address-use	token	A use code specified in an address Person.address.use
birthdate	date	The person's date of birth Person.birthDate
email	token	A value in an email contact Person.telecom.where(system='email')
gender	token	The gender of the person Person.gender
identifier	token	A person Identifier Person.identifier
link	reference	Any link has this Patient, Person, RelatedPerson or Practitioner reference Person.link.target
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 Person.name
organization	reference	The organization at which this person record is being managed Person.managingOrganization
patient	reference	The Person links to this Patient Person.link.target.where(resolve() is Patient)
phone	token	A value in a phone contact Person.telecom.where(system='phone')
phonetic	string	A portion of name using some kind of phonetic matching algorithm Person.name
practitioner	reference	The Person links to this Practitioner Person.link.target.where(resolve() is Practitioner)
relatedperson	reference	The Person links to this RelatedPerson Person.link.target.where(resolve() is RelatedPerson)
telecom	token	The value in any kind of contact Person.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