Person

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

Interaction	Method	Path
Read	GET	/fhir/R4/Person/[id]
Vread	GET	/fhir/R4/Person/[id]/_history/[vid]
Update	PUT	/fhir/R4/Person/[id]
Patch	PATCH	/fhir/R4/Person/[id]
Delete	DELETE	/fhir/R4/Person/[id]
Create	POST	/fhir/R4/Person
Search	GET	/fhir/R4/Person
History	GET	/fhir/R4/Person/[id]/_history

Top-level elements

Element	Type	Cardinality	Description
id	string	0..1	Logical id of this artifact
meta	Meta	0..1	Metadata about the resource
implicitRules	uri	0..1	A set of rules under which this content was created
language	code	0..1	Language of the resource content
text	Narrative	0..1	Text summary of the resource, for human interpretation
contained	Resource	0..*	Contained, inline Resources
extension	Extension	0..*	Additional content defined by implementations
modifierExtension	Extension	0..*	Extensions that cannot be ignored
identifier	Identifier	0..*	A human identifier for this person
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 person was born
address	Address	0..*	One or more addresses for the person
photo	Attachment	0..1	Image of the person
managingOrganization	Reference	0..1	The organization that is the custodian of the person record
active	boolean	0..1	This person's record is in active use
link	BackboneElement	0..*	Link to a resource that concerns the same actual person

Resource-specific search parameters

Parameter	Type	Description
address	string	Multiple Resources: Patient: 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: 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 ; Practitioner: 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: 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	Multiple Resources: Patient: A city specified in an address ; Person: A city specified in an address ; Practitioner: A city specified in an address ; RelatedPerson: A city specified in an address
address-country	string	Multiple Resources: Patient: A country specified in an address ; Person: A country specified in an address ; Practitioner: A country specified in an address ; RelatedPerson: A country specified in an address
address-postalcode	string	Multiple Resources: Patient: A postalCode specified in an address ; Person: A postal code specified in an address ; Practitioner: A postalCode specified in an address ; RelatedPerson: A postal code specified in an address
address-state	string	Multiple Resources: Patient: A state specified in an address ; Person: A state specified in an address ; Practitioner: A state specified in an address ; RelatedPerson: A state specified in an address
address-use	token	Multiple Resources: Patient: A use code specified in an address ; Person: A use code specified in an address ; Practitioner: A use code specified in an address ; RelatedPerson: A use code specified in an address
birthdate	date	Multiple Resources: Patient: The patient's date of birth ; Person: The person's date of birth ; RelatedPerson: The Related Person's date of birth
email	token	Multiple Resources: Patient: A value in an email contact ; Person: A value in an email contact ; Practitioner: A value in an email contact ; PractitionerRole: A value in an email contact ; RelatedPerson: A value in an email contact
gender	token	Multiple Resources: Patient: Gender of the patient ; Person: The gender of the person ; Practitioner: Gender of the practitioner ; RelatedPerson: Gender of the related person
identifier	token	A person Identifier
link	reference	Any link has this Patient, Person, RelatedPerson or Practitioner reference
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
organization	reference	The organization at which this person record is being managed
patient	reference	The Person links to this Patient
phone	token	Multiple Resources: Patient: A value in a phone contact ; Person: A value in a phone contact ; Practitioner: A value in a phone contact ; PractitionerRole: A value in a phone contact ; RelatedPerson: A value in a phone contact
phonetic	string	Multiple Resources: Patient: A portion of either family or given name using some kind of phonetic matching algorithm ; Person: A portion of name using some kind of phonetic matching algorithm ; Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm ; RelatedPerson: A portion of name using some kind of phonetic matching algorithm
practitioner	reference	The Person links to this Practitioner
relatedperson	reference	The Person links to this RelatedPerson
telecom	token	Multiple Resources: Patient: The value in any kind of telecom details of the patient ; Person: The value in any kind of contact ; Practitioner: The value in any kind of contact ; PractitionerRole: The value in any kind of contact ; RelatedPerson: The value in any kind of contact

Reference

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