Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Support Advanced Terminology API

Aperta
  • Qualcosa non va?
#299 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
api, backend-api-design

Direzione di ricerca

Inizia da src/types/cql-code-service.interfaces.ts, in particolare dall’interfaccia TerminologyProvider esistente, quindi confrontala con il TerminologyProvider di Java CQL Engine collegato nell’issue. Chiarisci la progettazione delle operazioni e delle capability di v2, inclusi la compatibilità con v1 e il comportamento degli errori; l’issue è completata solo quando queste questioni aperte sono state risolte e l’API risultante è stata implementata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Currently, the TerminologyProvider (a.k.a. CodeService) API in cql-execution is quite simple:

export interface TerminologyProvider {
  findValueSetsByOid: (oid: string) => ValueSet[] | Promise<ValueSet[]>;
  findValueSet: (oid: string, version?: string) => ValueSet | Promise<ValueSet> | null;
}

This allows for easy implementation of terminology providers because it pushes most of the terminology operations to the CQL engine itself. The terminology provider need only support simple lookups and return the expanded value set(s). This, however, has performance implications since large value sets must be stored in memory and membership lookup is done by iterating the full set of codes. It also doesn't support other terminology-related operations like subsumption and code system membership.

We should introduce a v2 TerminologyProvider API that allows terminology operations to be implemented by the provider. This would allow for the provider to be backed by a terminology service or a database that can do operations more efficiently. It would also allow for implementation of advanced terminology operations that are not supported by the current engine.

The Java CQL Engine provides a fairly simple TerminologyProvider API (here) that currently supports in (VS membership), expand (VS expansion), and lookup (code display lookup). I think we can borrow some from that, but would suggest that we also cover a bit more ground:

// Notional AdvanceTerminologyProvider... VERY subject to change!
export interface AdvancedTerminologyProvider {
  capabilities: () => TerminologyCapabilities;
  inValueSet: (code: Code | Code[], valueSet: ValueSetInfo) => Promise<boolean>;
  expandValueSet: (valueSet: ValueSetInfo) => Promise<ExpandedValueSet>;
  inCodeSystem: (code: Code | Code[], codeSystem: CodeSystemInfo) => Promise<boolean>;
  expandCodeSystem: (codeSystem: CodeSystemInfo) => Promise<ExpandedCodeSystem>;
  subsumes: (subsuming: Code | Concept, subsumed: Code | Concept) => Promise<boolean>
}

The cql-execution framework can check a terminology provide to see if it has a capabilities function, and if so, inspect its capabilities and then call it as appropriate. If it doesn't have a capabilities function, then it's assumed to be a v1 provider. We should continue to support both.

This design is still very subject to change and there are some open questions:

  1. Does it make sense for a terminology provider to advertise its capabilities? Or should the engine just always try (and know that sometimes it won't work).
  2. If a terminology provider can't process one of these requests, should it throw? Or return null?
Lingua principale
JavaScript
Stelle
84
Fork
39
Merge medio
2g 5h
PR unite (30g)
5

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di cqframework/cql-execution

Tutte le issue di cqframework/cql-execution

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.