Observation code group mapping

Get observation code group mappings

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

observationCodeIdnumberRequired

ID of the observation code

Example: 1

observationGroupIdnumberRequired

ID of the observation group

Example: 1

Responses

200Success

application/json

get

/api/observation-code-group-mapping

HTTPcURLJavaScriptPython

GET /api/observation-code-group-mapping?observationCodeId=1&observationGroupId=1 HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "observationGroupId": 1,
    "observationCodeId": 1,
    "observationCode": {
      "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
    },
    "observationGroup": {
      "id": 1,
      "name": "Blood Pressure",
      "label": "BP",
      "organizationId": 100,
      "attributes": {},
      "observationCodes": [],
      "observationGroupCodes": []
    }
  }
]

Create observation code group mapping

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

observationGroupIdnumberOptional

ID of the observation group

Example: 1

observationCodeIdnumberOptional

ID of the observation code

Example: 1

Responses

200Success

application/json

post

/api/observation-code-group-mapping

HTTPcURLJavaScriptPython

POST /api/observation-code-group-mapping 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: 46

{
  "observationGroupId": 1,
  "observationCodeId": 1
}

200Success

{
  "observationGroupId": 1,
  "observationCodeId": 1,
  "observationCode": {
    "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
  },
  "observationGroup": {
    "id": 1,
    "name": "Blood Pressure",
    "label": "BP",
    "organizationId": 100,
    "attributes": {},
    "observationCodes": [],
    "observationGroupCodes": []
  }
}

Delete observation code group mapping

delete

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

observationCodeIdnumberRequired

ID of the observation code

Example: 1

observationGroupIdnumberRequired

ID of the observation group

Example: 1

Responses

200

Successful response

application/json

delete

/api/observation-code-group-mapping

HTTPcURLJavaScriptPython

DELETE /api/observation-code-group-mapping?observationCodeId=1&observationGroupId=1 HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200

Successful response

No content