Core Concepts
Architecture at a glance
The entities
| Entity | What it is | Where you meet it |
|---|---|---|
| Organization | Your account on the platform — it holds your API credentials, and everything you create belongs to it. | Obtain access token |
| Access token | A JWT identifying your organization, valid 3600 s (1 hour, returned as expiresIn). Sent as Bearer {token} on every call. | Obtain access token |
| Magic link | A single-use URL, valid 1 hour, that logs a clinician straight into the CardioExplorer UI. | Generate magic link |
| FHIR bundle | Your input: a FHIR R4 Bundle (collection) with Patient, Observations, MedicationStatements and Conditions covering the 32 parameters. | Generate draft test |
| CCS Test | The central object. Born as a draft from your bundle (with a gap analysis), it becomes a completed assessment once run through the AI model. | Draft → Run → Result |
| Report | The clinical output: risk score, risk level, recommendations (direct download or base64). | Result · PDF |
💡 Which IDs do I keep? Just one. The draftTestIdreturned when you create a draft is thetestIdyou pass to run, result and report endpoints — one GUID for the test's whole life.
The test lifecycle
1.
2.
3.