Schemas / Clinic

rig.clinic.encounter

v1.0.0 · stable maturity: draft 3 fields 3 required

Fields

FieldTypeMeaning
patient entity required Person this visit is about
status enumplanned · arrived · in-progress · finished · cancelled required planned / arrived / in-progress / finished / cancelled
class enuminpatient · outpatient · emergency · virtual · home required inpatient / outpatient / emergency / virtual / home

One visit or admission. Format when present.

Field meanings follow FHIR Encounter status and class. This schema is those visit elements - not a FHIR Bundle, and not the observations taken during it.

patient, status, and class are required.

A visit's clock is rig.calendar.event on this entity. An admission's days are rig.calendar.span. Do not copy one range onto both. A file this visit belongs to is rig.record.concerns.

JSON Schema

Resolves at https://rig.works/schemas/rig.clinic.encounter.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.clinic.encounter.schema.json",
  "title": "rig.clinic.encounter",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "patient": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "status": {
      "type": "string",
      "enum": [
        "planned",
        "arrived",
        "in-progress",
        "finished",
        "cancelled"
      ]
    },
    "class": {
      "type": "string",
      "enum": [
        "inpatient",
        "outpatient",
        "emergency",
        "virtual",
        "home"
      ]
    }
  },
  "required": [
    "patient",
    "status",
    "class"
  ],
  "description": "One visit or admission. Visit clock is rig.calendar.event; admission days are rig.calendar.span.",
  "x-rig-maturity": "draft"
}

Seen in

record-care.json