soap-schema-python/docs/examples/build_and_assert.py at main · PeerbitsSolution/soap-schema-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
"""Build a trusted SOAP note and fail fast if the schema contract changes."""

from soap_schema import SoapNoteValidationError, assert_valid, render_note


note = {
    "metadata": {
        "encounterType": "telehealth-checkin",
        "authorRole": "physician-assistant",
        "timestamp": "2026-01-05T16:45:00Z",
    },
    "subjective": {"chiefComplaint": "Medication check-in"},
    "objective": {},
    "assessment": [],
    "plan": [{"category": "patientEducation", "detail": "Reviewed medication adherence."}],
}

try:
    assert_valid(note)
except SoapNoteValidationError as exc:
    raise RuntimeError(f"Programmer error: invalid SOAP note: {exc.errors}") from exc

print(render_note(note))