Clinical Intelligence StandardsVersion 0.2

Functional standard / People / Instance

Provider

A clinician who can be the primary decision-maker on a care team.

Kind
provider
Collection
/v1/providers
Initial state
active
Classification
Operational

Scope and usage

Directory entry for a doctor: specialty, registration, and the login id that matches an Actor.

Boundaries and relationships

Resource content

Elements this resource adds. It also carries the Instance.

NameCard.TypeFlagsDescription
name1..1string—Display name.
specialty0..1string—General specialty.
super_specialty0..1string—Further specialty.
qualifications0..*string—Credentials as text.
registration_no0..1string—Professional registration.
user_id0..1id—Actor id, so the roster can match the person who signed in.

State machine

active → in_break, resigned. in_break → active, resigned.

Frozen: None. Not deletable.

Invariants

Operations

MethodPathMeaning
GET/v1/providersList provider. Filter by patient_id, status, and where the model has them, encounter_id or definition_key.
POST/v1/providersCreate a provider. Body is the resource minus harness-owned elements.
GET/v1/providers/{id}Read one provider.
PATCH/v1/providers/{id}Update elements that are not immutable, frozen, or harness-owned.
POST/v1/providers/{id}/transitionMove status. Body is { to, reason }. A gated move returns 202 and an Approval.

Example

{ "name": "Dr Rao", "specialty": "psychiatry", "user_id": "dr_rao" }