TRANXACT.AI Help

EHR · Services and actions

Public health

The public health service of EHR: 3 operation(s).

Type REST3 operationsBase path /api/ehr/public-health

Download specification (OpenAPI 3.1)

Overview

PackageEHR
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold EHR › Public health on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

3 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ehr/public-health/immunization-dueImmunization due

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ehr/public-health/immunization-due" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ehr/public-health/surveillanceSurveillance

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ehr/public-health/surveillance" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ehr/public-health/populationPopulation

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ehr/public-health/population" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold EHR › Public health for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.