Observations

Get observations for a patient

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Query parameters

observationCodeNameanyOptional

observationGroupNameanyOptional

draftbooleanOptional

Draft status of the observation

Example: true

sourceTypestring · enumOptional

Source type of the observation

Example: type1Possible values:

sourceIdnumber[]Optional

Source ID of the observation

Example: 123

observationCodeIdnumber[]Optional

IDs of the observation codes

Default: []Example: [1,2]

observationGroupIdnumber[]Optional

IDs of the observation groups

Default: []Example: [1,2]

organizationIdnumberOptional

Organization ID associated with the observation

Example: 100

startDateone ofOptional

Start date of the observation

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

string · dateOptional

or

string · date-timeOptional

dateone ofOptional

Date of the observation

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

string · dateOptional

or

string · date-timeOptional

patientIdstringOptional

Patient ID associated with the observation

Example: patient123

isWearablebooleanOptional

Indicates if the observation is from a wearable device

Example: true

personIdnumberOptional

Person ID associated with the observation

Example: 456

endDateone ofOptional

End date of the observation

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

string · dateOptional

or

string · date-timeOptional

skipnumberOptional

Number of records to skip

Example: 10

limitnumberOptional

Limit on the number of records to retrieve

Default: 10Example: 50

sortstringOptional

Sort order of the results

Default: descExample: asc

sortFieldstringOptional

latestbooleanOptional

If true, returns only the latest observation for each code

Example: true

Responses

200Success

application/json

get

/api/patients/{patientIdForObservation}/observations

HTTPcURLJavaScriptPython

GET /api/patients/{patientIdForObservation}/observations HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "externalId": "ext-123",
    "name": "Blood Test Group",
    "date": "2023-01-01T00:00:00.000Z",
    "observationGroupId": 10,
    "observationGroupName": "General Observations",
    "sourceId": 5,
    "sourceType": "LAB",
    "observations": []
  }
]

Create a new observation for a patient

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

idstringRequired

externalIdstringOptional

External identifier for the observation group

Example: ext-123

patientIdstringOptional

Identifier of the patient

Example: pat-456

namestringOptional

Name of the observation group

Example: Blood Test Group

attributesanyOptional

Additional attributes for the observation group

Default: {}

observationGroupIdnumberOptional

Identifier of the parent observation group

Example: 2

personIdnumberOptional

Identifier of the person associated with the observation group

Example: 3

dateone ofOptional

Date of the observation group

Default: 2026-02-05T05:13:47.730ZExample: 2023-01-01T00:00:00.000Z

string · dateOptional

or

string · date-timeOptional

sourceIdnumberOptional

Identifier of the source

Example: 4

sourceTypeanyOptional

Type of the source

Default: APPLE_WATCHExample: APPLE_WATCH

Responses

200Success

application/json

post

/api/patients/{patientIdForObservation}/observations

HTTPcURLJavaScriptPython

POST /api/patients/{patientIdForObservation}/observations 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: 228

{
  "id": "text",
  "externalId": "ext-123",
  "patientId": "pat-456",
  "name": "Blood Test Group",
  "attributes": {},
  "observationGroupId": 2,
  "personId": 3,
  "date": "2023-01-01T00:00:00.000Z",
  "sourceId": 4,
  "sourceType": "APPLE_WATCH",
  "observations": []
}

200Success

{
  "id": "text",
  "externalId": "ext-123",
  "name": "Blood Test Group",
  "date": "2023-01-01T00:00:00.000Z",
  "observationGroupId": 10,
  "observationGroupName": "General Observations",
  "sourceId": 5,
  "sourceType": "LAB",
  "observations": []
}

Update observations for a patient

put

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

idstringRequired

externalIdstringOptional

External identifier for the observation group

Example: ext-123

patientIdstringOptional

Identifier of the patient

Example: pat-456

namestringOptional

Name of the observation group

Example: Blood Test Group

attributesanyOptional

Additional attributes for the observation group

Default: {}

observationGroupIdnumberOptional

Identifier of the parent observation group

Example: 2

personIdnumberOptional

Identifier of the person associated with the observation group

Example: 3

dateone ofOptional

Date of the observation group

Default: 2026-02-05T05:13:47.730ZExample: 2023-01-01T00:00:00.000Z

string · dateOptional

or

string · date-timeOptional

sourceIdnumberOptional

Identifier of the source

Example: 4

sourceTypeanyOptional

Type of the source

Default: APPLE_WATCHExample: APPLE_WATCH

Responses

200Success

application/json

put

/api/patients/{patientIdForObservation}/observations

HTTPcURLJavaScriptPython

PUT /api/patients/{patientIdForObservation}/observations 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: 228

{
  "id": "text",
  "externalId": "ext-123",
  "patientId": "pat-456",
  "name": "Blood Test Group",
  "attributes": {},
  "observationGroupId": 2,
  "personId": 3,
  "date": "2023-01-01T00:00:00.000Z",
  "sourceId": 4,
  "sourceType": "APPLE_WATCH",
  "observations": []
}

200Success

{
  "id": "text",
  "externalId": "ext-123",
  "name": "Blood Test Group",
  "date": "2023-01-01T00:00:00.000Z",
  "observationGroupId": 10,
  "observationGroupName": "General Observations",
  "sourceId": 5,
  "sourceType": "LAB",
  "observations": []
}

Delete observations for a patient

delete

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Query parameters

observationCodeNameanyOptional

observationGroupNameanyOptional

draftbooleanOptional

Draft status of the observation

Example: true

sourceTypestring · enumOptional

Source type of the observation

Example: type1Possible values:

sourceIdnumber[]Optional

Source ID of the observation

Example: 123

observationCodeIdnumber[]Optional

IDs of the observation codes

Default: []Example: [1,2]

observationGroupIdnumber[]Optional

IDs of the observation groups

Default: []Example: [1,2]

organizationIdnumberOptional

Organization ID associated with the observation

Example: 100

startDateone ofOptional

Start date of the observation

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

string · dateOptional

or

string · date-timeOptional

dateone ofOptional

Date of the observation

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

string · dateOptional

or

string · date-timeOptional

patientIdstringOptional

Patient ID associated with the observation

Example: patient123

isWearablebooleanOptional

Indicates if the observation is from a wearable device

Example: true

personIdnumberOptional

Person ID associated with the observation

Example: 456

endDateone ofOptional

End date of the observation

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

string · dateOptional

or

string · date-timeOptional

skipnumberOptional

Number of records to skip

Example: 10

limitnumberOptional

Limit on the number of records to retrieve

Default: 10Example: 50

sortstringOptional

Sort order of the results

Default: descExample: asc

sortFieldstringOptional

latestbooleanOptional

If true, returns only the latest observation for each code

Example: true

Responses

200Success

application/json

delete

/api/patients/{patientIdForObservation}/observations

HTTPcURLJavaScriptPython

DELETE /api/patients/{patientIdForObservation}/observations HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "externalId": "ext-123",
  "name": "Blood Test Group",
  "date": "2023-01-01T00:00:00.000Z",
  "observationGroupId": 10,
  "observationGroupName": "General Observations",
  "sourceId": 5,
  "sourceType": "LAB",
  "observations": []
}