View raw Markdown
type: resource-definitionsresource: Person

Person Definitions

<a id="Person"></a>

Person

A generic person record

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

Comments: The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).

Cardinality: 0..*

Mappings: rim=Person(classCode="PSN" and determinerCode="INST" and quantity="1"); w5=administrative.entity

<a id="Person.identifier"></a>

Person.identifier

A human identifier for this person

Definition: Identifier for a person within a particular scope.

Comments: Systems MAY use identifier for user identities (using the type='USER'). Refer to the Security and Privacy section for additional guidance on representing user identities, particularly where duplicating the identifier to other resources.

Requirements: People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; v2=PID-3; rim=.plays:Role(classCode='IDENT').id

<a id="Person.active"></a>

Person.active

This person's record is in active use

Definition: Whether this person's record is in active use.

Requirements: Need to be able to mark a person record as not to be used because it was created in error.

Cardinality: 0..1

Type: boolean

Summary: true

Is Modifier: true (Reason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid)

Mappings: w5=FiveWs.status; rim=statusCode

<a id="Person.name"></a>

Person.name

A name associated with the person

Definition: A name associated with the person.

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

Requirements: Need to be able to track the person by multiple names. Examples are your official name and a partner name.

Cardinality: 0..*

Type: HumanName

Summary: true

Mappings: v2=PID-5, PID-9; rim=./name

<a id="Person.telecom"></a>

Person.telecom

A contact detail for the person

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

Comments: 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.

DO NOT use .telecom properties to represent user identities. Refer to the Security and Privacy section for additional guidance on representing user identities.

Requirements: People have (primary) ways to contact them in some way such as phone, email.

Cardinality: 0..*

Type: ContactPoint

Summary: true

Mappings: v2=PID-13, PID-14; rim=./telecom

<a id="Person.gender"></a>

Person.gender

male | female | other | unknown

Definition: Administrative Gender.

Comments: 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.

Requirements: Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.

Cardinality: 0..1

Type: code

Binding: required:administrative-gender

Summary: true

Mappings: v2=PID-8; rim=player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender

<a id="Person.birthDate"></a>

Person.birthDate

The date on which the person was born

Definition: The birth date for the person.

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

Requirements: Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.

Cardinality: 0..1

Type: date

Summary: true

Mappings: v2=PID-7; rim=./birthTime

<a id="Person.deceased[x]"></a>

Person.deceased[x]

Indicates if the individual is deceased or not

Definition: Indicates if the individual is deceased or not.

Comments: If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

Cardinality: 0..1

Type: boolean, dateTime

Summary: true

Mappings: v2=PID-30 (bool) and PID-29 (datetime); rim=player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime

<a id="Person.address"></a>

Person.address

One or more addresses for the person

Definition: One or more addresses for the person.

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

Requirements: May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.

Cardinality: 0..*

Type: Address

Summary: true

Mappings: v2=PID-11; rim=./addr

<a id="Person.maritalStatus"></a>

Person.maritalStatus

Marital (civil) status of a person

Definition: This field contains a person's most recent marital (civil) status.

Comments: Many countries maintain a register of births, deaths and marriages, and this would simplify that interaction

Cardinality: 0..1

Type: CodeableConcept

Binding: extensible:marital-status

Mappings: v2=PID-16; rim=player[classCode=PSN]/maritalStatusCode

<a id="Person.photo"></a>

Person.photo

Image of the person

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

Cardinality: 0..*

Type: Attachment

Mappings: v2=OBX-5 - needs a profile; rim=player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc

<a id="Person.communication"></a>

Person.communication

A language which may be used to communicate with the person about his or her health

Definition: A language which may be used to communicate with the person about his or her health.

Comments: If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Person.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

Note that this property should not be used to update any linked/logically linked practitioner resources as it serves as a language that can be used to communicate with patients - however it may be used to inform the value on practitioner, along with their role at the organization (with the practitioner's permission)

Requirements: If a person does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for person and other persons of interest.

Cardinality: 0..*

Type: BackboneElement

Mappings: rim=LanguageCommunication

<a id="Person.communication.language"></a>

Person.communication.language

The language which can be used to communicate with the person about his or her health

Definition: The language which may be used to communicate with the individual.

Comments: The language is commonly represented using the ISO-639-1 alpha code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha code for the region in upper case. For example, "en" for English, or "en-US" for American English versus "en-AU" for Australian English, sgn-US for American Sign Language, sgn-NL for Dutch Sign Language, etc.

Not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Requirements: Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Cardinality: 1..1

Type: CodeableConcept

Binding: required:all-languages

Mappings: v2=PID-15, LAN-2; rim=player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code

<a id="Person.communication.preferred"></a>

Person.communication.preferred

Language preference indicator

Definition: Indicates whether or not the person prefers this language (over other languages he masters up a certain level).

Comments: This language is specifically identified for communicating healthcare information.

Requirements: People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

Cardinality: 0..1

Type: boolean

Mappings: v2=PID-15; rim=preferenceInd

<a id="Person.managingOrganization"></a>

Person.managingOrganization

The organization that is the custodian of the person record

Definition: The organization that is the custodian of the person record.

Requirements: Need to know who recognizes this person record, manages and updates it.

Cardinality: 0..1

Type: Reference(Organization)

Summary: true

Mappings: rim=scoper

<a id="Person.link"></a>

Link to a resource that concerns the same actual person

Definition: Link to a resource that concerns the same actual person.

Cardinality: 0..*

Type: BackboneElement

Mappings: rim=outboundLink

<a id="Person.link.target"></a>

Person.link.target

The resource to which this actual person is associated

Definition: The resource to which this actual person is associated.

Cardinality: 1..1

Type: Reference(Patient, Practitioner, RelatedPerson, Person)

Mappings: rim=id

<a id="Person.link.assurance"></a>

Person.link.assurance

level1 | level2 | level3 | level4

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

Cardinality: 0..1

Type: code

Binding: required:identity-assuranceLevel

Mappings: rim=priorityNumber?