Templates

Get all observation code templates

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Responses

200Success

application/json

401

Unauthorized - invalid API key

500

Internal server error

get

/api/observation-code/templates

HTTPcURLJavaScriptPython

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

[
  {
    "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 observation code template

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

namestring · min: 1Required

labelstringOptional

codestring · min: 1Required

unitstring · min: 1Required

sourceTypestring · enumOptionalPossible values:

entitystringOptional

isWearablebooleanOptional

organizationIdnumberOptional

attributesobjectOptional

Responses

200Success

application/json

201

Template created successfully

400

Bad request - invalid input data

401

Unauthorized - invalid API key

500

Internal server error

post

/api/observation-code/templates

HTTPcURLJavaScriptPython

POST /api/observation-code/templates 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: 147

{
  "name": "text",
  "label": "text",
  "code": "text",
  "unit": "text",
  "sourceType": "FILE",
  "entity": "text",
  "isWearable": true,
  "organizationId": 1,
  "attributes": {}
}

{
  "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 observation code template and optionally its associated codes

put

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

namestringOptional

labelstringOptional

codestringOptional

unitstringOptional

sourceTypestring · enumOptionalPossible values:

entitystringOptional

isWearablebooleanOptional

attributesobjectOptional

updateAssociatedCodesbooleanOptional

Responses

200Success

application/json

400

Bad request - invalid input data

401

Unauthorized - invalid API key

404

Template not found

500

Internal server error

put

/api/observation-code/templates/{id}

HTTPcURLJavaScriptPython

PUT /api/observation-code/templates/{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: 157

{
  "name": "text",
  "label": "text",
  "code": "text",
  "unit": "text",
  "sourceType": "FILE",
  "entity": "text",
  "isWearable": true,
  "attributes": {},
  "updateAssociatedCodes": true
}

{
  "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 observation code template and associated codes

delete

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200

Template and associated codes deactivated successfully

application/json

401

Unauthorized - invalid API key

404

Template not found

500

Internal server error

delete

/api/observation-code/templates/{id}

HTTPcURLJavaScriptPython

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

No content