Patient REST Endpoints

Sort by

Task Path Method

Description

Patient

This topic describes information for the Patient resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

The Patient resource provides general demographic information about a person receiving healthcare services from a specific organization. Common demographic fields include patient ID, patient name, gender, date of birth, address, phone number, primary language, and marital status.

Profile Support

This resource supports the US Core Patient Profile from the HL7 FHIR US Core Implementation Guide STU 6.1.0.

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
Patient.identifier	Identifier
Patient.identifier.system	uri
Patient.identifier.value	string
Patient.name	HumanName
Patient.name.family	string
Patient.name.given	string
Patient.telecom	ContactPoint
Patient.telecom.system	code
Patient.telecom.value	string
Patient.telecom.use	code
Patient.gender	code
Patient.birthDate	date
Patient.address	Address
Patient.address.line	string
Patient.address.city	string
Patient.address.state	string
Patient.address.postalCode	string
Patient.communication.language	CodeableConcept

Terminology Bindings

Element	Description	Details
Patient.telecom.system	The telecommunications form for the contact point. In other words, the communications system that is required to use the contact.	System
Patient.telecom.use	The purpose for the contact point.	System
Patient.gender	The administrative gender. In other words, the gender that the patient is considered to have for administration and record keeping purposes.	System
Patient.address.state	The subunit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (for example, US two-letter state codes).	System
Patient.communication.language	The ISO-639-1 alpha-2 code in lowercase for the language, optionally followed by a hyphen and the ISO-3166-1 alpha-2 code for the region in uppercase. For example, en for English, or en-US for American English versus en-EN for England English.	System

Extensions

Extension	Details
US Core Race	HL7
US Core Ethnicity	HL7
US Core Birth Sex	HL7
US Core Gender Identity	HL7
US Core Sex	HL7
US Core Tribal Affiliation	HL7

Patient

The operations from the Patient category.

Get a list of patients

Method: get

Path: /Patient

Get a patient by ID

Method: get

Path: /Patient/{id}