Medical Data API

The HCG AI API provides endpoints for managing pregnancy-related medical data, specifically HCG hormone levels and ultrasound scan measurements. All data endpoints require active session authentication.

Authentication Requirement

All requests to the medical data endpoints must include session cookies. If the user is not logged in, the server returns a 401 Unauthorized response.

HCG Blood Test Entries

Manage $\beta$-hCG tracking data over time.

`GET /api/hcg-entries`

Retrieves all HCG entries associated with the authenticated user, sorted by date.

Response (Array of Objects):

[
  {
    "id": 1,
    "date": "2023-10-25",
    "hcgValue": 1500,
    "units": "mIU/mL",
    "notes": "First test",
    "lmpDate": "2023-09-20",
    "cycleLength": 28,
    "createdAt": "2023-10-25T10:00:00Z"
  }
]

`POST /api/hcg-entries`

Creates a new HCG entry.

`PUT /api/hcg-entries/:id`

Updates an existing entry by ID.

`DELETE /api/hcg-entries/:id`

Permanently removes an entry.

Ultrasound Scan Entries

Manage gestational sac measurements and fetal heart rate data.

`GET /api/ultrasound-entries`

Retrieves all ultrasound scan records for the authenticated user.

`POST /api/ultrasound-entries`

Records a new ultrasound scan.

Analysis Results

Analysis results are generated based on HCG trends or ultrasound measurements. These are read-only resources reflecting the system's risk assessment.

`GET /api/analysis-results`

Retrieves all calculated diagnoses and risk assessments.

Response Object:

{
  "id": 42,
  "entryType": "hcg",
  "entryId": 12,
  "diagnosis": "Normal HCG doubling rate detected.",
  "riskLevel": "LOW",
  "recommendations": [
    "Schedule follow-up scan in 2 weeks",
    "Continue prenatal vitamins"
  ],
  "zScores": {
    "hcg_z": 0.45
  }
}

Risk Levels:

LOW: Measurements fall within expected clinical ranges.
MEDIUM: Requires clinical correlation or follow-up testing.
HIGH: Results significantly deviate from expected values; immediate medical consultation recommended.

Error Responses