Person

Overview

The Person API allows creating, managing, and searching user identity profiles for patients, providers, and other people. Healthcare developers can use it to build applications with user management workflows for registration, authentication, authorizations, and identity federations.

Use Cases

User Management - Create and manage user accounts for patients, providers, administrators.
Identity Management - Maintain user identifiers, credentials, demographics, contacts.
Authentication - Validate user identities and enable secure access to applications and data.
Authorization - Define user roles and privileges to control access to functionality and information.
Single Sign-On - Allow users to access multiple integrated applications using one login.
Auditing - Track user activities like logins, data access, and changes for security audits.
Patient Matching - Link patient records across applications to the same person.
Referrals - Associate referring and referred providers to enable closed loop referrals.
Registries - Build master directories of patients, providers or other person identities.
Compliance - Adhere to healthcare regulations related to identity management and authorization.

EHR Data Model

EHR	Supported?	Mapped Source Object
Athena	✅	Providers
Elation	✅	Staff User
Epic	✅	N/A

Object Definition

{
  "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> (&quot;Jim&quot;)</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"
      }
    }
  ],
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data Field	Type	Description
resourceType	Person	This is a Person resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code	The base language in which the resource is written.
text	Narrative	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	BackboneElement	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	Extension	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	Extension	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	Identifier	Identifier for a person within a particular scope.
name	HumanName	A name associated with the person.
telecom	ContactPoint	A contact detail for the person, e.g. a telephone number or an email address.
gender	code	Administrative Gender.
birthDate	date	The birth date for the person.
address	Address	One or more addresses for the person.
photo	Attachment	An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
managingOrganization	Reference	The organization that is the custodian of the person record.
active	boolean	Whether this person's record is in active use.
link	BackboneElement	Link to a resource that concerns the same actual person.
link.id	string	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
link.extension	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
link.modifierExtension	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
link.target	Reference	The resource to which this actual person is associated.
link.assurance	code	Level of assurance that this link is associated with the target resource.

Extensions

Name	URL
ACCEPTINGNEWPATIENTSYN	http://xcaliber-fhir/structureDefinition/accepting-new-patients-yn
ANSINAMECODE	http://xcaliber-fhir/structureDefinition/ansi-name-code
ANSISPECIALTYCODE	http://xcaliber-fhir/structureDefinition/ansi-specialty-code
BILLABLE	http://xcaliber-fhir/structureDefinition/billable
CREATEENCOUNTERONCHECKINYN	http://xcaliber-fhir/structureDefinition/create-encounter-on-checkin-yn
DIRECTADDRESS	http://xcaliber-fhir/structureDefinition/direct-address
ENTITYTYPE	http://xcaliber-fhir/structureDefinition/entity-type
FEDERALIDNUMBER	http://xcaliber-fhir/structureDefinition/federal-id-number
HIDEINPORTALYN	http://xcaliber-fhir/structureDefinition/hide-in-portal-yn
HOMEDEPARTMENT	http://xcaliber-fhir/structureDefinition/home-department
OTHERPROVIDERIDLIST	http://xcaliber-fhir/structureDefinition/other-provider-id-list
PERSONALPRONOUNS	http://xcaliber-fhir/structureDefinition/personal-pronouns
PROVIDERGROUPLIST	http://xcaliber-fhir/structureDefinition/provider-group-list
PROVIDERTYPE	http://xcaliber-fhir/structureDefinition/provider-type
PROVIDERTYPEID	http://xcaliber-fhir/structureDefinition/provider-type-id
PROVIDERUSERNAME	http://xcaliber-fhir/structureDefinition/provider-username
SCHEDULERESOURCETYPE	http://xcaliber-fhir/structureDefinition/schedule-resource-type
SCHEDULINGNAME	http://xcaliber-fhir/structureDefinition/scheduling-name
SPECIALTY	http://xcaliber-fhir/structureDefinition/specialty
SPECIALTYID	http://xcaliber-fhir/structureDefinition/specialty-id
SUPERVISINGPROVIDERID	http://xcaliber-fhir/structureDefinition/supervising-provider-id
SUPERVISINGPROVIDERUSERNAME	http://xcaliber-fhir/structureDefinition/supervising-provider-username
USUALDEPARTMENTID	http://xcaliber-fhir/structureDefinition/usual-department-id
CREATEENCOUNTERPROVIDERIDLIST	http://xcaliber-fhir/structureDefinition/create-encounter-provider-id-list

Person

Overview

Use Cases

EHR Data Model

Object Definition

Data Fields

Extensions

Operations & APIs

Person-GET

Person-POST

Person ID-GET

Person ID-PUT

Person ID-DELETE