Observation codes

Get observation codes

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Responses

200Success

application/json

get

/api/observation-codes

HTTPcURLJavaScriptPython

GET /api/observation-codes HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": 1,
    "name": "Heart Rate",
    "label": "HR",
    "code": "HR001",
    "unit": "bpm",
    "entity": "Patient",
    "attributes": {},
    "sourceType": "manual",
    "organizationId": 100,
    "isWearable": true,
    "active": true,
    "observationCodeRange": [],
    "observationCodeGroups": [],
    "observationCodePurposeMapping": [],
    "isTemplate": true,
    "templateId": 1
  }
]

Create a new observation code

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

namestringOptional

Name of the observation code

Example: BP

codestringOptional

Observation code

Example: Spirometer

labelstringOptional

Label of the observation code

Example: Breathing Rate

unitstringOptional

Unit of the observation code

Example: mg/dL

entitystringOptional

Entity of the observation code

Example: GENERAL

isWearablebooleanOptional

Is wearable observation code

Example: true

sourceTypestringOptional

The source where the observation got from

Example: APPLE_WATCH

organizationIdnumberOptional

Organization ID associated with the observation

Example: 123

observationGroupIdnumberOptional

Observation group ID

Example: 456

observationGroupNamestringOptional

Observation group name

Example: Vitals

attributesanyOptional

Attributes of the observation code

Example: {"formatCode":"3","checkedForSame":true}

purposeIdsanyOptional

templateIdnumberOptional

Template ID

Example: 123

Responses

200Success

application/json

201

observation code created successfully

400

Bad request - invalid input data

401

Unauthorized - invalid API key

500

Internal server error

post

/api/observation-codes

HTTPcURLJavaScriptPython

POST /api/observation-codes 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: 446

{
  "name": "BP",
  "code": "Spirometer",
  "label": "Breathing Rate",
  "unit": "mg/dL",
  "entity": "GENERAL",
  "isWearable": true,
  "sourceType": "APPLE_WATCH",
  "organizationId": 123,
  "observationGroupId": 456,
  "observationGroupName": "Vitals",
  "observationCodeRange": [
    {
      "min": "-inf",
      "max": "30",
      "name": "optimal",
      "gender": "MALE",
      "attributes": {
        "order": 0,
        "gender": "MALE",
        "formatCode": "2"
      }
    }
  ],
  "attributes": {
    "formatCode": "3",
    "checkedForSame": true
  },
  "purposeIds": null,
  "templateId": 123
}

{
  "id": 1,
  "name": "Heart Rate",
  "label": "HR",
  "code": "HR001",
  "unit": "bpm",
  "entity": "Patient",
  "attributes": {},
  "sourceType": "manual",
  "organizationId": 100,
  "isWearable": true,
  "active": true,
  "observationCodeRange": [],
  "observationCodeGroups": [],
  "observationCodePurposeMapping": [],
  "isTemplate": true,
  "templateId": 1
}

Get observation code by ID

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200Success

application/json

get

/api/observation-codes/{id}

HTTPcURLJavaScriptPython

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

200Success

{
  "id": 1,
  "name": "Heart Rate",
  "label": "HR",
  "code": "HR001",
  "unit": "bpm",
  "entity": "Patient",
  "attributes": {},
  "sourceType": "manual",
  "organizationId": 100,
  "isWearable": true,
  "active": true,
  "observationCodeRange": [],
  "observationCodeGroups": [],
  "observationCodePurposeMapping": [],
  "isTemplate": true,
  "templateId": 1
}

Update an observation code by ID

put

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

namestringOptional

Name of the observation code

Example: BP

codestringOptional

Observation code

Example: Spirometer

labelstringOptional

Label of the observation code

Example: Breathing Rate

unitstringOptional

Unit of the observation code

Example: mg/dL

entitystringOptional

Entity of the observation code

Example: GENERAL

isWearablebooleanOptional

Is wearable observation code

Example: true

sourceTypestringOptional

The source where the observation got from

Example: APPLE_WATCH

organizationIdnumberOptional

Organization ID associated with the observation

Example: 123

observationGroupIdnumberOptional

Observation group ID

Example: 456

observationGroupNamestringOptional

Observation group name

Example: Vitals

attributesanyOptional

Attributes of the observation code

Example: {"formatCode":"3","checkedForSame":true}

purposeIdsanyOptional

templateIdnumberOptional

Template ID

Example: 123

Responses

200Success

application/json

put

/api/observation-codes/{id}

HTTPcURLJavaScriptPython

PUT /api/observation-codes/{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: 446

{
  "name": "BP",
  "code": "Spirometer",
  "label": "Breathing Rate",
  "unit": "mg/dL",
  "entity": "GENERAL",
  "isWearable": true,
  "sourceType": "APPLE_WATCH",
  "organizationId": 123,
  "observationGroupId": 456,
  "observationGroupName": "Vitals",
  "observationCodeRange": [
    {
      "min": "-inf",
      "max": "30",
      "name": "optimal",
      "gender": "MALE",
      "attributes": {
        "order": 0,
        "gender": "MALE",
        "formatCode": "2"
      }
    }
  ],
  "attributes": {
    "formatCode": "3",
    "checkedForSame": true
  },
  "purposeIds": null,
  "templateId": 123
}

200Success

{
  "id": 1,
  "name": "Heart Rate",
  "label": "HR",
  "code": "HR001",
  "unit": "bpm",
  "entity": "Patient",
  "attributes": {},
  "sourceType": "manual",
  "organizationId": 100,
  "isWearable": true,
  "active": true,
  "observationCodeRange": [],
  "observationCodeGroups": [],
  "observationCodePurposeMapping": [],
  "isTemplate": true,
  "templateId": 1
}

Delete an observation code by ID

delete

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200Success

application/json

delete

/api/observation-codes/{id}

HTTPcURLJavaScriptPython

DELETE /api/observation-codes/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "name": "Heart Rate",
  "label": "HR",
  "code": "HR001",
  "unit": "bpm",
  "entity": "Patient",
  "attributes": {},
  "sourceType": "manual",
  "organizationId": 100,
  "isWearable": true,
  "active": true,
  "observationCodeRange": [],
  "observationCodeGroups": [],
  "observationCodePurposeMapping": [],
  "isTemplate": true,
  "templateId": 1
}