Retrieve UDF schema for an entity type
Returns the User Defined Fields (UDF) schema for the specified entity type within a tenant's context. A UDF schema defines the structure and validation rules for the custom fields that can be attached to entities such as practitioners.
When to use: Call this endpoint to discover what custom fields exist for a given entity type before reading or writing UDF field values on a record. This endpoint returns the schema definition only; it does not return the UDF field values stored on any specific record.
Preconditions:
- A valid JWT Bearer token must be present in the Authorization header.
- The caller must hold the READ_UDF_SCHEMA permission for the target tenant.
- The tenant-id header must identify a tenant of which the authenticated user is a member.
- A UDF schema for the requested entity type must have been provisioned for the tenant; otherwise a 404 is returned.
What you get back: A UdfSchemaResponse object containing the entity type, tenant context, version number, and a schema property — a JSON document that describes the custom fields defined for the entity type. When version is omitted, the latest version is returned; when version is supplied, that specific version is returned.
Side effects: None. This is a read-only operation.
Supported entity types: practitioner is confirmed supported. The entityType parameter also accepts facility, location, and group; the availability of a provisioned schema for those types depends on tenant configuration.
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
The UDF schema for the requested entity type, including its version, tenant context, and the schema document describing the custom fields. Reflects the latest version, or the specific version requested via the version query parameter.