This page is part of the Interoperable Digital Identity and Patient Matching (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON

Resource Profile: FAST Identity UDAP Person

Profile on Person for use with the Interoperable Digital Identity and Patient Matching IG

Usage:

• Examples for this Resource Profile: Person/FASTIDUDAPPerson-Example

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Person

Name	Flags	Card.	Type	Description & Constraints
Person		0..*	Person	A generic person record
name
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
Slices for telecom		2..*	ContactPoint	A contact detail for the person Slice: Unordered, Open by pattern:system
telecom:tphone		1..*	ContactPoint	A contact detail for the person
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
telecom:email		1..*	ContactPoint	A contact detail for the person
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: email
birthDate		1..1	date	The date on which the person was born
address
line		1..*	string	Street name, number, direction & P.O. Box etc.
city		1..1	string	Name of city, town etc.
state		1..1	string	Sub-unit of country (abbreviations ok)
postalCode		1..1	string	Postal code for area
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Person		0..*	Person	A generic person record
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for telecom	Σ	2..*	ContactPoint	A contact detail for the person Slice: Unordered, Open by pattern:system
telecom:tphone	Σ	1..*	ContactPoint	A contact detail for the person
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email	Σ	1..*	ContactPoint	A contact detail for the person
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
birthDate	Σ	1..1	date	The date on which the person was born
active	?!Σ	0..1	boolean	This person's record is in active use
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Person.telecom:tphone.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Person.telecom:tphone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Person.telecom:email.system	required	Pattern: email http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Person.telecom:email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Person		0..*	Person	A generic person record
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	A human identifier for this person
name	Σ	0..*	HumanName	A name associated with the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	Σ	2..*	ContactPoint	A contact detail for the person Slice: Unordered, Open by pattern:system
telecom:tphone	Σ	1..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:email	Σ	1..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date on which the person was born
address		0..*	Address	One or more addresses for the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	1..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	1..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	1..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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 Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Person.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Person.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Person.telecom:tphone.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Person.telecom:tphone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Person.telecom:email.system	required	Pattern: email http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Person.telecom:email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Person.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Person.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Person.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Person.link.assurance	required	IdentityAssuranceLevel http://hl7.org/fhir/ValueSet/identity-assuranceLevel|4.0.1 from the FHIR Standard

This structure is derived from Person

Summary

Mandatory: 5 elements(6 nested mandatory elements)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Person.telecom

Differential View

This structure is derived from Person

Name	Flags	Card.	Type	Description & Constraints
Person		0..*	Person	A generic person record
name
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
Slices for telecom		2..*	ContactPoint	A contact detail for the person Slice: Unordered, Open by pattern:system
telecom:tphone		1..*	ContactPoint	A contact detail for the person
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
telecom:email		1..*	ContactPoint	A contact detail for the person
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: email
birthDate		1..1	date	The date on which the person was born
address
line		1..*	string	Street name, number, direction & P.O. Box etc.
city		1..1	string	Name of city, town etc.
state		1..1	string	Sub-unit of country (abbreviations ok)
postalCode		1..1	string	Postal code for area
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Person		0..*	Person	A generic person record
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for telecom	Σ	2..*	ContactPoint	A contact detail for the person Slice: Unordered, Open by pattern:system
telecom:tphone	Σ	1..*	ContactPoint	A contact detail for the person
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email	Σ	1..*	ContactPoint	A contact detail for the person
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
birthDate	Σ	1..1	date	The date on which the person was born
active	?!Σ	0..1	boolean	This person's record is in active use
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Person.telecom:tphone.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Person.telecom:tphone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Person.telecom:email.system	required	Pattern: email http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Person.telecom:email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Person		0..*	Person	A generic person record
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	A human identifier for this person
name	Σ	0..*	HumanName	A name associated with the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	Σ	2..*	ContactPoint	A contact detail for the person Slice: Unordered, Open by pattern:system
telecom:tphone	Σ	1..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:email	Σ	1..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date on which the person was born
address		0..*	Address	One or more addresses for the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	1..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	1..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	1..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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 Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Person.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Person.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Person.telecom:tphone.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Person.telecom:tphone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Person.telecom:email.system	required	Pattern: email http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Person.telecom:email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Person.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Person.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Person.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Person.link.assurance	required	IdentityAssuranceLevel http://hl7.org/fhir/ValueSet/identity-assuranceLevel|4.0.1 from the FHIR Standard

This structure is derived from Person

Summary

Mandatory: 5 elements(6 nested mandatory elements)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Person.telecom

Other representations of profile: CSV, Excel, Schematron