{"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO":{"page":{"title":"Extra API","type":"openapi","mode":"folder","config":{"expandAllResponses":false,"expandAllModelSections":false,"defaultOpenAllTags":false,"showOperationId":false,"hideTestRequestButton":false,"documentDownloadType":"both","hideModels":false,"orderSchemaPropertiesBy":"alpha","orderRequiredPropertiesFirst":true,"operationTitleSource":"summary","hideClientButton":false},"singlePage":false,"showInSidebar":true,"filepath":"docs/extra.openapi.yaml","isIndex":false,"uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","version":"default","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"description":"","children":[{"type":"openapi-info","title":"Introduction","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1description~1introduction","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","ref":"#/info","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/description/introduction"},{"type":"openapi-operation","title":"Startup probe","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1health~1GET~1extra~1health~1startup","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/health/startup","ref":"/paths/~1extra~1health~1startup/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/startup"},{"type":"openapi-operation","title":"Liveness probe","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1health~1GET~1extra~1health~1live","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/health/live","ref":"/paths/~1extra~1health~1live/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/live"},{"type":"openapi-operation","title":"Readiness probe","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1health~1GET~1extra~1health~1ready","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/health/ready","ref":"/paths/~1extra~1health~1ready/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/ready"},{"type":"openapi-tag","title":"Health","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1health","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","tag":{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health","title":"Health","name":"Health","description":"Health checks for monitoring and orchestration.\nUsed for startup, liveness, and readiness probes.\n","children":[{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/startup","title":"Startup probe","path":"/extra/health/startup","method":"get","ref":"#/paths/~1extra~1health~1startup/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/startup/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/live","title":"Liveness probe","path":"/extra/health/live","method":"get","ref":"#/paths/~1extra~1health~1live/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/live/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/ready","title":"Readiness probe","path":"/extra/health/ready","method":"get","ref":"#/paths/~1extra~1health~1ready/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/ready/example/default","title":"default","name":"default"}]}],"isGroup":false,"isWebhooks":false,"type":"tag","xKeys":{"x-scalar-order":["omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/startup","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/live","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health/GET/extra/health/ready"]}},"navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/health"},{"type":"openapi-operation","title":"Get user info","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1user~1GET~1extra~1v1~1user~1info","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/user/info","ref":"/paths/~1extra~1v1~1user~1info/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user/GET/extra/v1/user/info"},{"type":"openapi-operation","title":"Get user caseload","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1user~1GET~1extra~1v1~1user~1caseload","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/user/caseload","ref":"/paths/~1extra~1v1~1user~1caseload/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user/GET/extra/v1/user/caseload"},{"type":"openapi-tag","title":"User","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1user","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","tag":{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user","title":"User","name":"User","description":"User information and caseload for the authenticated user.\n","children":[{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user/GET/extra/v1/user/info","title":"Get user info","path":"/extra/v1/user/info","method":"get","ref":"#/paths/~1extra~1v1~1user~1info/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user/GET/extra/v1/user/info/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user/GET/extra/v1/user/caseload","title":"Get user caseload","path":"/extra/v1/user/caseload","method":"get","ref":"#/paths/~1extra~1v1~1user~1caseload/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user/GET/extra/v1/user/caseload/example/default","title":"default","name":"default"}]}],"isGroup":false,"isWebhooks":false,"type":"tag","xKeys":{"x-scalar-order":["omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user/GET/extra/v1/user/info","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user/GET/extra/v1/user/caseload"]}},"navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/user"},{"type":"openapi-operation","title":"List datamap definitions","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-definition~1GET~1extra~1v1~1definition~1datamap","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/definition/datamap","ref":"/paths/~1extra~1v1~1definition~1datamap/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap"},{"type":"openapi-operation","title":"Get datamap definition","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-definition~1GET~1extra~1v1~1definition~1datamap~1{datamapName}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/definition/datamap/{datamapName}","ref":"/paths/~1extra~1v1~1definition~1datamap~1{datamapName}/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap/{datamapName}"},{"type":"openapi-operation","title":"Create or update datamap definition","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-definition~1PUT~1extra~1v1~1definition~1datamap~1{datamapName}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"put","path":"/extra/v1/definition/datamap/{datamapName}","ref":"/paths/~1extra~1v1~1definition~1datamap~1{datamapName}/put","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/PUT/extra/v1/definition/datamap/{datamapName}"},{"type":"openapi-operation","title":"Delete datamap definition","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-definition~1DELETE~1extra~1v1~1definition~1datamap~1{datamapName}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"delete","path":"/extra/v1/definition/datamap/{datamapName}","ref":"/paths/~1extra~1v1~1definition~1datamap~1{datamapName}/delete","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/DELETE/extra/v1/definition/datamap/{datamapName}"},{"type":"openapi-operation","title":"Check datamap definition exists","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-definition~1HEAD~1extra~1v1~1definition~1datamap~1{datamapName}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"head","path":"/extra/v1/definition/datamap/{datamapName}","ref":"/paths/~1extra~1v1~1definition~1datamap~1{datamapName}/head","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/HEAD/extra/v1/definition/datamap/{datamapName}"},{"type":"openapi-operation","title":"Get datamap JSON schema","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-definition~1GET~1extra~1v1~1definition~1datamap~1{datamapName}~1schema","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/definition/datamap/{datamapName}/schema","ref":"/paths/~1extra~1v1~1definition~1datamap~1{datamapName}~1schema/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap/{datamapName}/schema"},{"type":"openapi-tag","title":"Datamap Definition","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-definition","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","tag":{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition","title":"Datamap Definition","name":"Datamap Definition","description":"Management of datamap definitions (XML). Defines what data is available\nand how it can be mapped/queried for Cadasto-specific integrations.\n","children":[{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap","title":"List datamap definitions","path":"/extra/v1/definition/datamap","method":"get","ref":"#/paths/~1extra~1v1~1definition~1datamap/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap/{datamapName}","title":"Get datamap definition","path":"/extra/v1/definition/datamap/{datamapName}","method":"get","ref":"#/paths/~1extra~1v1~1definition~1datamap~1{datamapName}/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap/{datamapName}/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/PUT/extra/v1/definition/datamap/{datamapName}","title":"Create or update datamap definition","path":"/extra/v1/definition/datamap/{datamapName}","method":"put","ref":"#/paths/~1extra~1v1~1definition~1datamap~1{datamapName}/put","type":"operation","isDeprecated":false},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/DELETE/extra/v1/definition/datamap/{datamapName}","title":"Delete datamap definition","path":"/extra/v1/definition/datamap/{datamapName}","method":"delete","ref":"#/paths/~1extra~1v1~1definition~1datamap~1{datamapName}/delete","type":"operation","isDeprecated":false},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/HEAD/extra/v1/definition/datamap/{datamapName}","title":"Check datamap definition exists","path":"/extra/v1/definition/datamap/{datamapName}","method":"head","ref":"#/paths/~1extra~1v1~1definition~1datamap~1{datamapName}/head","type":"operation","isDeprecated":false},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap/{datamapName}/schema","title":"Get datamap JSON schema","path":"/extra/v1/definition/datamap/{datamapName}/schema","method":"get","ref":"#/paths/~1extra~1v1~1definition~1datamap~1{datamapName}~1schema/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap/{datamapName}/schema/example/default","title":"default","name":"default"}]}],"isGroup":false,"isWebhooks":false,"type":"tag","xKeys":{"x-scalar-order":["omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap/{datamapName}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/PUT/extra/v1/definition/datamap/{datamapName}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/DELETE/extra/v1/definition/datamap/{datamapName}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/HEAD/extra/v1/definition/datamap/{datamapName}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition/GET/extra/v1/definition/datamap/{datamapName}/schema"]}},"navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-definition"},{"type":"openapi-operation","title":"Ad-hoc datamap query (XML body)","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-query~1POST~1extra~1v1~1datamap","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"post","path":"/extra/v1/datamap","ref":"/paths/~1extra~1v1~1datamap/post","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/POST/extra/v1/datamap"},{"type":"openapi-operation","title":"Query datamap data (list)","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-query~1GET~1extra~1v1~1datamap~1{datamapName}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/datamap/{datamapName}","ref":"/paths/~1extra~1v1~1datamap~1{datamapName}/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/GET/extra/v1/datamap/{datamapName}"},{"type":"openapi-operation","title":"Create datamap data","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-query~1POST~1extra~1v1~1datamap~1{datamapName}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"post","path":"/extra/v1/datamap/{datamapName}","ref":"/paths/~1extra~1v1~1datamap~1{datamapName}/post","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/POST/extra/v1/datamap/{datamapName}"},{"type":"openapi-operation","title":"Get datamap data (by UID)","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-query~1GET~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/datamap/{datamapName}/{uidBasedId}","ref":"/paths/~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/GET/extra/v1/datamap/{datamapName}/{uidBasedId}"},{"type":"openapi-operation","title":"Update datamap data (by UID)","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-query~1PUT~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"put","path":"/extra/v1/datamap/{datamapName}/{uidBasedId}","ref":"/paths/~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}/put","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/PUT/extra/v1/datamap/{datamapName}/{uidBasedId}"},{"type":"openapi-operation","title":"Delete datamap data (by UID)","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-query~1DELETE~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"delete","path":"/extra/v1/datamap/{datamapName}/{uidBasedId}","ref":"/paths/~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}/delete","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/DELETE/extra/v1/datamap/{datamapName}/{uidBasedId}"},{"type":"openapi-operation","title":"Check datamap data exists (by UID)","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-query~1HEAD~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"head","path":"/extra/v1/datamap/{datamapName}/{uidBasedId}","ref":"/paths/~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}/head","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/HEAD/extra/v1/datamap/{datamapName}/{uidBasedId}"},{"type":"openapi-tag","title":"Datamap Query","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1datamap-query","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","tag":{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query","title":"Datamap Query","name":"Datamap Query","description":"Run datamap queries and manage datamap data.\nSupports ad-hoc XML queries and CRUD via JSON for Cadasto.\n","children":[{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/POST/extra/v1/datamap","title":"Ad-hoc datamap query (XML body)","path":"/extra/v1/datamap","method":"post","ref":"#/paths/~1extra~1v1~1datamap/post","type":"operation","isDeprecated":false},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/GET/extra/v1/datamap/{datamapName}","title":"Query datamap data (list)","path":"/extra/v1/datamap/{datamapName}","method":"get","ref":"#/paths/~1extra~1v1~1datamap~1{datamapName}/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/GET/extra/v1/datamap/{datamapName}/example/rapportage_list","title":"rapportage_list","name":"rapportage_list"},{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/GET/extra/v1/datamap/{datamapName}/example/agent_overview","title":"agent_overview","name":"agent_overview"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/POST/extra/v1/datamap/{datamapName}","title":"Create datamap data","path":"/extra/v1/datamap/{datamapName}","method":"post","ref":"#/paths/~1extra~1v1~1datamap~1{datamapName}/post","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/POST/extra/v1/datamap/{datamapName}/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/GET/extra/v1/datamap/{datamapName}/{uidBasedId}","title":"Get datamap data (by UID)","path":"/extra/v1/datamap/{datamapName}/{uidBasedId}","method":"get","ref":"#/paths/~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/GET/extra/v1/datamap/{datamapName}/{uidBasedId}/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/PUT/extra/v1/datamap/{datamapName}/{uidBasedId}","title":"Update datamap data (by UID)","path":"/extra/v1/datamap/{datamapName}/{uidBasedId}","method":"put","ref":"#/paths/~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}/put","type":"operation","isDeprecated":false},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/DELETE/extra/v1/datamap/{datamapName}/{uidBasedId}","title":"Delete datamap data (by UID)","path":"/extra/v1/datamap/{datamapName}/{uidBasedId}","method":"delete","ref":"#/paths/~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}/delete","type":"operation","isDeprecated":false},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/HEAD/extra/v1/datamap/{datamapName}/{uidBasedId}","title":"Check datamap data exists (by UID)","path":"/extra/v1/datamap/{datamapName}/{uidBasedId}","method":"head","ref":"#/paths/~1extra~1v1~1datamap~1{datamapName}~1{uidBasedId}/head","type":"operation","isDeprecated":false}],"isGroup":false,"isWebhooks":false,"type":"tag","xKeys":{"x-scalar-order":["omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/POST/extra/v1/datamap","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/GET/extra/v1/datamap/{datamapName}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/POST/extra/v1/datamap/{datamapName}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/GET/extra/v1/datamap/{datamapName}/{uidBasedId}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/PUT/extra/v1/datamap/{datamapName}/{uidBasedId}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/DELETE/extra/v1/datamap/{datamapName}/{uidBasedId}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query/HEAD/extra/v1/datamap/{datamapName}/{uidBasedId}"]}},"navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/datamap-query"},{"type":"openapi-operation","title":"Get FHIR ValueSet URL","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1terminology~1GET~1extra~1v1~1terminology~1code24","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/terminology/code24","ref":"/paths/~1extra~1v1~1terminology~1code24/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/terminology/GET/extra/v1/terminology/code24"},{"type":"openapi-tag","title":"Terminology","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1terminology","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","tag":{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/terminology","title":"Terminology","name":"Terminology","description":"Terminology helpers, such as retrieving FHIR ValueSet URLs.\n","children":[{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/terminology/GET/extra/v1/terminology/code24","title":"Get FHIR ValueSet URL","path":"/extra/v1/terminology/code24","method":"get","ref":"#/paths/~1extra~1v1~1terminology~1code24/get","type":"operation","isDeprecated":false}],"isGroup":false,"isWebhooks":false,"type":"tag","xKeys":{"x-scalar-order":["omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/terminology/GET/extra/v1/terminology/code24"]}},"navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/terminology"},{"type":"openapi-operation","title":"List episodes","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1episode~1GET~1extra~1v1~1ehr~1{ehrUid}~1episode","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/ehr/{ehrUid}/episode","ref":"/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/GET/extra/v1/ehr/{ehrUid}/episode"},{"type":"openapi-operation","title":"Create episode","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1episode~1POST~1extra~1v1~1ehr~1{ehrUid}~1episode","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"post","path":"/extra/v1/ehr/{ehrUid}/episode","ref":"/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode/post","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/POST/extra/v1/ehr/{ehrUid}/episode"},{"type":"openapi-operation","title":"Get episode","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1episode~1GET~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"get","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}","ref":"/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}/get","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/GET/extra/v1/ehr/{ehrUid}/episode/{uid}"},{"type":"openapi-operation","title":"Update episode","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1episode~1PUT~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"put","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}","ref":"/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}/put","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}"},{"type":"openapi-operation","title":"Delete episode","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1episode~1DELETE~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"delete","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}","ref":"/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}/delete","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/DELETE/extra/v1/ehr/{ehrUid}/episode/{uid}"},{"type":"openapi-operation","title":"Activate episode","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1episode~1PUT~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}~1activate","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"put","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}/activate","ref":"/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}~1activate/put","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}/activate"},{"type":"openapi-operation","title":"Deactivate episode","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1episode~1PUT~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}~1deactivate","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"put","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}/deactivate","ref":"/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}~1deactivate/put","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}/deactivate"},{"type":"openapi-tag","title":"Episode","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1episode","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","tag":{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode","title":"Episode","name":"Episode","description":"CRUD on episodes within an EHR and status changes (activate/deactivate).\nEpisodes group medical data around a clinical problem or episode of care\nacross time and encounters.\n","children":[{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/GET/extra/v1/ehr/{ehrUid}/episode","title":"List episodes","path":"/extra/v1/ehr/{ehrUid}/episode","method":"get","ref":"#/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/GET/extra/v1/ehr/{ehrUid}/episode/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/POST/extra/v1/ehr/{ehrUid}/episode","title":"Create episode","path":"/extra/v1/ehr/{ehrUid}/episode","method":"post","ref":"#/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode/post","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/POST/extra/v1/ehr/{ehrUid}/episode/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/GET/extra/v1/ehr/{ehrUid}/episode/{uid}","title":"Get episode","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}","method":"get","ref":"#/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}/get","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/GET/extra/v1/ehr/{ehrUid}/episode/{uid}/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}","title":"Update episode","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}","method":"put","ref":"#/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}/put","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/DELETE/extra/v1/ehr/{ehrUid}/episode/{uid}","title":"Delete episode","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}","method":"delete","ref":"#/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}/delete","type":"operation","isDeprecated":false},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}/activate","title":"Activate episode","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}/activate","method":"put","ref":"#/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}~1activate/put","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}/activate/example/default","title":"default","name":"default"}]},{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}/deactivate","title":"Deactivate episode","path":"/extra/v1/ehr/{ehrUid}/episode/{uid}/deactivate","method":"put","ref":"#/paths/~1extra~1v1~1ehr~1{ehrUid}~1episode~1{uid}~1deactivate/put","type":"operation","isDeprecated":false,"children":[{"type":"example","id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}/deactivate/example/default","title":"default","name":"default"}]}],"isGroup":false,"isWebhooks":false,"type":"tag","xKeys":{"x-scalar-order":["omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/GET/extra/v1/ehr/{ehrUid}/episode","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/POST/extra/v1/ehr/{ehrUid}/episode","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/GET/extra/v1/ehr/{ehrUid}/episode/{uid}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/DELETE/extra/v1/ehr/{ehrUid}/episode/{uid}","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}/activate","omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode/PUT/extra/v1/ehr/{ehrUid}/episode/{uid}/deactivate"]}},"navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/episode"},{"type":"openapi-operation","title":"Destroy episode (admin)","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1admin~1PUT~1extra~1v1~1admin~1ehr~1{ehrUid}~1episode~1{uid}~1destroy","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","method":"put","path":"/extra/v1/admin/ehr/{ehrUid}/episode/{uid}/destroy","ref":"/paths/~1extra~1v1~1admin~1ehr~1{ehrUid}~1episode~1{uid}~1destroy/put","navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/admin/PUT/extra/v1/admin/ehr/{ehrUid}/episode/{uid}/destroy"},{"type":"openapi-tag","title":"Admin","uid":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko~1tag~1admin","breadcrumbs":[{"type":"root-group","path":"/extra-api","uid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","title":"Extra API"}],"version":"default","documentUid":"omuxHarOXHwrlXbcEDVbJOfSjkJZBeC_GQvi4VKO","tag":{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/admin","title":"Admin","name":"Admin","description":"Admin-only actions, such as permanently deleting (destroy) episodes.\n","children":[{"id":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/admin/PUT/extra/v1/admin/ehr/{ehrUid}/episode/{uid}/destroy","title":"Destroy episode (admin)","path":"/extra/v1/admin/ehr/{ehrUid}/episode/{uid}/destroy","method":"put","ref":"#/paths/~1extra~1v1~1admin~1ehr~1{ehrUid}~1episode~1{uid}~1destroy/put","type":"operation","isDeprecated":false}],"isGroup":false,"isWebhooks":false,"type":"tag","xKeys":{"x-scalar-order":["omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/admin/PUT/extra/v1/admin/ehr/{ehrUid}/episode/{uid}/destroy"]}},"navigationId":"omuxharoxhwrlxbcedvbjofsjkjzbec_gqvi4vko/tag/admin"}]},"content":{"openapi":"3.1.1","info":{"title":"Cadasto Additional API","version":"1.0.0","description":"Additional API on top of the openEHR REST API, specific to Cadasto.\nThe endpoints in this specification are Cadasto-specific and are intended\nto make it easier for app builders to interact with openEHR (e.g. datamaps).\nThis API only works within Cadasto.\n"},"servers":[{"url":"https://api.customer.cadasto.io"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Health","description":"Health checks for monitoring and orchestration.\nUsed for startup, liveness, and readiness probes.\n"},{"name":"User","description":"User information and caseload for the authenticated user.\n"},{"name":"Datamap Definition","description":"Management of datamap definitions (XML). Defines what data is available\nand how it can be mapped/queried for Cadasto-specific integrations.\n"},{"name":"Datamap Query","description":"Run datamap queries and manage datamap data.\nSupports ad-hoc XML queries and CRUD via JSON for Cadasto.\n"},{"name":"Terminology","description":"Terminology helpers, such as retrieving FHIR ValueSet URLs.\n"},{"name":"Episode","description":"CRUD on episodes within an EHR and status changes (activate/deactivate).\nEpisodes group medical data around a clinical problem or episode of care\nacross time and encounters.\n"},{"name":"Admin","description":"Admin-only actions, such as permanently deleting (destroy) episodes.\n"}],"paths":{"/extra/health/startup":{"get":{"tags":["Health"],"summary":"Startup probe","description":"Verifies the application has started correctly.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"status":"ok","output":"library: ok"}}}}}}}}},"/extra/health/live":{"get":{"tags":["Health"],"summary":"Liveness probe","description":"Verifies the application is still alive.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"status":"ok","output":"db: ping ok"}}}}}}}}},"/extra/health/ready":{"get":{"tags":["Health"],"summary":"Readiness probe","description":"Verifies the application is ready to receive traffic.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"status":"ok","output":"stats: 117/47/683 app_env: production"}}}}}}}}},"/extra/v1/user/info":{"get":{"tags":["User"],"summary":"Get user info","description":"Returns basic information about the authenticated user.","parameters":[{"$ref":"#/components/parameters/role"},{"$ref":"#/components/parameters/identifier"},{"$ref":"#/components/parameters/identifierType"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"examples":{"patient":{"summary":"Patient lookup","value":{"id":"","fhir_patient_id":"","ehr_id":"","profile":{"name":"Arie Achterweg","nickname":"Arie","email":"arie@code24.nl","birth_date":"19840513","patientId":"9999999001"},"role":{"id":"","all":[{"uid":"","name":"Patient"}]},"success":true}},"practitioner":{"summary":"Practitioner lookup","value":{"id":"","fhir_patient_id":"","ehr_id":"","profile":{"name":"Denillo Valkenier","nickname":"Denillo","email":null,"birth_date":"19710530","patientId":null},"role":{"id":"","all":[{"uid":"","name":"Zorgverlener"}]},"success":true}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"message":"Bad request.","errors":[" => The 'role' parameter is required."," => The 'identifier' parameter is required."," => The 'identifierType' parameter is required."],"exception":[{"type":"Code24\\\\Slim\\\\Http\\\\Exception\\\\HttpBadRequestException","code":400,"message":"Bad request.","file":"/app/src/Controller/UserController.php","line":82}]}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"message":"User not found.","exception":[{"type":"Slim\\\\Exception\\\\HttpNotFoundException","code":404,"message":"User not found.","file":"/app/src/Controller/UserController.php","line":100}]}}}}}}}}},"/extra/v1/user/caseload":{"get":{"tags":["User"],"summary":"Get user caseload","description":"Returns the caseload of the authenticated user.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"totalCount":0,"patients":[]}}}}}}}}},"/extra/v1/definition/datamap":{"get":{"tags":["Datamap Definition"],"summary":"List datamap definitions","description":"Returns a list of available datamap definitions.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"default":{"value":["admission_cancelled","admission_details","Rapportage","T0004Dagboek","Verpleegkundige_Anamnese","vital_signs"]}}}}}}}},"/extra/v1/definition/datamap/{datamapName}":{"parameters":[{"$ref":"#/components/parameters/datamapName"}],"get":{"tags":["Datamap Definition"],"summary":"Get datamap definition","description":"Retrieves the datamap definition (XML) for the given name.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"value":"\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n","category":"API","name":"proactieve_zorgplanning","type":"datamap","layer":1,"owner_uid":"","timestamp":"2026-02-10 08:40:51","uid":"","comment":""}}}}}},"404":{"description":"Not found"}}},"put":{"tags":["Datamap Definition"],"summary":"Create or update datamap definition","description":"Creates or updates a datamap definition (XML body).","requestBody":{"required":true,"content":{"application/xml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Not found"}}},"delete":{"tags":["Datamap Definition"],"summary":"Delete datamap definition","description":"Deletes the datamap definition with the given name.","responses":{"200":{"description":"Deleted"},"400":{"description":"Bad request"},"404":{"description":"Not found"}}},"head":{"tags":["Datamap Definition"],"summary":"Check datamap definition exists","description":"Checks whether a datamap definition exists.","responses":{"200":{"description":"Exists"},"404":{"description":"Not found"}}}},"/extra/v1/definition/datamap/{datamapName}/schema":{"get":{"tags":["Datamap Definition"],"summary":"Get datamap JSON schema","description":"Retrieves the JSON Schema that belongs to the datamap.","parameters":[{"$ref":"#/components/parameters/datamapName"}],"responses":{"200":{"description":"OK","content":{"application/schema+json":{"schema":{"type":"object"},"examples":{"default":{"value":{"id":"Rapportage::datamap::daf4749d-6593-3584-a9e5-778dfe642e67","title":"T0016 Rapportage.v1","type":"object","properties":{"Datum en Tijd":{"type":"string","rmType":"DV_DATE_TIME","dependencies":[],"required":true,"format":"date_time","href":"/context/start_time","title":"Context start time"},"Zorgverlener":{"type":"string","rmType":"PARTY_IDENTIFIED/name","dependencies":[],"required":false,"href":"/content/provider/name","title":"Rapportage","description":"Rapportage Composition"},"Zorgverlener_uid":{"type":"unknown","rmType":"EVALUATION//provider/external_ref/id/value","dependencies":[],"required":true,"_exception":"Class [OBJECT_ID] not instantiable.","href":"/content/provider/external_ref/id/value","title":"Rapportage","description":"Rapportage Composition"},"Type Contact":{"type":"object","rmType":"DV_CODED_TEXT","dependencies":[],"required":false,"oneOf":[{"code":"at0021","value":"Face to face"},{"code":"at0022","value":"Ear to ear"},{"code":"at0023","value":"Bit to Bit"},{"code":"at0024","value":"Geen"}],"minItems":0,"maxItems":1,"href":"/context/other_context[at0001]/items[at0020]/value","title":"Type contact","description":"Type contact"},"Rapportage":{"type":"string","rmType":"DV_TEXT/value","dependencies":[],"required":true,"href":"/content/data[at0001]/items[at0002]/value/value","title":"Unknown"}},"additionalProperties":false}}}}}},"404":{"description":"Not found"}}}},"/extra/v1/datamap":{"post":{"tags":["Datamap Query"],"summary":"Ad-hoc datamap query (XML body)","description":"Executes an ad-hoc query based on an XML query body.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/ehrUid"}],"requestBody":{"required":true,"content":{"application/xml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Not found"}}}},"/extra/v1/datamap/{datamapName}":{"parameters":[{"$ref":"#/components/parameters/datamapName"}],"get":{"tags":["Datamap Query"],"summary":"Query datamap data (list)","description":"Retrieves a list of data via the datamap.\nUse `ehrUid` as a query parameter to scope results to a specific EHR.\n\nExample: `/extra/v1/datamap/Rapportage?ehrUid=9f7f3e7a-1111-4b2e-8d7c-222222222222`\n","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/orderBy"},{"$ref":"#/components/parameters/ehrUid"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"rapportage_list":{"summary":"Rapportage list (sample)","value":{"data":[{"vuid":"","episode_uid":"","episode_id":"E0100016","episode_status":"active","episode_start":"2025-12-04 15:46:53","episode_end":"9999-12-31 23:59:59","uid":"","version_object_id":325,"version_tree_id":4,"artefact_id":240,"trunk_lifecycle_state":"complete","Datum en Tijd":"2025-12-10T12:02:00+01:00","Zorgverlener":"Code24 Medewerker","Zorgverlener_uid":"","Type Contact":{"code":"at0021","value":"Face to face"},"Rapportage":"Example report text..."},{"vuid":"","episode_uid":"","episode_id":"E0100016","episode_status":"active","episode_start":"2025-12-04 15:46:53","episode_end":"9999-12-31 23:59:59","uid":"","version_object_id":326,"version_tree_id":2,"artefact_id":240,"trunk_lifecycle_state":"complete","Datum en Tijd":"2025-12-10T12:02:00+01:00","Zorgverlener":"Code24 Medewerker","Zorgverlener_uid":"","Type Contact":{"code":"at0022","value":"Ear to ear"},"Rapportage":"Example report text..."}],"totalCount":5}},"agent_overview":{"summary":"Agent overview (sample)","value":{"data":[{"uid":"","vuid":"","full_name":"HL7","version_object_id":19,"version_tree_id":1,"id":"hl7agent"},{"uid":"","vuid":"","full_name":"FHIR","version_object_id":20,"version_tree_id":1,"id":"fhir"},{"uid":"","vuid":"","full_name":"Systeem","version_object_id":21,"version_tree_id":1,"id":"system"},{"uid":"","vuid":"","full_name":"Client360","version_object_id":22,"version_tree_id":1,"id":"client360"},{"uid":"","vuid":"","full_name":"Automated tester","version_object_id":23,"version_tree_id":1,"id":"automated_tester"},{"uid":"","vuid":"","full_name":"Cadasto client cadasto-fb2eaa45-052f-4292-a501-9f3b6bdf1d89","version_object_id":71,"version_tree_id":1,"id":"cadasto-fb2eaa45-052f-4292-a501-9f3b6bdf1d89"},{"uid":"","vuid":"","full_name":"Cadasto client cadasto-805bf4cb-2166-4e8a-b31b-cfc5c2c45bdf","version_object_id":72,"version_tree_id":1,"id":"cadasto-805bf4cb-2166-4e8a-b31b-cfc5c2c45bdf"}],"totalCount":7}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"}}},"post":{"tags":["Datamap Query"],"summary":"Create datamap data","description":"Creates new data according to the datamap (JSON body).","parameters":[{"$ref":"#/components/parameters/ehrUid"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"uid":"","zorgpad_omschrijving":"test 2","zorgpad_code":"test 3"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"data":{"vuid":"","uid":"","version_object_id":329,"version_tree_id":2,"artefact_id":135,"trunk_lifecycle_state":"complete","beslisboom_context":[],"zorgpad_omschrijving":"test 2","zorgpad_code":"test 3","zorgmodules":[]}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"}}}},"/extra/v1/datamap/{datamapName}/{uidBasedId}":{"parameters":[{"$ref":"#/components/parameters/datamapName"},{"$ref":"#/components/parameters/uidBasedId"}],"get":{"tags":["Datamap Query"],"summary":"Get datamap data (by UID)","description":"Retrieves a single data item by UID.","parameters":[{"$ref":"#/components/parameters/ehrUid"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"data":{"vuid":"","uid":"","version_object_id":329,"version_tree_id":2,"artefact_id":135,"trunk_lifecycle_state":"complete","beslisboom_context":[],"zorgpad_omschrijving":"test 2","zorgpad_code":"test 3","zorgmodules":[]}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"}}},"put":{"tags":["Datamap Query"],"summary":"Update datamap data (by UID)","description":"Updates a single data item by UID (JSON body).","parameters":[{"$ref":"#/components/parameters/ehrUid"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Not found"}}},"delete":{"tags":["Datamap Query"],"summary":"Delete datamap data (by UID)","description":"Deletes a single data item by UID.","parameters":[{"$ref":"#/components/parameters/ehrUid"}],"responses":{"200":{"description":"Deleted"},"400":{"description":"Bad request"},"404":{"description":"Not found"}}},"head":{"tags":["Datamap Query"],"summary":"Check datamap data exists (by UID)","description":"Checks whether a single data item with the given UID exists.","parameters":[{"$ref":"#/components/parameters/ehrUid"}],"responses":{"200":{"description":"Exists"},"404":{"description":"Not found"}}}},"/extra/v1/terminology/code24":{"get":{"tags":["Terminology"],"summary":"Get FHIR ValueSet URL","description":"Returns the FHIR ValueSet URL for the given subset.\nResponds with a 302 redirect and a `Location` header pointing to the FHIR server.\n","parameters":[{"$ref":"#/components/parameters/subset"}],"responses":{"200":{"description":"OK"},"302":{"description":"Found (redirect to FHIR ValueSet)","headers":{"Location":{"description":"URL of the FHIR ValueSet on the FHIR server.","schema":{"type":"string"}}}},"400":{"description":"Bad request"},"501":{"description":"Not implemented"}}}},"/extra/v1/ehr/{ehrUid}/episode":{"parameters":[{"$ref":"#/components/parameters/ehrUidPath"}],"get":{"tags":["Episode"],"summary":"List episodes","description":"Returns episodes that group medical data for the given EHR.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array"},"examples":{"default":{"value":[{"uid":"","episodeId":"E0100016","active":true,"startsAt":"2025-12-04T15:46:53+01:00"},{"uid":"","episodeId":"E0126870","active":true,"startsAt":"2025-12-04T15:46:53+01:00"}]}}}}}}},"post":{"tags":["Episode"],"summary":"Create episode","description":"Creates a new episode to group related medical data.\n`urgency` allowed values: `at0012` (Crisis), `at0013` (Spoed), `at0014` (Regulier).\n`careCircuit` is a coded value from terminology subset `care_circuit`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"name":"Episode name","active":true,"urgency":"at0012","careCircuit":"5","startsAt":"2025-12-04T15:46:53+01:00","endsAt":"2025-12-10T11:30:00+01:00"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"uid":"","episodeId":"E0126870","active":true,"startsAt":"2025-12-04T15:46:53+01:00"}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"}}}},"/extra/v1/ehr/{ehrUid}/episode/{uid}":{"parameters":[{"$ref":"#/components/parameters/ehrUidPath"},{"$ref":"#/components/parameters/uid"}],"get":{"tags":["Episode"],"summary":"Get episode","description":"Retrieves a single episode, which groups related medical data.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"uid":"","episodeId":"E0100016","active":true,"startsAt":"2025-12-04T15:46:53+01:00"}}}}}},"404":{"description":"Not found"}}},"put":{"tags":["Episode"],"summary":"Update episode","description":"Updates an episode that groups related medical data.\n`urgency` allowed values: `at0012` (Crisis), `at0013` (Spoed), `at0014` (Regulier).\n`careCircuit` is a coded value from terminology subset `care_circuit`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{"name":"Updated episode name","active":false,"urgency":"at0012","careCircuit":"5","startsAt":"2025-12-04T15:46:53+01:00","endsAt":"2025-12-12T12:00:00+01:00"}}}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Not found"}}},"delete":{"tags":["Episode"],"summary":"Delete episode","description":"Deletes an episode by UID.","responses":{"200":{"description":"Deleted"},"404":{"description":"Not found"}}}},"/extra/v1/ehr/{ehrUid}/episode/{uid}/activate":{"parameters":[{"$ref":"#/components/parameters/ehrUidPath"},{"$ref":"#/components/parameters/uid"}],"put":{"tags":["Episode"],"summary":"Activate episode","description":"Sets the episode status to active.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{}}}}}},"404":{"description":"Not found"}}}},"/extra/v1/ehr/{ehrUid}/episode/{uid}/deactivate":{"parameters":[{"$ref":"#/components/parameters/ehrUidPath"},{"$ref":"#/components/parameters/uid"}],"put":{"tags":["Episode"],"summary":"Deactivate episode","description":"Sets the episode status to inactive.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{}}}}}},"404":{"description":"Not found"}}}},"/extra/v1/admin/ehr/{ehrUid}/episode/{uid}/destroy":{"parameters":[{"$ref":"#/components/parameters/ehrUidPath"},{"$ref":"#/components/parameters/uid"}],"put":{"tags":["Admin"],"summary":"Destroy episode (admin)","description":"Permanently deletes an episode (admin-only).","responses":{"200":{"description":"OK"},"404":{"description":"Not found"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"subset":{"name":"subset","in":"query","required":true,"schema":{"type":"string"},"description":"Subset identifier to resolve to a FHIR ValueSet."},"role":{"name":"role","in":"query","required":true,"schema":{"type":"string","enum":["patient","practitioner"]},"description":"User role to resolve (patient or practitioner)."},"identifier":{"name":"identifier","in":"query","required":true,"schema":{"type":"string"},"description":"Identifier value to resolve to a user."},"identifierType":{"name":"identifierType","in":"query","required":true,"schema":{"type":"string"},"description":"Identifier type. Use `partyUid` when providing a UUID."},"datamapName":{"name":"datamapName","in":"path","required":true,"schema":{"type":"string"}},"uidBasedId":{"name":"uidBasedId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},"uid":{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},"ehrUidPath":{"name":"ehrUid","in":"path","required":true,"schema":{"type":"string"}},"ehrUid":{"name":"ehrUid","in":"query","required":false,"schema":{"type":"string"}},"limit":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1}},"offset":{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":1}},"orderBy":{"name":"order_by","in":"query","required":false,"schema":{"type":"string"}}}},"x-ext-urls":{}}}}

Cadasto Additional API

AuthenticationRequired