fhirpath-ts 0.0.0-bootstrap.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work, excluding
+          those notices that do not pertain to any part of the Derivative
+          Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one of
+          the following places: within a NOTICE text file distributed as
+          part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do
+          not modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Vinta Software
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,391 @@
+# fhirpath-ts
+
+A TypeScript-native [FHIRPath](https://hl7.org/fhirpath/) engine for application
+development. It has zero runtime dependencies and includes:
+
+- typed results for literal expressions in plain TypeScript;
+- DTOs that transform FHIR resources into typed application data;
+- static checks through TypeScript, ESLint, a CLI linter/analyzer, and a public analyzer API;
+- official HL7 conformance tests plus tests from other FHIRPath engines;
+- [Medplum](https://www.medplum.com/) compatibility;
+- currently focused in FHIR R4, the most commonly used FHIR version.
+
+Check the [playground demo](demo/README.md) or keep reading!
+
+## Quick start
+
+```ts
+import { r4 } from 'fhirpath-ts/r4'
+
+const patient = {
+  resourceType: 'Patient',
+  active: true,
+  name: [{ family: 'Okoro', given: ['Adaeze', 'Mina'] }],
+} as const
+
+r4.evaluate('Patient.name.given', patient) // ['Adaeze', 'Mina']
+r4.first('Patient.name.family', patient) // 'Okoro'
+r4.test(patient, 'Patient.active = true') // true
+
+const family = r4.compile('Patient.name.family')
+family.evaluate(patient) // ['Okoro']
+```
+
+Engine methods parse on demand and cache by expression text. Build a separate
+engine when you need different defaults:
+
+```ts
+import { FhirPathEngine } from 'fhirpath-ts'
+import { r4Model } from 'fhirpath-ts/r4'
+
+const fp = new FhirPathEngine({ model: r4Model, env: { threshold: 5 } })
+fp.evaluate('%threshold + 1') // [6]
+```
+
+See [API reference](docs/api.md) for all entry points, options, custom functions,
+DTO behavior, parse caching, and Medplum type compatibility.
+
+## Suggested usage: DTOs
+
+For application code, prefer a DTO when several expressions build one row or
+view model. The resource type is declared once. Each field keeps its TypeScript
+type, and getters or methods can handle work that is clearer in TypeScript.
+
+```ts
+import { column, criteria, defineDto } from 'fhirpath-ts'
+import { r4 } from 'fhirpath-ts/r4'
+
+class PatientRow extends defineDto('Patient') {
+  @column('id', { default: '' })
+  id!: string
+
+  @column("name.where(use = 'official').first().family", { default: '' })
+  family!: string
+
+  @column('name.given', { collection: true })
+  givenNames!: string[]
+
+  @criteria('active = true')
+  active!: boolean
+
+  get label(): string {
+    return this.family || this.id
+  }
+}
+
+const rows = r4.project([patient], PatientRow)
+rows[0] // PatientRow { id: '', family: '', givenNames: [], active: true }
+rows[0]?.label // ''
+```
+
+`@column` and `@criteria` use standard JavaScript decorators. Your build must
+transpile them. TypeScript works with `target` set to ES2024 or lower. SWC and Babel
+also support them. For a build without decorator support,
+[use records with `project()`](docs/api.md#project).
+
+Pass DTOs through `resourceDtos` to call their columns from expressions with other
+FHIR resources as root:
+
+```ts
+class CodeableConceptDto extends defineDto('CodeableConcept') {
+  @column('(text | coding.display.first() | coding.first().code).first()')
+  displayText!: string | undefined
+}
+
+const fp = new FhirPathEngine({
+  model: r4Model,
+  resourceDtos: [CodeableConceptDto],
+})
+
+fp.first('Condition.code.displayText()', condition)
+```
+
+This is useful for shared application vocabulary such as `displayText()` or `isFinal()`.
+
+## Usage recipes
+
+These short examples show the main application APIs. The
+[playground demo](demo/README.md) is the best place to explore expressions
+interactively. A test runs every static expression in this section and checks it
+with the analyzer.
+
+### Read, test, and filter
+
+```ts
+r4.evaluate('Patient.name.given', patient)
+r4.first('Patient.name.family', patient)
+r4.test(patient, 'birthDate <= today()', { now: new Date('2026-08-04T12:00:00Z') })
+
+const systolic = r4.filter(
+  observations,
+  "Observation.code.coding.exists(system = %loinc and code = '8480-6')",
+  { env: { loinc: 'http://loinc.org' } },
+)
+const newestFirst = r4.evaluate(
+  'Observation.sort(-(effective.ofType(dateTime) | issued).first())',
+  systolic,
+)
+```
+
+### Check constraints
+
+`checkConstraints()` evaluates constraint expressions. It does not perform full
+profile validation such as cardinality, bindings, or slicing.
+
+```ts
+const result = r4.checkConstraints(patient, [
+  {
+    key: 'pat-1',
+    severity: 'error',
+    human: 'Contact needs a name or telecom',
+    expression: 'contact.all(name.exists() or telecom.exists())',
+  },
+])
+
+result.valid // true
+result.issues // []
+result.toOperationOutcome() // { resourceType: 'OperationOutcome', issue: [{ severity: 'information', ... }] }
+```
+
+### Convert quantities
+
+Known [UCUM](https://ucum.org/ucum) units compare and convert automatically.
+Unknown units can still compare with the same unit.
+
+```ts
+r4.filter(observations, "value.ofType(Quantity) > 140 'mm[Hg]'")
+r4.filter(observations, "value.ofType(Quantity).convertsToQuantity('kg')")
+r4.first("Observation.value.ofType(Quantity).toQuantity('kg').value", weight)
+```
+
+### Map status labels
+
+`choices` converts codes into typed application values. A missing code becomes
+empty, so `default` also handles future or unexpected codes.
+
+```ts
+const STATUS_CHOICES = [
+  { code: 'active', label: 'Active', tone: 'info' },
+  { code: 'recurrence', label: 'Recurrence', tone: 'danger' },
+  { code: 'resolved', label: 'Resolved', tone: 'neutral' },
+] as const
+
+const statusRows = r4.project(conditions, {
+  label: {
+    path: 'Condition.clinicalStatus.coding.first().code',
+    choices: STATUS_CHOICES,
+    pick: 'label',
+    default: 'Unknown',
+  },
+  tone: {
+    path: 'Condition.clinicalStatus.coding.first().code',
+    choices: STATUS_CHOICES,
+    pick: 'tone',
+    default: 'neutral' as const,
+  },
+})
+
+statusRows // [{ label: 'Active', tone: 'info' }, ..., { label: 'Unknown', tone: 'neutral' }]
+```
+
+### Join related resources
+
+Pass lookup data through `env`. Use `vars` to find the related item once per
+row. `%context` is the resource for the current row.
+
+```ts
+const reports = [...reportsByOrderId].map(([orderId, report]) => ({ orderId, report }))
+
+r4.project(
+  orders,
+  {
+    resultDate: {
+      path: '(%report.effective.ofType(dateTime) | %report.issued).first()',
+      type: 'string',
+      default: null,
+    },
+    hasResult: { test: '%report.exists()' },
+  },
+  { env: { reports }, vars: { report: '%reports.where(orderId = %context.id).report' } },
+)
+```
+
+### Follow references in a Bundle
+
+`resolve()` follows contained references and references to another Bundle entry.
+Start at `Bundle` so the Bundle remains available as the lookup scope.
+
+```ts
+r4.evaluate(
+  'Bundle.entry.resource.ofType(Observation).subject.resolve().name.family',
+  searchset,
+)
+```
+
+### Walk nested structures
+
+`repeat(item)` follows every nested `item` collection and returns the items at
+all depths, so this reads each questionnaire item's `linkId`.
+
+```ts
+r4.evaluate('Questionnaire.repeat(item).linkId', questionnaire)
+```
+
+### Deterministic tests and debugging
+
+`now` fixes the evaluation clock. `trace()` sends values to the sink you provide
+and does not log by itself.
+
+```ts
+r4.test(patient, 'birthDate <= today()', {
+  now: new Date('2026-08-04T12:00:00Z'),
+})
+
+r4.evaluate("Patient.name.trace('names').given", patient, {
+  trace: (name, values) => debugSink(name, values),
+})
+```
+
+## Important gotchas
+
+- FHIRPath always evaluates collections. Use `first()` when application code
+  expects one optional value.
+- Unknown elements evaluate to an empty collection, as they do in other
+  engines. Use [static checking](#static-checking) to catch misspellings before runtime.
+- Use choice stems such as `Observation.value`, not JSON keys such as
+  `valueQuantity`. The analyzer reports the latter as an error.
+- A bare search Bundle is treated as its entry resources for application helpers.
+  Start an expression at `Bundle` to address the Bundle itself, or wrap it in an
+  array to force one-resource treatment.
+- Inside `where()`, the focus is the item being scanned. Use `%context` or a
+  `%var` when a join condition needs the outer resource.
+- `env` contains plain host values. `vars` contains FHIRPath expressions evaluated
+  against the input and keeps FHIRPath type information.
+
+## Static checking
+
+Literal expressions infer useful result and input types without a compiler
+plugin:
+
+```ts
+const given = r4.compile('Patient.name.given')
+given.evaluate(patient) // string[]; the input must be a Patient
+```
+
+Type inference stays conservative. Expressions outside its supported subset
+become `unknown[]` instead of producing an incorrect type.
+
+Static checking has three layers:
+
+1. TypeScript infers common literal expressions at compile time.
+2. `fhirpath-ts/eslint` checks expression literals while linting.
+3. `fhirpath-check` runs the same analyzer without requiring ESLint and can load
+   exported DTOs for a complete DTO check.
+
+The analyzer is also public for editors, tests, and other tools. It follows the
+[FHIRPath §11 rules](https://hl7.org/fhirpath/en/index.html#type-safety-and-strict-evaluation)
+and is tested against the official valid and invalid cases.
+See [Static checking](docs/static-checking.md) for configuration, supported call
+sites, DTO discovery, and cases where source-only checks stay quiet.
+
+## Conformance
+
+The engine passes every non-skipped case in the vendored official R4 and R5
+FHIRPath suites. It also runs the fhirpath.js and fhirpath-py corpora. Each skip
+and intentional difference has a checked manifest entry with its reason.
+
+Property tests cover parser round trips, decimal arithmetic, and temporal
+comparisons. Generated expressions are also compared with fhirpath.js. A weekly
+job checks for changes in the upstream official suite (FHIR/fhir-test-cases).
+
+See [Conformance](docs/conformance.md) for counts, skip categories, phase checks,
+reference-suite results, and test maintenance. See
+[Engine comparison](docs/engine-comparison.md) for the feature and correctness
+comparison with other implementations.
+
+## Licensing and attribution
+
+Package code is part of this private repository. Third-party material and full
+license texts are collected in
+[`THIRD-PARTY-NOTICES.md`](./THIRD-PARTY-NOTICES.md).
+
+- The parser structure is adapted from Medplum (Apache-2.0).
+- Official FHIRPath tests come from FHIR/fhir-test-cases (Apache-2.0 and FHIR CC0
+  content).
+- Reference tests come from HL7/fhirpath.js (NLM BSD-style) and fhirpath-py (MIT).
+- Additional cases come from fhirpath-rs (Apache-2.0) and Medplum.
+- R4 model data is generated from HL7 FHIR R4 StructureDefinitions (CC0) in
+  `@medplum/definitions`. FHIR® is a registered trademark of HL7.
+
+## Development
+
+```bash
+pnpm test
+pnpm coverage
+pnpm typecheck
+pnpm lint
+pnpm check:fhirpath
+pnpm check:type-perf
+pnpm generate:r4
+```
+
+Run the demo separately:
+
+```bash
+cd demo
+npm install
+npm run dev
+```
+
+After changing the public API, run `npm run generate:dts` in `demo/` to refresh
+the Monaco declarations. See [AGENTS.md](AGENTS.md) for repository decisions that
+are easy to break during maintenance.
+
+## Gaps and deferred features
+
+The package currently ships only an R4 model. The engine is synchronous. Tagged
+templates remain untyped because TypeScript does not preserve their literal type
+([TypeScript #33304](https://github.com/microsoft/TypeScript/issues/33304)); use
+`fhirpath('...')` or `compile('...')` for inference in strings.
+Regex evaluation of user-authored expressions needs the security setup below.
+
+These features are deferred and fail with a clear error today:
+
+| Feature | What it needs |
+| --- | --- |
+| `memberOf()`, `subsumes()`, `subsumedBy()`, `%terminologies` | An async `TerminologyProvider` |
+| External `resolve()` | The same async evaluation path |
+| `conformsTo()` beyond base StructureDefinitions | Profile-aware validation |
+| `slice()`, `elementDefinition()`, `checkModifiers()` | Profile definitions in the model |
+| `weight()` | Code-system `itemWeight` lookups |
+| `%factory` | Demand for the current R5 draft API |
+| CDA mode | A CDA `ModelProvider` |
+| Full UCUM | A full UCUM implementation behind the current interface |
+| R5 model package | Generated R5 definitions and types |
+
+## Security guidelines
+
+### Expression trust
+
+Parser depth, tokenization, decimal and UCUM exponents, and property navigation
+have limits suitable for untrusted input. Regular expressions need one extra
+step. By default, `matches()`, `matchesFull()`, and `replaceMatches()` use the
+host `RegExp`, so a pattern with catastrophic backtracking can block the event
+loop.
+
+The analyzer warns about backtracking-prone literal patterns. If users can write
+expressions, also provide a linear-time regular expression engine, such as an RE2
+binding, through `EvaluateOptions.regex`. Review or sandbox user expressions as
+appropriate for the application.
+
+### Narrative checking
+
+`htmlChecks()` checks FHIR narrative rules and allows only inert URL schemes. It
+decodes attribute entities in the same way as a browser. A `true` result means
+the narrative contains no active content.
+
+### PHI and tracing
+
+`trace()` does nothing unless a trace sink is provided. Traced values may contain
+patient data. Never send PHI values to console output or production logs; use
+record identifiers instead.