HL7 FHIR Patient API
Patient demographic and identity resources
HL7 FHIR Patient API is one of 8 APIs that HL7 FHIR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Patient. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 4 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 4.0.1.
Requests are made against a single base URL, https://fhir-server.example.com/fhir/R4.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HL7 FHIR Patient API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (SMARTonFHIR) using the authorizationCode flow, exposing 7 scopes.
By default, every request must be authenticated.
SMARTonFHIR— SMART on FHIR OAuth 2.0 authorization
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Patient demographic and identity resources
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Patient (13 properties), Address (9 properties), Bundle (6 properties), HumanName (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HL7 FHIR 7
Other APIs HL7 FHIR publishes across the network.