NCP Step 4 — monitoring and evaluation

POST /fhir/Goal/$evaluate · API key required

Compares current values to baseline/target and returns Goals with achievementStatus plus outcome Observations. Direction of change is not guessed without a baseline; units must match. Stateless: nothing is stored. Body is a FHIR Parameters resource; success is a Bundle; errors are OperationOutcomes. See the API README, "NCP operations". Access: this operation needs a Bearer credential carrying the scope `system/Goal.write`. A missing credential returns 401, a missing scope 403 (both as OperationOutcome).

Request body

Content type: application/json

Responses

• 200 - FHIR Bundle
• 400 - FHIR OperationOutcome — malformed or incomplete input
• 401 - Missing or invalid credential
• 403 - Credential lacks the required FHIR scope
• 422 - FHIR OperationOutcome — valid input, unsupported case (e.g. a child sent to the adult assessment)
• 429

Back to the API reference