Skip to main content

Person

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

Properties

NameRequiredTypeDescription
identifierIdentifier[]

A human identifier for this person

Details

Identifier for a person within a particular scope.

nameHumanName[]

A name associated with the person

Details

A name associated with the person.

Person may have multiple names with different uses or applicable periods.

telecomContactPoint[]

A contact detail for the person

Details

A contact detail for the person, e.g. a telephone number or an email address.

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification.

gendercode

male | female | other | unknown

Details

Administrative Gender.

The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F.

birthDatedate

The date on which the person was born

Details

The birth date for the person.

At least an estimated year should be provided as a guess if the real DOB is unknown.

addressAddress[]

One or more addresses for the person

Details

One or more addresses for the person.

Person may have multiple addresses with different uses or applicable periods.

photoAttachment

Image of the person

Details

An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.

managingOrganizationReference<Organization>

The organization that is the custodian of the person record

Details

The organization that is the custodian of the person record.

activeboolean

This person's record is in active use

Details

Whether this person's record is in active use.

linkPersonLink[]

Link to a resource that concerns the same actual person

Details

Link to a resource that concerns the same actual person.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

targetReference< Patient | Practitioner | RelatedPerson | Person >

The resource to which this actual person is associated

Details

The resource to which this actual person is associated.

assurancecode

level1 | level2 | level3 | level4

Details

Level of assurance that this link is associated with the target resource.

Search Parameters

NameTypeDescriptionExpression
addressstring 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-citystring A city specified in an address Person.address.city
address-countrystring A country specified in an address Person.address.country
address-postalcodestring A postal code specified in an address Person.address.postalCode
address-statestring A state specified in an address Person.address.state
address-usetoken A use code specified in an address Person.address.use
birthdatedate The person's date of birth Person.birthDate
emailtoken A value in an email contact Person.telecom.where(system = 'email')
gendertoken The gender of the person Person.gender
phonetoken A value in a phone contact Person.telecom.where(system = 'phone')
phoneticstring A portion of name using some kind of phonetic matching algorithm Person.name
telecomtoken The value in any kind of contact Person.telecom
identifiertokenA person IdentifierPerson.identifier
linkreferenceAny link has this Patient, Person, RelatedPerson or Practitioner referencePerson.link.target
namestringA server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or textPerson.name
organizationreferenceThe organization at which this person record is being managedPerson.managingOrganization
patientreferenceThe Person links to this PatientPerson.link.target.where(resolve() is Patient)
practitionerreferenceThe Person links to this PractitionerPerson.link.target.where(resolve() is Practitioner)
relatedpersonreferenceThe Person links to this RelatedPersonPerson.link.target.where(resolve() is RelatedPerson)

Inherited Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesuri

A set of rules under which this content was created

Details

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.