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
- Nurses and coordinators are CareTeamMember, not Provider.
- This is not a user account. Staff keys are issued in administration.
Resource content
Elements this resource adds. It also carries the Instance.
| Name | Card. | Type | Flags | Description |
|---|---|---|---|---|
| name | 1..1 | string | — | Display name. |
| specialty | 0..1 | string | — | General specialty. |
| super_specialty | 0..1 | string | — | Further specialty. |
| qualifications | 0..* | string | — | Credentials as text. |
| registration_no | 0..1 | string | — | Professional registration. |
| user_id | 0..1 | id | — | Actor id, so the roster can match the person who signed in. |
State machine
active/ initial — Can be placed on a team.in_break— Temporarily unavailable.resigned— No longer at the site.
active → in_break, resigned. in_break → active, resigned.
Frozen: None. Not deletable.
Invariants
ccs-prv-1— Only admin and coordinator may create or update a provider.
Operations
| Method | Path | Meaning |
|---|---|---|
| GET | /v1/providers | List provider. Filter by patient_id, status, and where the model has them, encounter_id or definition_key. |
| POST | /v1/providers | Create 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}/transition | Move status. Body is { to, reason }. A gated move returns 202 and an Approval. |
Example
{ "name": "Dr Rao", "specialty": "psychiatry", "user_id": "dr_rao" }