Export custom code system

GET/construe/codes/systems/{codesystem}/export

Exports a custom (non-builtin) code system as a JSON file compatible with the upload format. The exported file can be re-uploaded directly via POST /construe/upload with format "json". Only available on dedicated instances. Builtin systems cannot be exported.

RequiresBearerauthentication

Path parameters

codesystemstringrequired

Code system name

Query parameters

versionstringoptional

Specific version of the code system. Required if multiple versions exist.

Returns

Exported code system as JSON file

Response fields

namestringrequired

Code system name

versionstringrequired

Code system version

formatstringrequired

Upload format (always "json")

json

codesobject[]required

All codes in the system

codestringrequired

The code identifier

descriptionstringrequired

Short description of the code

definitionstringoptional

Extended definition of the code (if available)

GETRequest

curl 'https://experiment.app.pheno.ml/construe/codes/systems/CUSTOM_CODES/export?version=example' \
  -H 'Authorization: Bearer YOUR_API_KEY'

200 OKResponse

{
  "name": "CUSTOM_CODES",
  "version": "1.0",
  "format": "json",
  "codes": [
    {
      "code": "E11.65",
      "description": "Type 2 diabetes mellitus with hyperglycemia",
      "definition": "example"
    }
  ]
}