The formal definitions for the elements in the person resource. Also available as an XML file.
Person |
Definition | A person who is involved in the healthcare process |
Control | 1..1 |
Requirements | Need to track persons potentially across multiple roles |
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, Provider, 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, Provider), and multipleBirthInd (SubjectofCare) |
RIM Mapping | Person(classCode="PSN" and determinerCode="INST" and quantity="1") |
Person.identifier |
Definition | Identifier for a person within a particular scope. |
Control | 0..* |
Type | HumanId |
Must Understand | true |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier |
RIM Mapping | .plays:Role(classCode='IDENT').id |
v2 Mapping | PID-3 |
Person.name |
Definition | A name associated with the person |
Control | 0..* |
Type | HumanName |
Must Understand | true |
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
Comments | Person may have multiple names with different uses or applicable periods. |
RIM Mapping | ./name |
v2 Mapping | PID-5, PID-9 |
Person.telecom |
Definition | A contact detail for the person, e.g. a telephone number or an email address. |
Control | 0..* |
Type | Contact |
Must Understand | true |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
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 |
RIM Mapping | ./telecom |
v2 Mapping | PID-13, PID-14 |
Person.gender |
Definition | Administrative Gender |
Control | 0..1 |
Type | Coding from AdministrativeGender |
Must Understand | true |
Requirements | Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes. |
RIM Mapping | ./administrativeGender |
v2 Mapping | PID-8 |
Person.birthDate |
Definition | The birth date for the person. |
Control | 0..1 |
Type | dateTime |
Must Understand | true |
Requirements | Age of person drives many clinical processes. Next to the common use case of capturing someone birth date, also in some common cases time is registered. |
Comments | At least an estimated year should be provided as a guess if the real dob is unknown |
RIM Mapping | ./birthTime |
v2 Mapping | PID-7 |
Person.deceased |
Definition | Indicates if the Person is deceased or not |
Control | 0..1 |
Type | boolean |
Must Understand | true |
Comments | If there's no value in the instance it means there is no statement on whether or not the person deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
RIM Mapping | ./deceasedInd |
v2 Mapping | PID-30 |
Person.address |
Definition | One or more addresses for the person |
Control | 0..* |
Type | Address |
Must Understand | true |
Requirements | May need to keep track of persons addresses for contacting, billing or reporting requirements and also to help with identification |
Comments | Person may have multiple addresses with different uses or applicable periods |
RIM Mapping | ./addr |
v2 Mapping | PID-11 |
Person.maritalStatus |
Definition | This field contains the patient's marital (civil) status. |
Control | 0..1 |
Type | CodeableConcept from MaritalStatus |
Must Understand | true |
RIM Mapping | ./maritalStatus |
v2 Mapping | PID-16 |
Person.language |
Definition | A language spoken by the person, with proficiency |
Control | 0..* |
Must Understand | true |
Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and profiency is an important things to keep track of both for patient and other persons of interest |
Comments | If no language is specified, this *implies* that the default local language is spoken.
If you need to convey proficiency for multiple modes than you need multiple Person.language associations. |
RIM Mapping | .LanguageCommunication |
Person.language.language |
Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case. E.g. "en" for English, or "en-US" for American English versus "en-EN" for England English |
Control | 1..1 |
Type | CodeableConcept from Language |
Must Understand | true |
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. |
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type |
RIM Mapping | ./languageCode |
v2 Mapping | PID-15, NK1-20, LAN-2 |
To Do | So just ISO 639-3? ISO-639-1 alpha 2 is actually somewhat outdated and ISO-639-2 alpha 3 has support for more languages/dialects. |
Person.language.mode |
Definition | A value representing the person's method of expression of this language. Examples: expressed spoken, expressed written, expressed signed, received spoken, received written, received signed |
Control | 0..1 |
Type | CodeableConcept from LanguageAbilityMode |
Requirements | A Person that can write English fairly well, but is not capable to understand |
Comments | It's expected that modeCode and proficiencyLevelCode work in conjunction. It makes less sense to convey modeCode unless you want to distinctly denote someone proficiency for a particular mode. It's however perfectly acceptable to have a proficiencyLevelCode without a modeCode |
RIM Mapping | ./modeCode |
v2 Mapping | LAN-3 |
Person.language.proficiencyLevel |
Definition | A code that describes how well the language is spoken |
Control | 0..1 |
Type | CodeableConcept from LanguageAbilityProficiency |
Must Understand | true |
Comments | See comments for Person.language.modeCode |
RIM Mapping | ./proficiencyLanguageCode |
v2 Mapping | LAN-4 |
Person.language.preference |
Definition | Indicates whether or not the Person prefers this language (over other languages he masters up a certain level) |
Control | 0..1 |
Type | boolean |
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 |
RIM Mapping | ./preferenceInd |
v2 Mapping | PID-15, NK1-20 |
Person.extension |
Definition | See Extensions |
Control | 0..* |
Type | Extension |
Person.text |
Definition | Text summary of resource (for human interpretation) |
Control | 1..1 |
Type | Narrative |