@clinia/context-engine-js 0.7.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,93 @@
 # @clinia/context-engine-js
 
+## 0.10.0
+
+### Minor Changes
+
+- 7e113a5: - Medication `extracted_fact` nodes carry `identity`: the record's own ingredients, route, and dose forms for `other`.
+  - They also carry `identityEvidence`: how each part was decided.
+  - For ingredients and dose form: every candidate the vocabulary found, or why it found none.
+  - For the route: every step's decision, as `routeDecision.evidence` gave it.
+  - `routeDecision` is gone. Read the route from `identity.route` and its decisions from `identityEvidence.route`.
+
+## 0.10.0-rc.1
+
+No changes in this release.
+
+## 0.10.0-rc.0
+
+### Minor Changes
+
+- 7e113a5: - Medication `extracted_fact` nodes carry `identity`: the record's own ingredients, route, and dose forms for `other`.
+  - They also carry `identityEvidence`: how each part was decided.
+  - For ingredients and dose form: every candidate the vocabulary found, or why it found none.
+  - For the route: every step's decision, as `routeDecision.evidence` gave it.
+  - `routeDecision` is gone. Read the route from `identity.route` and its decisions from `identityEvidence.route`.
+
+## 0.9.0
+
+### Minor Changes
+
+- 15c24e0: Concept-identity evidence in resolution decisions now reports its layer as `deterministic-code`, like the other code-based evidence, instead of its own `concept-identity` layer. No stored concept-identity evidence exists in any deployment, so no data migration is needed.
+- 565b767: Facts and events now carry every date their source states, each under its own name, such as `occurredAt` or `expiresAt`.
+  - In the graph API, read `authoredAt` instead of `date`, `effectivePeriod.start` instead of a condition's `onsetDate`, and `occurredAt` instead of an immunization's `occurrenceDate`.
+  - Immunizations, demographics and family history no longer carry an `effectivePeriod`.
+
+- daf1ece: - Medication `extracted_fact` nodes carry `routeDecision`: the route the record was given and every decision behind it.
+  - Each decision says what it came from: the product's dose form, a phrase in the record, or a model.
+  - A model's decision also gives the model, how sure it was, and what it read.
+  - Only medications whose route was decided at ingestion carry it.
+- 7216e9a: Depending on how it was ingested, a medication fact in the patient graph can now be returned as what identifies it: its RxNorm ingredients and its route, in a new `identity` field. Its `display` then reads like `metformin hydrochloride, oral`. The fact keeps only its codes, effective period and status, and `fieldVerdicts` holds only `status`. Its dose, frequency, route text and other dates are on the extracted facts in its `members`. Medications stored before this release keep coming back in full until new records about them are ingested.
+
+  Two medications become one entry only when they have the same ingredients and the same route, so oral and topical diclofenac stay separate. Resolution evidence has three new kinds, `medication-identity-match`, `medication-identity-mismatch` and `medication-identity-incomplete`, each showing both medications' ingredients and route as a `MedicationIdentity`.
+
+### Patch Changes
+
+- 8253136: Release candidates of the TypeScript client are no longer published to npm. Only stable releases are. The `rc` tag on npm will not get new versions. If you install `@clinia/context-engine-js@rc`, switch to the latest stable version.
+- d44392f: Each child in a VFS browse result can carry a `display` label, a readable name shown beside its `name`. The `name` stays what you put in the path.
+
+## 0.9.0-rc.3
+
+No changes in this release.
+
+## 0.9.0-rc.2
+
+### Minor Changes
+
+- daf1ece: - Medication `extracted_fact` nodes carry `routeDecision`: the route the record was given and every decision behind it.
+  - Each decision says what it came from: the product's dose form, a phrase in the record, or a model.
+  - A model's decision also gives the model, how sure it was, and what it read.
+  - Only medications whose route was decided at ingestion carry it.
+
+### Patch Changes
+
+- d44392f: Each child in a VFS browse result can carry a `display` label, a readable name shown beside its `name`. The `name` stays what you put in the path.
+
+## 0.9.0-rc.1
+
+### Minor Changes
+
+- 7216e9a: Depending on how it was ingested, a medication fact in the patient graph can now be returned as what identifies it: its RxNorm ingredients and its route, in a new `identity` field. Its `display` then reads like `metformin hydrochloride, oral`. The fact keeps only its codes, effective period and status, and `fieldVerdicts` holds only `status`. Its dose, frequency, route text and other dates are on the extracted facts in its `members`. Medications stored before this release keep coming back in full until new records about them are ingested.
+
+  Two medications become one entry only when they have the same ingredients and the same route, so oral and topical diclofenac stay separate. Resolution evidence has three new kinds, `medication-identity-match`, `medication-identity-mismatch` and `medication-identity-incomplete`, each showing both medications' ingredients and route as a `MedicationIdentity`.
+
+## 0.9.0-rc.0
+
+### Minor Changes
+
+- 15c24e0: Concept-identity evidence in resolution decisions now reports its layer as `deterministic-code`, like the other code-based evidence, instead of its own `concept-identity` layer. No stored concept-identity evidence exists in any deployment, so no data migration is needed.
+- 565b767: Facts and events now carry every date their source states, each under its own name, such as `occurredAt` or `expiresAt`.
+  - In the graph API, read `authoredAt` instead of `date`, `effectivePeriod.start` instead of a condition's `onsetDate`, and `occurredAt` instead of an immunization's `occurrenceDate`.
+  - Immunizations, demographics and family history no longer carry an `effectivePeriod`.
+
+### Patch Changes
+
+- 8253136: Release candidates of the TypeScript client are no longer published to npm. Only stable releases are. The `rc` tag on npm will not get new versions. If you install `@clinia/context-engine-js@rc`, switch to the latest stable version.
+
+## 0.8.0
+
+No changes in this release.
+
 ## 0.7.0
 
 No changes in this release.

package/README.md

@@ -1,4 +1,4 @@
-# @clinia/context-engine-js
+# Context Engine TypeScript Client
 
 TypeScript client for the Clinia Context Engine API. A thin, typed wrapper over
 [`openapi-fetch`](https://openapi-ts.dev/openapi-fetch/) — request/response
@@ -13,14 +13,8 @@ npm install @clinia/context-engine-js
 ```
 
 Published on [npm](https://www.npmjs.com/package/@clinia/context-engine-js). No
-registry configuration or authentication is needed.
-
-While the engine is in release-candidate phase, the newest build is under the
-`rc` dist-tag:
-
-```sh
-npm install @clinia/context-engine-js@rc
-```
+registry configuration or authentication is needed. Only stable releases are
+published here.
 
 **This package is ESM-only** (`"type": "module"`). `require()` of it throws
 `ERR_REQUIRE_ESM`; use `import`, or a dynamic `await import()` from CommonJS.
@@ -73,6 +67,9 @@ await client.patients.getPatient("abc");
 await client.graph.listNodes("abc", "fact", { query: { perPage: 50 } });
 await client.ingest.ingestCdaR2("abc", cdaXml);
 await client.ingest.ingestCdaR2Multipart("abc", { documents: [firstCda, secondCda] });
+await client.ingest.ingestSessions("abc", {
+  sessions: [{ messages: [{ role: "user", content: "Hi" }] }],
+});
 ```
 
 Responses are `{ data, error }` — nothing throws on a non-2xx.
@@ -153,18 +150,20 @@ is implemented as such a middleware internally.
 ## Development
 
 ```sh
-pnpm generate   # regenerate types from ../../context-engine.yaml
+pnpm install
 pnpm build      # bundle (tsup) + emit declarations (tsc)
 pnpm typecheck
+pnpm test
 ```
 
-Tests run from the repo root (Vitest discovers this package's `vitest.config.ts`):
+`src/generated/` and `src/resources/` are generated from the Context Engine OpenAPI spec on each release. Don't edit them by hand.
 
-```sh
-pnpm test                                   # whole workspace
-pnpm vitest run --project context-engine-js # this package only
-```
+The [GitHub repository](https://github.com/clinia/context-engine-js) mirrors each release, so it can't merge pull requests. Report bugs in its [issues](https://github.com/clinia/context-engine-js/issues).
+
+## Changelog
+
+See the [Context Engine changelog](https://docs.clinia.com/changelog).
 
 ## License
 
-[Apache-2.0](LICENSE) © Clinia Health Inc.
+[Apache-2.0](https://github.com/clinia/context-engine-js/blob/main/LICENSE) © Clinia Health Inc.