FHIR Patient Resource

Demographics and administrative information about a person receiving healthcare services. This page documents the Patient resource as served by the mock.health synthetic FHIR R4 sandbox — 13 search parameters, US Core 6.1 profiling, and the elements accepted on write.

Endpoints

• GET https://api.mock.health/fhir/Patient — search
• GET https://api.mock.health/fhir/Patient/{id} — read by logical id
• POST https://api.mock.health/fhir/Patient — create (Pro)
• PUT https://api.mock.health/fhir/Patient/{id} — update (Pro)

Search parameters

• _id (token) — Logical resource ID
• name (string) — Server-defined search on name fields
• family (string) — Family (last) name
• given (string) — Given (first) name
• birthdate (date) — Date of birth (YYYY-MM-DD)
• gender (token) — Sex (male | female | other | unknown)
• identifier (token) — Patient identifier (system|value)
• address (string) — Any part of the address
• address-city (string) — City
• address-state (string) — State (2-letter code)
• address-postalcode (string) — Postal/ZIP code
• email (token) — Email address
• phone (token) — Phone number

US Core profiles

• us-core-patient

Write elements

Fields accepted when creating or updating a Patient. Required elements are base FHIR cardinality; the rest are US Core must-support.

• identifier (Identifier[]) — US Core requires at least one identifier (e.g. MRN)
• name (HumanName[]) — US Core requires at least one name with family and given
• gender (code) — US Core MS — male | female | other | unknown
• birthDate (date) — US Core MS — date of birth (YYYY-MM-DD)

Specification

Base definition: HL7 FHIR R4 Patient. Category: Patient & Demographics.

Related patient & demographics resources

Practitioner · PractitionerRole · RelatedPerson

API reference · Quickstart · USCDI compliance · SMART on FHIR