Update a provider verification

View as MarkdownOpen in Claude

Transitions a provider resource into a new verification state. Reviewer-only. Audit-trail captured on the verification event log. Notes are operational free text and must not include patient identifiers, postcodes, or any PII.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

typeenumRequired
FHIR resource type the verification applies to.
Allowed values:
idstringRequired
Stable identifier of the resource.

Request

This endpoint expects an object.
statusenumRequired
Target verification status.
methodstringOptional<=64 characters

Free-form code describing how the verification happened (e.g. manual-review, documentary).

notesstringOptional<=2000 characters

Operational notes recorded with the verification event. Free text only; must not include patient identifiers, postcodes, or any other PII.

evidenceReferencestringOptional<=512 characters

Optional pointer to supporting evidence (URL, document id, or external case reference). Storage is owned by reviewer tooling, not this API.

Response

The verified resource.
dataobject
messagestring

Human-readable acknowledgement.