v1
latestOpenAPI 3.1.02026-08-063776831.4 MBGet UDF Schema by entity type (latest or specific version)
Retrieves the latest User Defined Fields (UDF) schema for a specific entity type within a tenant's context.
UDF schemas define the structure and validation rules for custom fields that can be added to entities such as practitioners, facilities, locations, and groups. This endpoint returns the schema for the specified entity type. If a version is provided, it returns that specific version; otherwise, it returns the most recent version.
Supported Entity Types:
- practitioner - Schema for practitioner entities
Authentication & Authorization:
- Requires a valid JWT token in the Authorization header
- Requires READ_PROVIDER permission for the specified tenant
- The user must be a member of the organization (tenant) to access its UDF schemas
Request Headers:
- tenant-id (required) - The ID of the tenant/organization
- Authorization (required) - Bearer token for authentication
Query Parameters:
- version (optional) - The version number of the schema to retrieve. If not provided, returns the latest version.
Response: Returns a JSON object containing the UDF schema definition, including:
- Schema structure (JSON Schema format)
- Version information
- Entity type
- Tenant ID
Path parameters
The entity type for which to retrieve the UDF schema.
Valid values:
- practitioner - For practitioner entities
- facility - For facility entities
- location - For location entities
- group - For group entities
The value is case-insensitive.
Query parameters
Optional version number of the UDF schema to retrieve. If not provided, returns the latest version of the schema for the specified entity type.
Headers
The tenant ID (organization ID) for which to retrieve the UDF schema.
This header is required and identifies the tenant/organization context. The user must be a member of this organization to access its UDF schemas.
Response
UDF schema successfully retrieved