STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

8.3 Resource Person - Content

Patient Administration Work GroupMaturity Level: 1Compartments: 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.

This resource is referenced by requestgroup

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Person DomainResourceA generic person record
... identifier 0..*IdentifierA human identifier for this person
... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... birthDate Σ0..1dateThe date on which the person was born
... address 0..*AddressOne or more addresses for the person
... photo 0..1AttachmentImage of the person
... managingOrganization Σ0..1Reference(Organization)The organization that is the custodian of the person record
... active ?!Σ0..1booleanThis person's record is in active use
... link 0..*BackboneElementLink to a resource that concerns the same actual person
.... target 1..1Reference(Patient | Practitioner | RelatedPerson | Person)The resource to which this actual person is associated
.... assurance 0..1codelevel1 | level2 | level3 | level4
IdentityAssuranceLevel (Required)

doco Documentation for this format

XML Template

<Person xmlns="http://hl7.org/fhir"> doco
 <!-- 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>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Person;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Person.identifier [ Identifier ], ... ; # 0..* A human identifier for this person
  fhir:Person.name [ HumanName ], ... ; # 0..* A name associated with the person
  fhir:Person.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the person
  fhir:Person.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:Person.birthDate [ date ]; # 0..1 The date on which the person was born
  fhir:Person.address [ Address ], ... ; # 0..* One or more addresses for the person
  fhir:Person.photo [ Attachment ]; # 0..1 Image of the person
  fhir:Person.managingOrganization [ Reference(Organization) ]; # 0..1 The organization that is the custodian of the person record
  fhir:Person.active [ boolean ]; # 0..1 This person's record is in active use
  fhir:Person.link [ # 0..* Link to a resource that concerns the same actual person
    fhir:Person.link.target [ Reference(Patient|Practitioner|RelatedPerson|Person) ]; # 1..1 The resource to which this actual person is associated
    fhir:Person.link.assurance [ code ]; # 0..1 level1 | level2 | level3 | level4
  ], ...;
]

Changes since DSTU2

Person No Changes

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Person DomainResourceA generic person record
... identifier 0..*IdentifierA human identifier for this person
... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... birthDate Σ0..1dateThe date on which the person was born
... address 0..*AddressOne or more addresses for the person
... photo 0..1AttachmentImage of the person
... managingOrganization Σ0..1Reference(Organization)The organization that is the custodian of the person record
... active ?!Σ0..1booleanThis person's record is in active use
... link 0..*BackboneElementLink to a resource that concerns the same actual person
.... target 1..1Reference(Patient | Practitioner | RelatedPerson | Person)The resource to which this actual person is associated
.... assurance 0..1codelevel1 | level2 | level3 | level4
IdentityAssuranceLevel (Required)

doco Documentation for this format

XML Template

<Person xmlns="http://hl7.org/fhir"> doco
 <!-- 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>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Person;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Person.identifier [ Identifier ], ... ; # 0..* A human identifier for this person
  fhir:Person.name [ HumanName ], ... ; # 0..* A name associated with the person
  fhir:Person.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the person
  fhir:Person.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:Person.birthDate [ date ]; # 0..1 The date on which the person was born
  fhir:Person.address [ Address ], ... ; # 0..* One or more addresses for the person
  fhir:Person.photo [ Attachment ]; # 0..1 Image of the person
  fhir:Person.managingOrganization [ Reference(Organization) ]; # 0..1 The organization that is the custodian of the person record
  fhir:Person.active [ boolean ]; # 0..1 This person's record is in active use
  fhir:Person.link [ # 0..* Link to a resource that concerns the same actual person
    fhir:Person.link.target [ Reference(Patient|Practitioner|RelatedPerson|Person) ]; # 1..1 The resource to which this actual person is associated
    fhir:Person.link.assurance [ code ]; # 0..1 level1 | level2 | level3 | level4
  ], ...;
]

Changes since DSTU2

Person No Changes

See the Full Difference for further information

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),

PathDefinitionTypeReference
Person.gender The gender of a person used for administrative purposes.RequiredAdministrativeGender
Person.link.assurance The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.RequiredIdentityAssuranceLevel

Most of the properties of the Person resource are replicated within the other resources that they are shared with. This is intentional and highlights that the "disconnectedness" of the resources.

Not many systems actually 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 utilize 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.

NameTypeDescriptionPathsIn Common
addressstringA server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or textPerson.address3 Resources
address-citystringA city specified in an addressPerson.address.city3 Resources
address-countrystringA country specified in an addressPerson.address.country3 Resources
address-postalcodestringA postal code specified in an addressPerson.address.postalCode3 Resources
address-statestringA state specified in an addressPerson.address.state3 Resources
address-usetokenA use code specified in an addressPerson.address.use3 Resources
birthdatedateThe person's date of birthPerson.birthDate2 Resources
emailtokenA value in an email contactPerson.telecom(system=email)4 Resources
gendertokenThe gender of the personPerson.gender3 Resources
identifiertokenA person IdentifierPerson.identifier
linkreferenceAny link has this Patient, Person, RelatedPerson or Practitioner referencePerson.link.target
(Practitioner, Patient, Person, RelatedPerson)
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
(Organization)
patientreferenceThe Person links to this PatientPerson.link.target
(Patient)
phonetokenA value in a phone contactPerson.telecom(system=phone)4 Resources
phoneticstringA portion of name using some kind of phonetic matching algorithmPerson.name3 Resources
practitionerreferenceThe Person links to this PractitionerPerson.link.target
(Practitioner)
relatedpersonreferenceThe Person links to this RelatedPersonPerson.link.target
(RelatedPerson)
telecomtokenThe value in any kind of contactPerson.telecom4 Resources