Health report

Get health report by ID

get

Fetches a health report by its ID

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/health-report/{id}

HTTPcURLJavaScriptPython

GET /api/health-report/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "reportTitle": "Annual Health Report",
  "personId": 123,
  "shared": true,
  "startDate": "2023-01-01T00:00:00.000Z",
  "endDate": "2023-12-31T23:59:59.999Z",
  "summary": "This is a summary of the health report.",
  "cloudId": "cloud-id-123",
  "cloudURL": "cloud-url-123",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-06-01T00:00:00.000Z",
  "healthReportObservationCode": []
}

Update health report

patch

Updates an existing health report

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

healthReportIdnumberRequiredPattern: [^\/#\?]+?

Body

application/json

reportTitlestringRequired

Title of the health report

Example: Annual Health Report

externalIdstringOptional

External identifier for the report

Example: EXT12345

sharedbooleanOptional

Indicates if the report is shared

Example: true

startDateone ofOptional

Start date of the report period

Example: 2023-01-01T00:00:00.000Z

string · dateOptional

or

string · date-timeOptional

endDateone ofOptional

End date of the report period

Example: 2023-12-31T23:59:59.999Z

string · dateOptional

or

string · date-timeOptional

summarystringOptional

Summary of the health report

Example: This is a summary of the health report.

cloudIdstringOptional

Cloud identifier for the report

Example: cloud-12345

personIdintegerOptional

ID of the person the report is about

Example: 123

healthReportObservationCodeanyOptional

Observation code for the health report

sortByanyOptional

Sorting criteria for the report

Default: {"field":"createdAt","order":"desc"}Example: {"field":"reportTitle","order":"asc"}

pageNumberintegerOptional

Page number for pagination

Default: 1Example: 1

pageSizeintegerOptional

Page size for pagination

Default: 10Example: 10

Responses

200Success

application/json

patch

/api/health-report/{healthReportId}

HTTPcURLJavaScriptPython

PATCH /api/health-report/{healthReportId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 372

{
  "reportTitle": "Annual Health Report",
  "externalId": "EXT12345",
  "shared": true,
  "startDate": "2023-01-01T00:00:00.000Z",
  "endDate": "2023-12-31T23:59:59.999Z",
  "summary": "This is a summary of the health report.",
  "cloudId": "cloud-12345",
  "personId": 123,
  "observations": [],
  "healthReportObservationCode": null,
  "sortBy": {
    "field": "reportTitle",
    "order": "asc"
  },
  "pageNumber": 1,
  "pageSize": 10
}

200Success

{
  "id": 1,
  "reportTitle": "Annual Health Report",
  "personId": 123,
  "shared": true,
  "startDate": "2023-01-01T00:00:00.000Z",
  "endDate": "2023-12-31T23:59:59.999Z",
  "summary": "This is a summary of the health report.",
  "cloudId": "cloud-id-123",
  "cloudURL": "cloud-url-123",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-06-01T00:00:00.000Z",
  "healthReportObservationCode": []
}