Docs · Validators

`fhir_reference` validator

FHIR relative reference of the form `ResourceType/id`.

Get an API key Read the docs

One of 19 validator types · pure compute, no AI cost

Reference

Format

Matches `/^[A-Z][A-Za-z]+\/[A-Za-z0-9-]+$/`. PascalCase resource type, slash, then an id of letters, digits, hyphens.

Examples

Patient/123
Observation/lab-7f4
Encounter/abc-DEF-456

How it runs

Implementation

A faithful summary of lib/validators.ts. Validators are pure functions and run identically in the Worker, the Workbench and the MCP server — one implementation, so the three cannot disagree about whether a value is valid.

lib/validators.ts

function validFhirRef(value) {
  return /^[A-Z][A-Za-z]+\/[A-Za-z0-9-]+$/.test(value)
    ? OK
    : fail('fhir_ref_invalid', 'expected ResourceType/id')
}

Config

Use in a template

Validators attach to a field on a custom template. The cascade runs them after mapping but before commit; failures surface in the per-row validation report.

template.yaml

fields:
  - column: subject
    type: string
    validators:
      - type: fhir_reference

Watch out

Common gotchas

Relative form only. `https://server/fhir/Patient/123` fails — strip the base in transform.
Underscores and dots in the id are rejected — FHIR allows them, but we do not. Open an issue if your server needs them.
No resource-type allow-list. `MyCustomThing/1` passes the shape check.

Where it runs

Three routes, no AI cost.

POST/v1/validate-rowValidate one row against a template. Stateless, no key, pure compute — the fastest way to try fhir_reference against a real value.no key
POST/v1/uploads/:id/validateRun every field validator over the parsed upload, without committing. Returns errors and warnings per row.read
POST/v1/uploads/:id/commitValidates on the way out. skip_invalid_rows drops the failures instead of failing the commit.commit

Validators are pure functions, so they add nothing to the AI bill. Every map draws a small flat per-map fee from your prepaid token wallet ($10 minimum, shared across the phi-cloud suite); only columns that reach the metered LLM layer, plus any-to-any convert and structural reshape, bill real AI tokens. See pricing

Catalogue

Related templates

No template in the default catalogue ships with fhir_reference preconfigured. Use it on a custom template via the YAML snippet above, or through the template editor.

Explore

All 19 validator types

The complete list a template field can declare. There is no SNOMED validator — it required an affiliate licence, no template used it, and it was removed in 2026.

Back to the documentation index or browse the template catalogue.

Ready when you are

Validate every row — before it lands.

Attach checksum-strict validators to any field, and gate risky commits behind the requires_hitl flag. One key runs the whole cascade.

Get an API key See pricing

Prepaid token wallet · schema-only data-minimization mode · no free tier

fhir_reference validator