Clinical Intelligence StandardsVersion 0.2

Functional standard / People / Instance

Patient

The person the whole record is about. Family members are patients too, linked by Relationship.

Kind
patient
Collection
/v1/patients
Initial state
active
Classification
Clinical

Scope and usage

Register the person once per site. Demographics, identifiers, and whether they can act as a guardian or care-taker live here. Age is computed from date of birth, or from an age recorded on a date, so a stored age does not go stale.

Boundaries and relationships

Resource content

Elements this resource adds. It also carries the Instance.

NameCard.TypeFlagsDescription
name1..1string—Name used by the care team.
country1..1codeBISO country, at least two characters.
gender1..1codeBmale, female, other, or unknown.
date_of_birth0..1date—Provide this or age_years.
age_years0..1integer—Age on age_recorded_on, from 0 to 130. Used when date of birth is unknown.
age_recorded_on0..1date—The day age_years was recorded.
age_is_estimated1..1boolean—True when the age was estimated.
age0..1integerRComputed. Not accepted on create or update.
demographics0..1object—Standard optional fields the site has enabled: phone, language, occupation, and others.
custom_fields0..1object—Fields declared only by this site's patient_fields definition.
identifiers0..1object—External ids, for example { mrn, abha }.
is_guardian1..1boolean—This person may be named as a guardian on a Relationship.
is_care_taker1..1boolean—This person may be named as a care-taker.

State machine

active → inactive, deceased. inactive → active, deceased.

Frozen: The resource is not frozen by status. It is not deletable.

Terminology bindings

ElementStrengthValues
genderrequiredmale | female | other | unknown

Invariants

Operations

MethodPathMeaning
GET/v1/patientsList patient. Filter by patient_id, status, and where the model has them, encounter_id or definition_key.
POST/v1/patientsCreate a patient. Body is the resource minus harness-owned elements.
GET/v1/patients/{id}Read one patient.
PATCH/v1/patients/{id}Update elements that are not immutable, frozen, or harness-owned.
POST/v1/patients/{id}/transitionMove status. Body is { to, reason }. A gated move returns 202 and an Approval.
GET/v1/patients/{id}/summaryProfiles, what is present and absent, and pending actions.
GET/v1/patients/{id}/factsFacts used by cohort rules: age, gender, conditions, latest observations.
GET/v1/patients/{id}/timelineHash-chained audit for this patient.
GET/v1/patients/{id}/timeline/verifyChecks the chain. Reports the first broken entry.
POST/v1/patients/{id}/suggest-cohortsProposes cohort memberships whose rules match. Does not enroll.

Notes

Example

{
  "name": "Asha K",
  "country": "IN",
  "gender": "female",
  "age_years": 34,
  "identifiers": { "mrn": "MRN-1044" }
}