Observation groups

Get observation groups

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

namestring[]Optional

labelstringOptional

Label of the observation group

Example: Label A

idnumberOptional

ID of the observation group

Example: 1

organizationIdnumberOptional

Organization ID associated with the observation group

Example: 100

includeInactiveCodesbooleanOptional

Include inactive codes in the observation group

Example: true

Responses

200Success

application/json

get

/api/observation-groups

HTTPcURLJavaScriptPython

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

200Success

[
  {
    "id": 1,
    "name": "Blood Pressure",
    "label": "BP",
    "organizationId": 100,
    "attributes": {},
    "observationCodes": [],
    "observationGroupCodes": []
  }
]

Create a new observation group

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

namestringRequired

Name of the observation group

Example: Group A

labelstringOptional

Label for the observation group

Example: Label A

organizationIdnumberRequired

ID of the organization

Example: 123

attributesobjectRequired

Attributes of the observation group

Default: {}Example: {"key":"value"}

Responses

200Success

application/json

post

/api/observation-groups

HTTPcURLJavaScriptPython

POST /api/observation-groups 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: 86

{
  "name": "Group A",
  "label": "Label A",
  "organizationId": 123,
  "attributes": {
    "key": "value"
  }
}

200Success

{
  "id": 1,
  "name": "Blood Pressure",
  "label": "BP",
  "organizationId": 100,
  "attributes": {},
  "observationCodes": [],
  "observationGroupCodes": []
}

Get observation group 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-groups/{id}

HTTPcURLJavaScriptPython

GET /api/observation-groups/{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": "Blood Pressure",
  "label": "BP",
  "organizationId": 100,
  "attributes": {},
  "observationCodes": [],
  "observationGroupCodes": []
}

Update an observation group by ID

put

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

namestringRequired

Name of the observation group

Example: Group A

labelstringOptional

Label for the observation group

Example: Label A

organizationIdnumberRequired

ID of the organization

Example: 123

attributesobjectRequired

Attributes of the observation group

Default: {}Example: {"key":"value"}

Responses

200Success

application/json

put

/api/observation-groups/{id}

HTTPcURLJavaScriptPython

PUT /api/observation-groups/{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: 86

{
  "name": "Group A",
  "label": "Label A",
  "organizationId": 123,
  "attributes": {
    "key": "value"
  }
}

200Success

{
  "id": 1,
  "name": "Blood Pressure",
  "label": "BP",
  "organizationId": 100,
  "attributes": {},
  "observationCodes": [],
  "observationGroupCodes": []
}

Delete an observation group by ID

delete

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200Success

application/json

delete

/api/observation-groups/{id}

HTTPcURLJavaScriptPython

DELETE /api/observation-groups/{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": "Blood Pressure",
  "label": "BP",
  "organizationId": 100,
  "attributes": {},
  "observationCodes": [],
  "observationGroupCodes": []
}