Person REST Endpoints

Sort by

Task Path Method

Description

Person

This topic describes information for the Person resource.

Overview

Note:

The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

The Person resource identifies an individual outside a specific healthcare context and can link records that represent the same individual across facilities or organizations.

Profile Support

US Core 6.1.0 does not define a standalone Person profile. This API uses the base FHIR R4 Person resource.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
Person	DomainResource
Person.id	id
Person.meta	Meta
Person.text	Narrative
Person.identifier	Identifier
Person.name	HumanName
Person.telecom	ContactPoint
Person.gender	code
Person.birthDate	date
Person.address	Address
Person.active	boolean
Person.link	BackboneElement
Person.link.target	Reference

Terminology Bindings

Element	Description	Details
Person.identifier.type	The purpose of an identifier.	Identifier Type Codes
Person.name.use	The purpose of a name.	NameUse
Person.telecom.system	The telecommunications system.	ContactPointSystem
Person.telecom.use	The purpose of a contact point.	ContactPointUse
Person.gender	The administrative gender.	Administrative Gender
Person.address.use	The purpose of an address.	AddressUse

Person

The operations from the Person category.

Get a list of persons

Method: get

Path: /Person

Get a person by ID

Method: get

Path: /Person/{id}