V2

Get v2 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/v2

HTTPcURLJavaScriptPython

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

200Success

[
  {
    "id": "text",
    "patientId": "12345",
    "name": "Blood Pressure",
    "date": "2023-01-01T00:00:00.000Z",
    "key": "BP",
    "value": "120/80",
    "status": "completed",
    "draft": true,
    "currentStatus": "active",
    "sourceType": "APPLE_WATCH",
    "sourceId": 100,
    "patient": {},
    "observationCodeId": 10,
    "observationCode": {},
    "observationGroupId": 5,
    "observationGroup": {},
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "observationPurposeRangeLabelId": 1,
    "observationPurposeRangeLabel": {
      "id": 1,
      "label": "test"
    },
    "remarks": "Patient is stable"
  }
]

Create v2 observations for a patient

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Bodyobject[]

application/json

object[]Optional

Responses

200Success

application/json

post

/api/patients/{patientIdForObservation}/observations/v2

HTTPcURLJavaScriptPython

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

[
  {}
]

200Success

[
  {
    "id": "text",
    "patientId": "12345",
    "name": "Blood Pressure",
    "date": "2023-01-01T00:00:00.000Z",
    "key": "BP",
    "value": "120/80",
    "status": "completed",
    "draft": true,
    "currentStatus": "active",
    "sourceType": "APPLE_WATCH",
    "sourceId": 100,
    "patient": {},
    "observationCodeId": 10,
    "observationCode": {},
    "observationGroupId": 5,
    "observationGroup": {},
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "observationPurposeRangeLabelId": 1,
    "observationPurposeRangeLabel": {
      "id": 1,
      "label": "test"
    },
    "remarks": "Patient is stable"
  }
]

Get v2 observation by ID for a patient

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Responses

200Success

application/json

get

/api/patients/{patientIdForObservation}/observations/v2/{id}

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "patientId": "12345",
  "name": "Blood Pressure",
  "date": "2023-01-01T00:00:00.000Z",
  "key": "BP",
  "value": "120/80",
  "status": "completed",
  "draft": true,
  "currentStatus": "active",
  "sourceType": "APPLE_WATCH",
  "sourceId": 100,
  "patient": {},
  "observationCodeId": 10,
  "observationCode": {},
  "observationGroupId": 5,
  "observationGroup": {},
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "observationPurposeRangeLabelId": 1,
  "observationPurposeRangeLabel": {
    "id": 1,
    "label": "test"
  },
  "remarks": "Patient is stable"
}

Update v2 observation by ID for a patient

put

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Body

application/json

patientIdnumberOptional

organizationIdnumberOptional

namestringRequired

keystringOptional

observationCodeNamestringOptional

observationCodeIdnumberOptional

observationGroupIdnumberOptional

observationGroupNamestringOptional

valuestringRequired

sourceTypestringOptional

sourceIdnumberOptional

statusstringOptional

draftbooleanOptional

rangeanyOptional

unitstringOptional

dateone ofRequired

string · dateOptional

or

string · date-timeOptional

observationPurposeRangeLabelIdnumberOptional

remarksstringOptional

Responses

200Success

application/json

put

/api/patients/{patientIdForObservation}/observations/v2/{id}

HTTPcURLJavaScriptPython

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

{
  "patientId": 1,
  "organizationId": 1,
  "name": "text",
  "key": "text",
  "observationCodeName": "text",
  "observationCodeId": 1,
  "observationGroupId": 1,
  "observationGroupName": "text",
  "value": "text",
  "sourceType": "text",
  "sourceId": 1,
  "status": "text",
  "draft": true,
  "range": null,
  "unit": "text",
  "date": "2026-02-07",
  "observationPurposeRangeLabelId": 1,
  "remarks": "text"
}

200Success

{
  "id": "text",
  "patientId": "12345",
  "name": "Blood Pressure",
  "date": "2023-01-01T00:00:00.000Z",
  "key": "BP",
  "value": "120/80",
  "status": "completed",
  "draft": true,
  "currentStatus": "active",
  "sourceType": "APPLE_WATCH",
  "sourceId": 100,
  "patient": {},
  "observationCodeId": 10,
  "observationCode": {},
  "observationGroupId": 5,
  "observationGroup": {},
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "observationPurposeRangeLabelId": 1,
  "observationPurposeRangeLabel": {
    "id": 1,
    "label": "test"
  },
  "remarks": "Patient is stable"
}

Delete v2 observation by ID for a patient

delete

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Responses

200Success

application/json

delete

/api/patients/{patientIdForObservation}/observations/v2/{id}

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "patientId": "12345",
  "name": "Blood Pressure",
  "date": "2023-01-01T00:00:00.000Z",
  "key": "BP",
  "value": "120/80",
  "status": "completed",
  "draft": true,
  "currentStatus": "active",
  "sourceType": "APPLE_WATCH",
  "sourceId": 100,
  "patient": {},
  "observationCodeId": 10,
  "observationCode": {},
  "observationGroupId": 5,
  "observationGroup": {},
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "observationPurposeRangeLabelId": 1,
  "observationPurposeRangeLabel": {
    "id": 1,
    "label": "test"
  },
  "remarks": "Patient is stable"
}