Person - FHIR Resource (r4)
This Person Resource uses the FHIR API standard for access and structure.
Validate an Person FHIR Resource (r4)
Person Attributes
AttributeField is listTypeDescription
Description: A human identifier for this person
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR"
}
]
},
"system": "urn:oid:1.2.36.146.595.217.0.1",
"value": "12345",
"period": {
"start": "2001-05-06"
},
"assigner": {
"display": "Acme Healthcare"
}
}
]Learn more about the (Person) identifier FHIR attribute
Description: A name associated with the person
FHIR Version: r4
Attribute Type : HumanName
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": [
{
"use": "official",
"family": "Chalmers",
"given": [
"Peter",
"James"
]
},
{
"use": "usual",
"given": [
"Jim"
]
}
]Learn more about the (Person) name FHIR attribute
Description: A contact detail for the person
FHIR Version: r4
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"telecom": [
{
"use": "home"
},
{
"system": "phone",
"value": "(03) 5555 6473",
"use": "work"
},
{
"system": "email",
"value": "Jim@example.org",
"use": "home"
}
]Learn more about the (Person) telecom FHIR attribute
Description: male | female | other | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"gender": "male"Learn more about the (Person) gender FHIR attribute
Description: The date on which the person was born
FHIR Version: r4
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"birthDate": "1974-12-25"Learn more about the (Person) birthDate FHIR attribute
Description: One or more addresses for the person
FHIR Version: r4
Attribute Type : Address
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"address": [
{
"use": "home",
"line": [
"534 Erewhon St"
],
"city": "PleasantVille",
"state": "Vic",
"postalCode": "3999"
}
]Learn more about the (Person) address FHIR attribute
Description: Image of the person
FHIR Version: r4
Attribute Type : Attachment
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"photo": Learn more about the (Person) photo FHIR attribute
Description: The organization that is the custodian of the person record
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"managingOrganization": Learn more about the (Person) managingOrganization FHIR attribute
Description: This person's record is in active use
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"active": trueLearn more about the (Person) active FHIR attribute
Description: Link to a resource that concerns the same actual person
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"link": [
{
"target": {
"reference": "RelatedPerson/peter",
"display": "Peter Chalmers"
}
},
{
"target": {
"reference": "Patient/example",
"display": "Peter Chalmers"
}
}
]Learn more about the (Person) link FHIR attribute
Person Example
{
"resourceType": "Person",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table>\n <tbody>\n <tr>\n <td>Name</td>\n <td>Peter James <b>Chalmers</b> ("Jim")</td>\n </tr>\n <tr>\n <td>Address</td>\n <td>534 Erewhon, Pleasantville, Vic, 3999</td>\n </tr>\n <tr>\n <td>Contacts</td>\n <td>Home: unknown. Work: (03) 5555 6473</td>\n </tr>\n <tr>\n <td>Id</td>\n <td>MRN: 12345 (Acme Healthcare)</td>\n </tr>\n </tbody>\n </table>\n </div>"
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR"
}
]
},
"system": "urn:oid:1.2.36.146.595.217.0.1",
"value": "12345",
"period": {
"start": "2001-05-06"
},
"assigner": {
"display": "Acme Healthcare"
}
}
],
"name": [
{
"use": "official",
"family": "Chalmers",
"given": [
"Peter",
"James"
]
},
{
"use": "usual",
"given": [
"Jim"
]
}
],
"telecom": [
{
"use": "home"
},
{
"system": "phone",
"value": "(03) 5555 6473",
"use": "work"
},
{
"system": "email",
"value": "Jim@example.org",
"use": "home"
}
],
"gender": "male",
"birthDate": "1974-12-25",
"address": [
{
"use": "home",
"line": [
"534 Erewhon St"
],
"city": "PleasantVille",
"state": "Vic",
"postalCode": "3999"
}
],
"active": true,
"link": [
{
"target": {
"reference": "RelatedPerson/peter",
"display": "Peter Chalmers"
}
},
{
"target": {
"reference": "Patient/example",
"display": "Peter Chalmers"
}
}
]
}Person Structure
{
"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
}]
}
Person Search Parameters
The following search parameters can be used to query Person resources. Just submit them like so:
https://api.1up.health/fhir/r4/Person?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
address | text | address |
address-city | text | address.city |
address-country | text | address.country |
address-postalcode | text | address.postalCode |
address-state | text | address.state |
address-use | text | address.use |
birthdate | date | birthDate |
email | text | telecom.where |
gender | text | gender |
identifier | text | identifier |
link | reference | link.target |
name | text | name |
organization | reference | managingOrganization |
patient | reference | link.target.where |
phone | text | telecom.where |
phonetic | text | name |
practitioner | reference | link.target.where |
relatedperson | reference | link.target.where |
telecom | text | telecom |
