System-level API
What the server offers on the base URL itself, https://[host]/w/[tenant]/[project]/api/v1/fhir: the interactions that span resource types, the operations invoked at the system level, and which of the 155 resource types have operations of their own. Generated from the server's CapabilityStatement and the OperationDefinitions it serves.
Interactions
| Interaction | Request | Description |
|---|---|---|
Capabilitiesmetadata | GET [base]/metadata | The CapabilityStatement this page is generated from. |
Searchsearch-system | GET [base]?[parameters] | Search across every resource type. Documentation |
Historyhistory-system | GET [base]/_history | Every change to every resource, newest first. Documentation |
Transactiontransaction | POST [base] | A Bundle of type transaction, applied as one unit: all of it or none of it. |
Batchbatch | POST [base] | A Bundle of type batch; each entry succeeds or fails on its own. |
The interactions on a resource type (create, read, update, patch, delete, search and history) are on its page, with their test results.
Operations
Invoke with Current Project Information Get Project resource for the current project. Users current project. Delete refresh token Delete refresh token from the user for the client. Client id for refresh token to delete. User agent of the refresh token to delete. Result of the delete operation. Delete Scope Delete scope from user accepted scopes for the client. Client for which scopes are being shown. Result of the delete operation. Current Tenant Endpoint Information Get tenant endpoint information for the current tenant. FHIR R4 Endpoint URL. FHIR R4 Capabilities URL. OIDC Discovery URL. OIDC Token Endpoint. OIDC Authorize Endpoint. OIDC JWKS Endpoint. Model context protocol endpoint. HL7v2 Parse Parse HL7v2 messages. Show Indexing Errors Show resources that failed search indexing for the current tenant and project. If true, mark the indexing errors as resolved. The resources that failed search indexing. Version id of the resource that failed to index. Version id of the resource that failed to index. FHIR resource type of the resource that failed to index. The operation (create, update or delete) that failed to index. Sequence position of the resource in the indexing stream. Number of times indexing has been attempted for this resource. The error that occurred while indexing. When this resource first failed indexing. When this resource most recently failed indexing. When this failure was marked resolved, if it has been. Show Refresh Tokens Show list of users refresh tokens. Show Scopes Show list of user accepted scopes for apps. Tenant Branding Get the current tenant's display name and logo, if set. Display name for the tenant, if one has been set. Logo for the tenant, if one has been set. Tenant Customization Set display customization for the current tenant, such as its display name and logo. Display name for the tenant. Omit to clear the tenant's display name. Logo for the tenant. Omit to clear the tenant's logo. ViewDefinition Run Execute a view definition against supplied or server data. Output format for the result (for example json, ndjson, csv, parquet). Optional; if omitted, the server returns ndjson by default. Include CSV headers (default true). Applies only when csv output is requested. Reference to a ViewDefinition stored on the server. Inline ViewDefinition resource to execute. Restrict execution to the specified patient. Restrict execution to members of the given group(s). External data source to use (for example a URI or bucket name). FHIR resources to transform instead of using server data. Maximum number of rows to return. Include only resources modified after this instant. Transformed data encoded in the requested output format.POST [base]/$[name], sending a Parameters resource as the body. The out parameters say what comes back: a resource, or a Parameters resource holding them.$current-project
SystemPOST [base]/$current-projectParameters: 0 in, 1 out
Name Card. Type Description Out project 1..1 Project $delete-refresh-token
SystemPOST [base]/$delete-refresh-tokenParameters: 2 in, 1 out
Name Card. Type Description In client_id 1..1 id user_agent 0..1 string Out return 1..1 OperationOutcome $delete-scope
SystemPOST [base]/$delete-scopeParameters: 1 in, 1 out
Name Card. Type Description In client_id 1..1 id Out return 1..1 OperationOutcome $endpoints
SystemPOST [base]/$endpointsParameters: 0 in, 7 out
Name Card. Type Description Out fhir-r4-base-url 1..1 uri fhir-r4-capabilities-url 1..1 uri oidc-discovery-url 1..1 uri oidc-token-endpoint 1..1 uri oidc-authorize-endpoint 1..1 uri oidc-jwks-endpoint 1..1 uri mcp-endpoint 1..1 uri $hl7v2-parse
SystemPOST [base]/$hl7v2-parseParameters: 1 in, 1 out
$indexing-errors
SystemPOST [base]/$indexing-errorsParameters: 1 in, 1 out
Name Card. Type Description In resolve 0..1 boolean Out errors 0..* parts id 1..1 id version_id 1..1 id resource_type 1..1 code fhir_method 1..1 code sequence 1..1 integer attempt_count 1..1 integer error_message 1..1 string first_failed_at 1..1 dateTime last_failed_at 1..1 dateTime resolved_at 0..1 dateTime $refresh-tokens
SystemPOST [base]/$refresh-tokensParameters: 0 in, 1 out
$scopes
SystemPOST [base]/$scopesParameters: 0 in, 1 out
$tenant-branding
SystemPOST [base]/$tenant-brandingParameters: 0 in, 2 out
Name Card. Type Description Out name 0..1 string logo 0..1 Attachment $tenant-customization
SystemPOST [base]/$tenant-customizationParameters: 2 in, 0 out
Name Card. Type Description In name 0..1 string logo 0..1 Attachment $viewdefinition-run
SystemTypeInstancePOST [base]/$viewdefinition-runPOST [base]/ViewDefinition/$viewdefinition-runPOST [base]/ViewDefinition/[id]/$viewdefinition-runParameters: 10 in, 1 out
Name Card. Type Description In _format 0..1 code header 0..1 boolean viewReference 0..1 Reference viewResource 0..1 ViewDefinition(ViewDefinition) patient 0..1 Reference group 0..* Reference source 0..1 string resource 0..* Resource _limit 0..1 integer _since 0..1 instant Out return 1..1 Binary
Operations by resource type
The resource types with type- or instance-level operations. Every other resource type supports the standard interactions only.