Health record

Get health record by ID

get

Fetches a health record by its ID

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Query parameters

namestringOptional

Name of the file

Example: example.txt

fetchAllFilesbooleanOptional

Fetch all files flag

Example: true

cloudIdstringOptional

Cloud ID

Example: cloud123

idnumberOptional

ID of the file

Example: 1

fileIdnumber[]Optional

archivedbooleanOptional

Archived status

Example: true

personIdnumberOptional

Person ID associated with the file

Example: 123

externalIdstringOptional

External ID

Example: ext123

patientIdstringOptional

Patient ID

Example: pat123

expandRelatedFilesbooleanOptional

Expand related files flag

Example: true

pageNumbernumberOptional

Page number for pagination

Default: 1Example: 1

pageSizenumberOptional

Page size for pagination

Default: 10Example: 10

organizationIdnumberOptional

Organization ID

Example: 1

Responses

200Success

application/json

get

/api/health-record/{healthRecordId}

HTTPcURLJavaScriptPython

GET /api/health-record/{healthRecordId}?sortBy=[object+Object] HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "healthRecord": {
    "id": 1,
    "name": "text",
    "resource": null,
    "cloudId": "text",
    "cloudUrl": "text",
    "scanStatus": "text",
    "mimeType": "text",
    "personId": 1,
    "createdAt": "2025-12-13",
    "updatedAt": "2025-12-13",
    "attributes": {},
    "archived": true,
    "healthRecordAttributeFile": [
      {
        "id": 12,
        "fileId": 12,
        "healthRecordAttributeId": 12,
        "notes": "This is example file",
        "createdAt": "2023-03-02 07:14:19.987",
        "updatedAt": "2023-03-02 07:14:19.987"
      }
    ],
    "labels": {},
    "relatedFiles": [
      {
        "id": 1,
        "name": "text",
        "resource": null,
        "cloudId": "text",
        "cloudUrl": "text",
        "scanStatus": "text",
        "mimeType": "text",
        "personId": 1,
        "createdAt": "2025-12-13",
        "updatedAt": "2025-12-13",
        "attributes": {},
        "archived": true,
        "healthRecordAttributeFile": [
          {
            "id": 12,
            "fileId": 12,
            "healthRecordAttributeId": 12,
            "notes": "This is example file",
            "createdAt": "2023-03-02 07:14:19.987",
            "updatedAt": "2023-03-02 07:14:19.987"
          }
        ],
        "labels": {},
        "relatedFiles": [
          {
            "id": 1,
            "name": "text",
            "resource": null,
            "cloudId": "text",
            "cloudUrl": "text",
            "scanStatus": "text",
            "mimeType": "text",
            "personId": 1,
            "createdAt": "2025-12-13",
            "updatedAt": "2025-12-13",
            "attributes": {},
            "archived": true,
            "healthRecordAttributeFile": [
              {
                "id": 12,
                "fileId": 12,
                "healthRecordAttributeId": 12,
                "notes": "This is example file",
                "createdAt": "2023-03-02 07:14:19.987",
                "updatedAt": "2023-03-02 07:14:19.987"
              }
            ],
            "labels": {},
            "relatedFiles": "[Circular Reference]",
            "relatedFile": "[Circular Reference]",
            "isRelatedFile": true,
            "updatedBy": {},
            "person": {
              "id": 1,
              "firstName": "John",
              "lastName": "Doe",
              "birthDate": "1990-01-01",
              "gender": "MALE",
              "mobile": "[phone]",
              "email": "[email protected]",
              "uuid": "uuid-1234",
              "externalId": "external-1234",
              "currency": "USD",
              "consumer": "{}",
              "serviceProvider": "{}"
            }
          }
        ],
        "relatedFile": [
          {
            "id": 1,
            "fromFileId": 1,
            "toFileId": 1,
            "fromFile": "[Circular Reference]",
            "toFile": "[Circular Reference]",
            "createdAt": "2025-12-13",
            "updatedAt": "2025-12-13"
          }
        ],
        "isRelatedFile": true,
        "updatedBy": {},
        "person": {
          "id": 1,
          "firstName": "John",
          "lastName": "Doe",
          "birthDate": "1990-01-01",
          "gender": "MALE",
          "mobile": "[phone]",
          "email": "[email protected]",
          "uuid": "uuid-1234",
          "externalId": "external-1234",
          "currency": "USD",
          "consumer": "{}",
          "serviceProvider": "{}"
        }
      }
    ],
    "relatedFile": [
      {
        "id": 1,
        "fromFileId": 1,
        "toFileId": 1,
        "fromFile": "[Circular Reference]",
        "toFile": "[Circular Reference]",
        "createdAt": "2025-12-13",
        "updatedAt": "2025-12-13"
      }
    ],
    "isRelatedFile": true,
    "updatedBy": {},
    "person": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "birthDate": "1990-01-01",
      "gender": "MALE",
      "mobile": "[phone]",
      "email": "[email protected]",
      "uuid": "uuid-1234",
      "externalId": "external-1234",
      "currency": "USD",
      "consumer": "{}",
      "serviceProvider": "{}"
    }
  },
  "cloudUrl": {
    "signedUrl": "text",
    "cloudId": "text",
    "organizationId": 1,
    "fileName": "text"
  }
}

Update health record file

put

Updates the file for a specific health record

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

idintegerOptional

ID associated with the file

Example: 123

namestringOptional

Name of the file

Example: example.txt

cloudIdstringOptional

Cloud ID of the file

Example: 121/0081905e-c201-4277-8fda-8ad296573f581737719364614

resourceobjectOptional

Resource associated with the file

Default: {}

mimeTypestringOptional

MIME type of the file

Example: application/pdf

personIdintegerOptional

Person ID associated with the file

Example: 123

documentLabelIdintegerOptional

Document Label ID associated with the organization tags

Example: 123

externalIdstringOptional

External ID of the file

Example: ext123

attributesobjectOptional

Attributes of the file

Default: {}

archivedbooleanOptional

Whether the file is archived

relatedFilesobjectOptional

Related files

Default: {}

updatedByobjectOptional

User who updated the file

Default: {}

Responses

200

Successful response

application/json

put

/api/health-record/{healthRecordId}

HTTPcURLJavaScriptPython

PUT /api/health-record/{healthRecordId} 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: 276

{
  "id": 123,
  "name": "example.txt",
  "cloudId": "121/0081905e-c201-4277-8fda-8ad296573f581737719364614",
  "resource": {},
  "mimeType": "application/pdf",
  "personId": 123,
  "documentLabelId": 123,
  "externalId": "ext123",
  "attributes": {},
  "archived": true,
  "labels": {},
  "relatedFiles": {},
  "updatedBy": {}
}

200

Successful response

No content

Update health record notes

patch

Updates notes for a specific health record

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

anyOptional

Responses

200

Successful response

application/json

patch

/api/health-record/{healthRecordId}

HTTPcURLJavaScriptPython

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

200

Successful response

No content