assessment

One completed clinical assessment instrument, with its answers — sourced from the provider's clinical record. One assessment record represents one completed run of an instrument, e.g. a single Barthel Index scoring session.

Fields

Field	Type	Required	Description
identifiers	Identifier[]	yes (≥1)	Business identifiers for this completed assessment.
patientRef	SourceRef	yes	The patient this assessment was completed for.
instrumentId	string	yes	The source instrument identifier, e.g. barthel-index.
instrumentLabel	string	no	Human-readable name of the instrument.
completedAt	IsoDatetime	yes	When the instrument run was completed.
discipline	string	no	The clinical discipline that completed this assessment.
answers	AssessmentAnswer[] (below)	no (defaults [])	The answered questions.
notes	string	no	Free-text notes attached to the completed run.

Assessment answer

Field	Type	Required	Description
questionId	string	yes	The instrument's question identifier.
value	string | number | boolean	yes	The answer for that question.

Example payload

{
  "identifiers": [{ "system": "urn:michels:assessment", "value": "ASMT-7001" }],
  "patientRef": {
    "sourceSystem": "michels",
    "resourceType": "patient",
    "sourceId": "pat-1"
  },
  "instrumentId": "barthel-index",
  "instrumentLabel": "Barthel Index",
  "completedAt": "2026-07-11T10:00:00.000Z",
  "discipline": "physiotherapy",
  "answers": [
    { "questionId": "feeding", "value": 10 },
    { "questionId": "bathing", "value": 5 },
    { "questionId": "mobility", "value": 15 }
  ],
  "notes": "Patient tolerated the assessment well."
}

As a change-feed event

{
  "sequence": 116,
  "resourceType": "assessment",
  "canonicalId": "1f4a7c9e-3b6d-4f2a-8c1e-4b7a0d3f6c9e",
  "operation": "create",
  "version": 1,
  "occurredAt": "2026-07-11T10:00:05.000Z",
  "orgSlug": "default",
  "record": {
    "identifiers": [{ "system": "urn:michels:assessment", "value": "ASMT-7001" }],
    "patientRef": {
      "sourceSystem": "michels",
      "resourceType": "patient",
      "sourceId": "pat-1"
    },
    "instrumentId": "barthel-index",
    "instrumentLabel": "Barthel Index",
    "completedAt": "2026-07-11T10:00:00.000Z",
    "discipline": "physiotherapy",
    "answers": [
      { "questionId": "feeding", "value": 10 },
      { "questionId": "bathing", "value": 5 },
      { "questionId": "mobility", "value": 15 }
    ],
    "notes": "Patient tolerated the assessment well."
  }
}

From the Records API

curl -H "Authorization: Bearer $ROSETTA_SYNC_TOKEN" \
  "https://sync.example.com/api/v1/records/assessment/1f4a7c9e-3b6d-4f2a-8c1e-4b7a0d3f6c9e"

{
  "id": "1f4a7c9e-3b6d-4f2a-8c1e-4b7a0d3f6c9e",
  "resourceType": "assessment",
  "version": 1,
  "payload": {
    "identifiers": [{ "system": "urn:michels:assessment", "value": "ASMT-7001" }],
    "patientRef": {
      "sourceSystem": "michels",
      "resourceType": "patient",
      "sourceId": "pat-1"
    },
    "instrumentId": "barthel-index",
    "instrumentLabel": "Barthel Index",
    "completedAt": "2026-07-11T10:00:00.000Z",
    "discipline": "physiotherapy",
    "answers": [
      { "questionId": "feeding", "value": 10 },
      { "questionId": "bathing", "value": 5 },
      { "questionId": "mobility", "value": 15 }
    ],
    "notes": "Patient tolerated the assessment well."
  },
  "updatedAt": "2026-07-11T10:00:05.000Z",
  "orgSlug": "default",
  "identifiers": [{ "system": "urn:michels:assessment", "value": "ASMT-7001" }]
}

Consumption notes

• This is an aggregate updated in place, not an immutable clinical fact — a new change event carries the whole payload again (a full-record event). Always overwrite your stored copy rather than merging answers arrays element-wise, and dedupe applied events on (canonicalId, version).
• Expect one record per completed instrument run — a patient with repeated Barthel Index scorings over time has one assessment record per completed run, not one record updated with a growing history.
• answers[].value is a union type (string, number, or boolean) — branch on its JSON type before using it; different instruments (and even different questions within one instrument) may use different value shapes.
• completedAt is the clinical timestamp for when the instrument was completed — a normalized timestamp, always Z-suffixed UTC.
• patientRef is a source reference; correlate it to the canonical patient whose identifiers contain the matching business identifier.