opensafely-core / opencodelists

OpenCodelists is an open platform for creating and sharing codelists of clinical terms and drugs.
https://www.opencodelists.org
Other
31 stars 9 forks source link

Add Codelist Metadata to API response #1991

Closed lucyb closed 1 month ago

lucyb commented 1 month ago

See Slack 🧵 thread.

We've been asked if we could allow HDRUK to retrieve information about individual codelists, including metadata such as description and references. If this is to be useful to them if needs to be available in the "near future", which I've taken to mean by mid-end July.

The current api/v1/codelist endpoint returns this information, but does not include the description and references. This metadata is stored on a codelist rather than codelist version so it should be fairly straightforward to include this as well. Note: This endpoint is currently used by OSI, which does not require this information, but also should be able to ignore it.

Acceptance criteria

  1. Ability to retrieve codelist information, including metadata such as description and references via an API endpoint.
  2. OSI is still able to retrieve codelist information as expected (test locally, if required).
  3. Let Seb know this work has been done, so that he can inform the developer who wants to have this information.