HL7 FHIR Encounter API
Patient visits and encounters
HL7 FHIR Encounter 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 Encounter. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 1 operation across 1 path, and defines 1 schema. 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 Encounter 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 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Patient visits and encounters
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Bundle (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.