R4 Ballot #1 (Mixed Normative/Trial use)
AdministrationThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| Patient Administration Work Group | Maturity Level: 2 | Trial Use | Compartments: Patient, Practitioner, RelatedPerson |
Demographics and administrative information about a person independent of a specific health-related context.
An individual has identity outside of a healthcare setting. The Person resource is used to capture this information and to relate the person as an individual to other resources that do have a health-related context.
For example, while a patient resource may be created and maintained by each organization providing care for that person as a patient, a person resource provides a mechanism for linking patient resources across different organizations and their unique patient identity domains.
This resource is not referenced by any other resources.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Person | TU | DomainResource | A generic person record Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
  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 | unknown AdministrativeGender (Required) |
| 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 | |
 target | 1..1 | Reference(Patient | Practitioner | RelatedPerson | Person) | The resource to which this actual person is associated | |
| assurance | 0..1 | code | level1 | level2 | level3 | level4 IdentityAssuranceLevel (Required) | |
| Documentation for this format | ||||
UML Diagram (Legend)
XML Template
<Person xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier A human identifier for this person --></identifier> <name><!-- 0..* HumanName A name associated with the person --></name> <telecom><!-- 0..* ContactPoint A contact detail for the person --></telecom> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --> <birthDate value="[date]"/><!-- 0..1 The date on which the person was born --> <address><!-- 0..* Address One or more addresses for the person --></address> <photo><!-- 0..1 Attachment Image of the person --></photo> <managingOrganization><!-- 0..1 Reference(Organization) The organization that is the custodian of the person record --></managingOrganization> <active value="[boolean]"/><!-- 0..1 This person's record is in active use --> <link> <!-- 0..* Link to a resource that concerns the same actual person --> <target><!-- 1..1 Reference(Patient|Practitioner|RelatedPerson|Person) The resource to which this actual person is associated --></target> <assurance value="[code]"/><!-- 0..1 level1 | level2 | level3 | level4 --> </link> </Person>
JSON Template
{
"resourceType" : "Person",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // A human identifier for this person
"name" : [{ HumanName }], // A name associated with the person
"telecom" : [{ ContactPoint }], // A contact detail for the person
"gender" : "<code>", // male | female | other | unknown
"birthDate" : "<date>", // The date on which the person was born
"address" : [{ Address }], // One or more addresses for the person
"photo" : { Attachment }, // Image of the person
"managingOrganization" : { Reference(Organization) }, // The organization that is the custodian of the person record
"active" : <boolean>, // This person's record is in active use
"link" : [{ // Link to a resource that concerns the same actual person
"target" : { Reference(Patient|Practitioner|RelatedPerson|Person) }, // R! The resource to which this actual person is associated
"assurance" : "<code>" // level1 | level2 | level3 | level4
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R3
| Person |
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 5 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Person | TU | DomainResource | A generic person record Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| 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 | unknown AdministrativeGender (Required) |
| 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 | |
| target | 1..1 | Reference(Patient | Practitioner | RelatedPerson | Person) | The resource to which this actual person is associated | |
| assurance | 0..1 | code | level1 | level2 | level3 | level4 IdentityAssuranceLevel (Required) | |
| Documentation for this format | ||||
XML Template
<Person xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "Person",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // A human identifier for this person
"name" : [{ HumanName }], // A name associated with the person
"telecom" : [{ ContactPoint }], // A contact detail for the person
"gender" : "<code>", // male | female | other | unknown
"birthDate" : "<date>", // The date on which the person was born
"address" : [{ Address }], // One or more addresses for the person
"photo" : { Attachment }, // Image of the person
"managingOrganization" : { Reference(Organization) }, // The organization that is the custodian of the person record
"active" : <boolean>, // This person's record is in active use
"link" : [{ // Link to a resource that concerns the same actual person
"target" : { Reference(Patient|Practitioner|RelatedPerson|Person) }, // R! The resource to which this actual person is associated
"assurance" : "<code>" // level1 | level2 | level3 | level4
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| Person |
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 5 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4
Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Person.gender | The gender of a person used for administrative purposes. | Required | AdministrativeGender |
| Person.link.assurance | The level of confidence that this link represents the same actual person, based on NIST Authentication Levels. | Required | IdentityAssuranceLevel |
Most of the properties of the Person resource are replicated within the other resources that they are shared with. This is intentional and highlights the loose coupling of the resources.
Not many systems implement a shared Person record, and as such the values DO become out of sync with each other. The inclusion of this resource does permit a capability for systems to identify other instances of this actual person's data via a centralized registry that can assist in keeping things up to date.
The link element is used to relate resources under a common person record. This element supports two primary scenarios where other resources refer to the same person resource.
The link element cannot be used to link to RelatedPerson entries, so we can use a Person resource to relate these elements together identifying them as the same individual.
In a data sharing network, finding the location of patient records across different systems is a necessary pre-requisite for accessing external patient data. Using the link element, systems associate patient resources from different organizations. The assuranceLevel associated with the link provides a way for a system to qualify its confidence in the asserted link. For example, a relationship from the person to a patient using a probabilistic matching algorithm may be represented using a link with an assurance level of level1, while a relationship established using a government-issued photo ID may be created with an assurance level of level3.
Similarly, providers working in multiple healthcare service settings may be linked across different organizations using the link element. The various practitioner resources can be related using a common person resource with a link for each of the practitioner resources located in other organizations.
Client Portals provide consumer access to a window of their data locked up in healthcare systems. In many cases these systems are externally integrated and do not have access to the legacy CIS/PAS systems.
In contrast to most systems where a user has access to multiple patients depending on their roles and permissions,
a client portal provides a consumer with direct access to their data (with permissions applied).
This can also include not just their data (via the Person.link Patient entries), but also to information that they
have entered, or were involved with (via the Person.link RelatedPerson entries), such as observations that they
entered.
With appropriate permissions/consent applied, the user could have access to other Patient records linked via
a RelatedPerson.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| 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 | 3 Resources |
| address-city | string | A city specified in an address | Person.address.city | 3 Resources |
| address-country | string | A country specified in an address | Person.address.country | 3 Resources |
| address-postalcode | string | A postal code specified in an address | Person.address.postalCode | 3 Resources |
| address-state | string | A state specified in an address | Person.address.state | 3 Resources |
| address-use | token | A use code specified in an address | Person.address.use | 3 Resources |
| birthdate | date | The person's date of birth | Person.birthDate | 2 Resources |
| token | A value in an email contact | Person.telecom.where(system='email') | 4 Resources | |
| gender | token | The gender of the person | Person.gender | 3 Resources |
| identifier | token | A person Identifier | Person.identifier | |
| link | reference | Any link has this Patient, Person, RelatedPerson or Practitioner reference | Person.link.target (Practitioner, Patient, Person, RelatedPerson) | |
| 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 (Organization) | |
| patient | reference | The Person links to this Patient | Person.link.target (Patient) | |
| phone | token | A value in a phone contact | Person.telecom.where(system='phone') | 4 Resources |
| phonetic | string | A portion of name using some kind of phonetic matching algorithm | Person.name | 3 Resources |
| practitioner | reference | The Person links to this Practitioner | Person.link.target (Practitioner) | |
| relatedperson | reference | The Person links to this RelatedPerson | Person.link.target (RelatedPerson) | |
| telecom | token | The value in any kind of contact | Person.telecom | 4 Resources |
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:17+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change