@haste-health/fhir-pointer 0.10.1

package/lib/conversions.d.ts

@@ -0,0 +1,4 @@
+import { AllDataTypes, Data, FHIR_VERSION } from "@haste-health/fhir-types/versions";
+import { Loc, Parent } from "./types.js";
+export declare function toJSONPointer<T, R, P extends Parent<T>>(loc: Loc<T, R, P>): string;
+export declare function toFHIRPath<T extends Data<FHIR_VERSION, AllDataTypes>, R, P extends Parent<T>>(loc: Loc<T, R, P>): string;

package/lib/conversions.js

@@ -0,0 +1,82 @@
+import { getMeta, getStartingMeta, resolveMeta, } from "@haste-health/meta-value/meta";
+import { OperationError, outcomeFatal } from "@haste-health/operation-outcomes";
+import { pathMeta } from "./index.js";
+import { unescapeField } from "./utilities.js";
+export function toJSONPointer(loc) {
+    const indexOfLastSlash = loc.indexOf("/");
+    if (indexOfLastSlash === -1)
+        return "";
+    return loc.substring(indexOfLastSlash, loc.length);
+}
+function resolveFieldToTypeChoiceName(version, meta, field) {
+    const keysToCheck = Object.keys(meta.properties ?? {}).filter((key) => field.startsWith(key));
+    for (const key of keysToCheck) {
+        const information = getMeta(version, meta, key);
+        if (!information)
+            throw new Error("Invalid meta information");
+        if (information._type_ === "typechoice") {
+            const v = Object.keys(information.fieldsToType).find((f) => f === field);
+            // Return if typechoice includes field name.
+            if (v !== undefined)
+                return key;
+        }
+    }
+}
+export function toFHIRPath(loc) {
+    const indexOfLastSlash = loc.indexOf("/");
+    const { version, type } = pathMeta(loc);
+    let meta = getStartingMeta(version, type);
+    if (meta?._type_ === "fp-primitive")
+        throw new Error("Invalid meta information");
+    if (indexOfLastSlash === -1)
+        return "$this";
+    const pieces = loc.substring(indexOfLastSlash + 1).split("/");
+    let fp = "$this";
+    for (const piece of pieces) {
+        const unescapedField = unescapeField(piece);
+        const parsedNumber = parseInt(unescapedField);
+        let field = unescapedField;
+        if (isNaN(parsedNumber)) {
+            if (meta?.cardinality !== "single") {
+                throw new OperationError(outcomeFatal("invalid", "Cannot convert path to FHIRPath", [
+                    toJSONPointer(loc),
+                ]));
+            }
+            // Resolve typechoice to fp field name.
+            // IE valueCoding if typechoice would be just value.
+            if (!meta.properties?.[unescapedField]) {
+                const typeChoiceField = resolveFieldToTypeChoiceName(version, meta, unescapedField);
+                if (!typeChoiceField) {
+                    throw new OperationError(outcomeFatal("invalid", "Cannot convert path to FHIRPath", [
+                        toJSONPointer(loc),
+                    ]));
+                }
+                field = typeChoiceField;
+            }
+            const unresolvedMeta = getMeta(version, meta, field);
+            if (!unresolvedMeta)
+                throw new OperationError(outcomeFatal("exception", `Invalid meta information for field ${field}`));
+            const nextMeta = resolveMeta(version, unresolvedMeta, 
+            // Hack to inject the typechoice field in.
+            { [unescapedField]: {} }, field);
+            if (!nextMeta) {
+                throw new OperationError(outcomeFatal("invalid", "Cannot convert path to FHIRPath", [
+                    toJSONPointer(loc),
+                ]));
+            }
+            meta = nextMeta.meta;
+            fp += `.${field}`;
+        }
+        else {
+            if (meta?.cardinality !== "array") {
+                throw new OperationError(outcomeFatal("invalid", `Cannot convert path '${loc}' to FHIRPath`, [
+                    toJSONPointer(loc),
+                ]));
+            }
+            fp += `[${parsedNumber}]`;
+            meta = { ...meta, cardinality: "single" };
+        }
+    }
+    return fp;
+}
+//# sourceMappingURL=conversions.js.map

package/lib/conversions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversions.js","sourceRoot":"","sources":["../src/conversions.ts"],"names":[],"mappings":"AAMA,OAAO,EAEL,OAAO,EACP,eAAe,EACf,WAAW,GACZ,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,MAAM,UAAU,aAAa,CAA4B,GAAiB;IACxE,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,gBAAgB,KAAK,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IACvC,OAAO,GAAG,CAAC,SAAS,CAAC,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,4BAA4B,CACnC,OAAqB,EACrB,IAAiB,EACjB,KAAa;IAEb,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CACpE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CACtB,CAAC;IAEF,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QAC9B,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAChD,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9D,IAAI,WAAW,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YACxC,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC;YACzE,4CAA4C;YAC5C,IAAI,CAAC,KAAK,SAAS;gBAAE,OAAO,GAAG,CAAC;QAClC,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,UAAU,CAIxB,GAAiB;IACjB,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAE1C,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAExC,IAAI,IAAI,GAAG,eAAe,CAAC,OAAO,EAAE,IAAW,CAAC,CAAC;IACjD,IAAI,IAAI,EAAE,MAAM,KAAK,cAAc;QACjC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAE9C,IAAI,gBAAgB,KAAK,CAAC,CAAC;QAAE,OAAO,OAAO,CAAC;IAC5C,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9D,IAAI,EAAE,GAAG,OAAO,CAAC;IAEjB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,YAAY,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC9C,IAAI,KAAK,GAAG,cAAc,CAAC;QAE3B,IAAI,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YACxB,IAAI,IAAI,EAAE,WAAW,KAAK,QAAQ,EAAE,CAAC;gBACnC,MAAM,IAAI,cAAc,CACtB,YAAY,CAAC,SAAS,EAAE,iCAAiC,EAAE;oBACzD,aAAa,CAAC,GAAG,CAAC;iBACnB,CAAC,CACH,CAAC;YACJ,CAAC;YAED,uCAAuC;YACvC,oDAAoD;YACpD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC;gBACvC,MAAM,eAAe,GAAG,4BAA4B,CAClD,OAAO,EACP,IAAI,EACJ,cAAc,CACf,CAAC;gBACF,IAAI,CAAC,eAAe,EAAE,CAAC;oBACrB,MAAM,IAAI,cAAc,CACtB,YAAY,CAAC,SAAS,EAAE,iCAAiC,EAAE;wBACzD,aAAa,CAAC,GAAG,CAAC;qBACnB,CAAC,CACH,CAAC;gBACJ,CAAC;gBACD,KAAK,GAAG,eAAe,CAAC;YAC1B,CAAC;YAED,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YACrD,IAAI,CAAC,cAAc;gBACjB,MAAM,IAAI,cAAc,CACtB,YAAY,CACV,WAAW,EACX,sCAAsC,KAAK,EAAE,CAC9C,CACF,CAAC;YAEJ,MAAM,QAAQ,GAAG,WAAW,CAC1B,OAAO,EACP,cAAc;YACd,0CAA0C;YAC1C,EAAE,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,EACxB,KAAK,CACN,CAAC;YACF,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,cAAc,CACtB,YAAY,CAAC,SAAS,EAAE,iCAAiC,EAAE;oBACzD,aAAa,CAAC,GAAG,CAAC;iBACnB,CAAC,CACH,CAAC;YACJ,CAAC;YAED,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAErB,EAAE,IAAI,IAAI,KAAK,EAAE,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,EAAE,WAAW,KAAK,OAAO,EAAE,CAAC;gBAClC,MAAM,IAAI,cAAc,CACtB,YAAY,CAAC,SAAS,EAAE,wBAAwB,GAAG,eAAe,EAAE;oBAClE,aAAa,CAAC,GAAG,CAAC;iBACnB,CAAC,CACH,CAAC;YACJ,CAAC;YAED,EAAE,IAAI,IAAI,YAAY,GAAG,CAAC;YAE1B,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,21 @@
+import { id } from "@haste-health/fhir-types/r4/types";
+import { AllDataTypes, Data, DataType, FHIR_VERSION } from "@haste-health/fhir-types/versions";
+import { Loc, NullGuard, Parent } from "./types.js";
+export type { Loc, NullGuard } from "./types.js";
+export * from "./conversions.js";
+export declare function descend<T, R, P extends Parent<T>, Field extends keyof NonNullable<R>>(loc: Loc<T, R, P>, field: Field): Loc<T, NullGuard<R, Field>, typeof loc>;
+type ReturnType<L> = L extends Loc<infer B, infer T, infer P> ? T : any;
+export declare function ascend<T, R, P extends Parent<T>>(loc: Loc<T, R, P>): {
+    parent: NonNullable<P>;
+    field: NonNullable<keyof ReturnType<P>>;
+} | undefined;
+export declare function pathMeta<Version extends FHIR_VERSION, T extends Data<Version, AllDataTypes>, R, P extends Parent<T>>(loc: Loc<T, R, P>): {
+    version: FHIR_VERSION;
+    type: DataType<Version>;
+    id: id;
+};
+export declare function get<T, R, P extends Parent<T>>(loc: Loc<T, R, P>, v: T): R;
+export declare function fields<T extends object, R, P extends Parent<T>>(loc: Loc<T, R, P>): (string | number | symbol)[];
+export declare function root<Version extends FHIR_VERSION, T extends Data<Version, AllDataTypes>, R, P extends Parent<T>>(loc: Loc<T, R, P>): Loc<T, T>;
+export declare function pointer<Version extends FHIR_VERSION, T extends DataType<Version>>(fhir_version: FHIR_VERSION, resourceType: T, resourceId: id): Loc<Data<Version, T>, Data<Version, T>>;
+export declare function typedPointer<V, T>(): Loc<V, T, Parent<V>>;

package/lib/index.js

@@ -0,0 +1,75 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import jsonpointer from "jsonpointer";
+import { R4, } from "@haste-health/fhir-types/versions";
+import { toJSONPointer } from "./conversions.js";
+import { escapeField, unescapeField } from "./utilities.js";
+export * from "./conversions.js";
+/*
+ ** Descend Loc pointer with field.
+ */
+export function descend(loc, field) {
+    return `${loc}/${escapeField(String(field))}`;
+}
+/*
+ ** Ascend Loc pointer to parent.
+ */
+export function ascend(loc) {
+    // At root so return undefined.
+    const lastIndexSlash = loc.lastIndexOf("/");
+    if (lastIndexSlash === -1)
+        return undefined;
+    const field = unescapeField(loc.substring(lastIndexSlash + 1));
+    return {
+        parent: loc.slice(0, lastIndexSlash),
+        field: Number.isNaN(parseInt(field))
+            ? field
+            : parseInt(field),
+    };
+}
+export function pathMeta(loc) {
+    const indexOfLastSlash = loc.indexOf("/");
+    const [fhirVersion, type, id] = loc
+        .substring(0, indexOfLastSlash === -1 ? loc.length : indexOfLastSlash)
+        .split("|");
+    return {
+        version: fhirVersion,
+        type: type,
+        id: id,
+    };
+}
+export function get(loc, v) {
+    const pointer = toJSONPointer(loc);
+    if (typeof v !== "object" || v === null) {
+        if (pointer === "") {
+            return v;
+        }
+        throw new Error(`Invalid pointer for primitive value ${typeof v}`);
+    }
+    return jsonpointer.get(v, pointer);
+}
+export function fields(loc) {
+    let asc = ascend(loc);
+    const fields = [];
+    while (asc) {
+        fields.unshift(asc.field);
+        asc = ascend(asc.parent);
+    }
+    return fields;
+}
+export function root(loc) {
+    const { version, type, id } = pathMeta(loc);
+    return pointer(version, type, id);
+}
+function metaString(fhirVersion, type, id) {
+    return `${fhirVersion}|${type}|${id}`;
+}
+/*
+ ** Creates a Loc pointer for a resource.
+ */
+export function pointer(fhir_version, resourceType, resourceId) {
+    return `${metaString(fhir_version, resourceType, resourceId)}`;
+}
+export function typedPointer() {
+    return metaString(R4, "Unknown", "unknown");
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,OAAO,WAAW,MAAM,aAAa,CAAC;AAGtC,OAAO,EAKL,EAAE,GACH,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAG5D,cAAc,kBAAkB,CAAC;AAEjC;;GAEG;AACH,MAAM,UAAU,OAAO,CAKrB,GAAiB,EAAE,KAAY;IAC/B,OAAO,GAAG,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAI1C,CAAC;AACJ,CAAC;AAID;;GAEG;AACH,MAAM,UAAU,MAAM,CACpB,GAAiB;IAIjB,+BAA+B;IAC/B,MAAM,cAAc,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC5C,IAAI,cAAc,KAAK,CAAC,CAAC;QAAE,OAAO,SAAS,CAAC;IAC5C,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC;IAC/D,OAAO;QACL,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAmB;QACtD,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAClC,CAAC,CAAC,KAAK;YACP,CAAC,CAAE,QAAQ,CAAC,KAAK,CAAsC;KAC1D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAMtB,GAAiB;IAEjB,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG;SAChC,SAAS,CAAC,CAAC,EAAE,gBAAgB,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC;SACrE,KAAK,CAAC,GAAG,CAAC,CAAC;IACd,OAAO;QACL,OAAO,EAAE,WAA2B;QACpC,IAAI,EAAE,IAAyB;QAC/B,EAAE,EAAE,EAAQ;KACb,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,GAAG,CAA4B,GAAiB,EAAE,CAAI;IACpE,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IAEnC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACxC,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;YACnB,OAAO,CAAiB,CAAC;QAC3B,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAM,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,MAAM,CACpB,GAAiB;IAEjB,IAAI,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IACtB,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,OAAO,GAAG,EAAE,CAAC;QACX,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC1B,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,IAAI,CAKlB,GAAiB;IACjB,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5C,OAAO,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,CAAqB,CAAC;AACxD,CAAC;AAED,SAAS,UAAU,CACjB,WAAyB,EACzB,IAAuB,EACvB,EAAM;IAEN,OAAO,GAAG,WAAW,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,OAAO,CAIrB,YAA0B,EAC1B,YAAe,EACf,UAAc;IAEd,OAAO,GAAG,UAAU,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,EAG3D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,OAAO,UAAU,CAAC,EAAE,EAAE,SAAyB,EAAE,SAAe,CAI/D,CAAC;AACJ,CAAC"}

package/lib/types.d.ts

@@ -0,0 +1,11 @@
+declare const __parent: unique symbol;
+declare const __root: unique symbol;
+type _Loc<B, T> = {
+    [__root]: (root: B) => T;
+};
+export type Parent<B> = Loc<B, unknown, any> | null;
+export type Loc<B, T, P extends Loc<B, unknown, Parent<B>> | null = null> = string & _Loc<B, T> & {
+    [__parent]: P;
+};
+export type NullGuard<V, Field extends keyof NonNullable<V>> = V extends NonNullable<V> ? NonNullable<V>[Field] : NonNullable<V>[Field] | undefined;
+export {};

package/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/lib/utilities.d.ts

@@ -0,0 +1,2 @@
+export declare function escapeField(field: string): string;
+export declare function unescapeField(field: string): string;

package/lib/utilities.js

@@ -0,0 +1,8 @@
+// See [https://datatracker.ietf.org/doc/html/rfc6901#section-3] for reference.
+export function escapeField(field) {
+    return field.replace("~", "~0").replace("/", "~1");
+}
+export function unescapeField(field) {
+    return field.replace("~1", "/").replace("~0", "~");
+}
+//# sourceMappingURL=utilities.js.map

package/lib/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,MAAM,UAAU,WAAW,CAAC,KAAa;IACvC,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AACrD,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@haste-health/fhir-pointer",
+  "version": "0.10.1",
+  "homepage": "https://haste.health",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HasteHealth/HasteHealth.git"
+  },
+  "description": "FHIR Pointer allows creation and manipulation of pointers to fhir-types.",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "pnpm node --experimental-vm-modules $(pnpm bin jest)",
+    "publish": "pnpm build && pnpm npm publish --access public --tolerate-republish"
+  },
+  "keywords": [],
+  "author": "HasteHealth",
+  "license": "ISC",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "devDependencies": {
+    "@haste-health/fhir-types": "workspace:^",
+    "@jest/globals": "^29.7.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.3.2",
+    "typescript": "5.9.2"
+  },
+  "files": [
+    "readme.md",
+    "lib/**",
+    "src/**"
+  ],
+  "dependencies": {
+    "@haste-health/meta-value": "workspace:^",
+    "@haste-health/operation-outcomes": "workspace:^",
+    "jsonpointer": "^5.0.1"
+  }
+}

package/src/conversions.test.ts

@@ -0,0 +1,32 @@
+import { expect, test } from "@jest/globals";
+
+import { id } from "@haste-health/fhir-types/lib/generated/r4/types";
+import { R4 } from "@haste-health/fhir-types/versions";
+
+import { Loc, descend, pointer, toFHIRPath } from "./index.js";
+
+test("Test fhirpath conversion", async () => {
+  expect(
+    toFHIRPath(
+      descend(
+        descend(
+          descend(
+            pointer(R4, "Observation", "test" as id),
+            "valueCodeableConcept"
+          ),
+          "coding"
+        ),
+        0
+      )
+    )
+  ).toEqual("$this.value.coding[0]");
+});
+
+test("4.0|Patient|invalid-us-core-patient/extension/0/extension/0/valueCoding", async () => {
+  const fields = ["extension", 0, "extension", 0, "valueCoding"];
+  const pt = fields.reduce((pt: Loc<any, any, any>, field: string | number) => {
+    return descend(pt, field);
+  }, pointer(R4, "Patient", "invalid-us-core-patient" as id));
+
+  expect(toFHIRPath(pt)).toEqual("$this.extension[0].extension[0].value");
+});

package/src/conversions.ts

@@ -0,0 +1,137 @@
+import { uri } from "@haste-health/fhir-types/lib/generated/r4/types";
+import {
+  AllDataTypes,
+  Data,
+  FHIR_VERSION,
+} from "@haste-health/fhir-types/versions";
+import {
+  ElementNode,
+  getMeta,
+  getStartingMeta,
+  resolveMeta,
+} from "@haste-health/meta-value/meta";
+import { OperationError, outcomeFatal } from "@haste-health/operation-outcomes";
+
+import { pathMeta } from "./index.js";
+import { Loc, Parent } from "./types.js";
+import { unescapeField } from "./utilities.js";
+
+export function toJSONPointer<T, R, P extends Parent<T>>(loc: Loc<T, R, P>) {
+  const indexOfLastSlash = loc.indexOf("/");
+  if (indexOfLastSlash === -1) return "";
+  return loc.substring(indexOfLastSlash, loc.length);
+}
+
+function resolveFieldToTypeChoiceName(
+  version: FHIR_VERSION,
+  meta: ElementNode,
+  field: string
+): string | undefined {
+  const keysToCheck = Object.keys(meta.properties ?? {}).filter((key) =>
+    field.startsWith(key)
+  );
+
+  for (const key of keysToCheck) {
+    const information = getMeta(version, meta, key);
+    if (!information) throw new Error("Invalid meta information");
+    if (information._type_ === "typechoice") {
+      const v = Object.keys(information.fieldsToType).find((f) => f === field);
+      // Return if typechoice includes field name.
+      if (v !== undefined) return key;
+    }
+  }
+}
+
+export function toFHIRPath<
+  T extends Data<FHIR_VERSION, AllDataTypes>,
+  R,
+  P extends Parent<T>
+>(loc: Loc<T, R, P>) {
+  const indexOfLastSlash = loc.indexOf("/");
+
+  const { version, type } = pathMeta(loc);
+
+  let meta = getStartingMeta(version, type as uri);
+  if (meta?._type_ === "fp-primitive")
+    throw new Error("Invalid meta information");
+
+  if (indexOfLastSlash === -1) return "$this";
+  const pieces = loc.substring(indexOfLastSlash + 1).split("/");
+  let fp = "$this";
+
+  for (const piece of pieces) {
+    const unescapedField = unescapeField(piece);
+    const parsedNumber = parseInt(unescapedField);
+    let field = unescapedField;
+
+    if (isNaN(parsedNumber)) {
+      if (meta?.cardinality !== "single") {
+        throw new OperationError(
+          outcomeFatal("invalid", "Cannot convert path to FHIRPath", [
+            toJSONPointer(loc),
+          ])
+        );
+      }
+
+      // Resolve typechoice to fp field name.
+      // IE valueCoding if typechoice would be just value.
+      if (!meta.properties?.[unescapedField]) {
+        const typeChoiceField = resolveFieldToTypeChoiceName(
+          version,
+          meta,
+          unescapedField
+        );
+        if (!typeChoiceField) {
+          throw new OperationError(
+            outcomeFatal("invalid", "Cannot convert path to FHIRPath", [
+              toJSONPointer(loc),
+            ])
+          );
+        }
+        field = typeChoiceField;
+      }
+
+      const unresolvedMeta = getMeta(version, meta, field);
+      if (!unresolvedMeta)
+        throw new OperationError(
+          outcomeFatal(
+            "exception",
+            `Invalid meta information for field ${field}`
+          )
+        );
+
+      const nextMeta = resolveMeta(
+        version,
+        unresolvedMeta,
+        // Hack to inject the typechoice field in.
+        { [unescapedField]: {} },
+        field
+      );
+      if (!nextMeta) {
+        throw new OperationError(
+          outcomeFatal("invalid", "Cannot convert path to FHIRPath", [
+            toJSONPointer(loc),
+          ])
+        );
+      }
+
+      meta = nextMeta.meta;
+
+      fp += `.${field}`;
+    } else {
+      if (meta?.cardinality !== "array") {
+        throw new OperationError(
+          outcomeFatal("invalid", `Cannot convert path '${loc}' to FHIRPath`, [
+            toJSONPointer(loc),
+          ])
+        );
+      }
+
+      fp += `[${parsedNumber}]`;
+
+      meta = { ...meta, cardinality: "single" };
+    }
+  }
+
+  return fp;
+}

package/src/index.test.ts

@@ -0,0 +1,130 @@
+import { expect, test } from "@jest/globals";
+
+import { Patient, id } from "@haste-health/fhir-types/r4/types";
+import { R4 } from "@haste-health/fhir-types/versions";
+
+import {
+  Loc,
+  ascend,
+  descend,
+  fields,
+  get,
+  pathMeta,
+  pointer,
+  root,
+  toJSONPointer,
+  typedPointer,
+} from "./index";
+
+test("pointer", () => {
+  const loc = pointer(R4, "Patient", "123" as id);
+  expect(loc).toBe("4.0|Patient|123");
+});
+
+test("ascend pointer", () => {
+  const loc = descend(pointer(R4, "Patient", "123" as id), "name");
+  expect(ascend(loc)).toEqual({ parent: "4.0|Patient|123", field: "name" });
+  // @ts-ignore
+  expect(ascend(ascend(loc)?.parent)).toEqual(undefined);
+
+  const nestedLoc = descend(
+    descend(descend(pointer(R4, "Patient", "123" as id), "name"), 0),
+    "given"
+  );
+  expect(nestedLoc).toEqual("4.0|Patient|123/name/0/given");
+  expect(ascend(nestedLoc)).toEqual({
+    parent: "4.0|Patient|123/name/0",
+    field: "given",
+  });
+
+  // @ts-ignore
+  expect(ascend(ascend(nestedLoc)?.parent)).toEqual({
+    parent: "4.0|Patient|123/name",
+    field: 0,
+  });
+});
+
+test("get function", () => {
+  const nestedLoc = descend(
+    descend(descend(pointer(R4, "Patient", "123" as id), "name"), 0),
+    "given"
+  );
+
+  const patient: Patient = {
+    resourceType: "Patient",
+    id: "123",
+    name: [{ given: ["John"] }],
+  } as Patient;
+
+  expect(get(nestedLoc, patient)).toEqual(["John"]);
+  expect(
+    get(
+      descend(descend(pointer(R4, "Patient", "123" as id), "name"), 1),
+      patient
+    )
+  ).toEqual(undefined);
+
+  expect(
+    get(
+      descend(
+        descend(descend(pointer(R4, "Patient", "123" as id), "name"), 1),
+        "given"
+      ),
+      patient
+    )
+  ).toEqual(undefined);
+
+  expect(
+    get(
+      descend(
+        descend(descend(pointer(R4, "Patient", "123" as id), "identifier"), 1),
+        "system"
+      ),
+      patient
+    )
+  ).toEqual(undefined);
+});
+
+test("path meta", () => {
+  const nestedLoc = descend(pointer(R4, "Patient", "123" as id), "name");
+  expect(pathMeta(nestedLoc)).toEqual({
+    version: "4.0",
+    type: "Patient",
+    id: "123",
+  });
+});
+
+test("fields", () => {
+  const nestedLoc = descend(
+    descend(descend(pointer(R4, "Patient", "123" as id), "name"), 0),
+    "given"
+  );
+  expect(fields(nestedLoc)).toEqual(["name", 0, "given"]);
+});
+
+test("root", () => {
+  const nestedLoc = descend(
+    descend(descend(pointer(R4, "Patient", "123" as id), "name"), 0),
+    "given"
+  );
+  expect(root(nestedLoc)).toEqual("4.0|Patient|123");
+  expect(toJSONPointer(root(nestedLoc))).toEqual("");
+  expect(root(pointer(R4, "Patient", "123" as id))).toEqual("4.0|Patient|123");
+});
+
+test("escaping strings.", () => {
+  const loc = pointer(R4, "Patient", "asdf" as id) as Loc<any, any>;
+  const escapedLoc = descend(descend(loc, "~name"), "/test");
+  expect(escapedLoc).toEqual("4.0|Patient|asdf/~0name/~1test");
+  expect(toJSONPointer(escapedLoc)).toEqual("/~0name/~1test");
+  expect(get(escapedLoc, { "~name": { "/test": "test" } })).toEqual("test");
+});
+
+test("typedpointer", () => {
+  const loc = typedPointer() as Loc<any, any>;
+  expect(toJSONPointer(loc)).toEqual("");
+  const escapedLoc = descend(descend(loc, "~name"), "/test");
+  expect(escapedLoc).toEqual("4.0|Unknown|unknown/~0name/~1test");
+  expect(toJSONPointer(escapedLoc)).toEqual("/~0name/~1test");
+  expect(get(escapedLoc, { "~name": { "/test": "test" } })).toEqual("test");
+});

package/src/index.ts

@@ -0,0 +1,143 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import jsonpointer from "jsonpointer";
+
+import { id } from "@haste-health/fhir-types/r4/types";
+import {
+  AllDataTypes,
+  Data,
+  DataType,
+  FHIR_VERSION,
+  R4,
+} from "@haste-health/fhir-types/versions";
+
+import { toJSONPointer } from "./conversions.js";
+import { Loc, NullGuard, Parent } from "./types.js";
+import { escapeField, unescapeField } from "./utilities.js";
+
+export type { Loc, NullGuard } from "./types.js";
+export * from "./conversions.js";
+
+/*
+ ** Descend Loc pointer with field.
+ */
+export function descend<
+  T,
+  R,
+  P extends Parent<T>,
+  Field extends keyof NonNullable<R>
+>(loc: Loc<T, R, P>, field: Field): Loc<T, NullGuard<R, Field>, typeof loc> {
+  return `${loc}/${escapeField(String(field))}` as Loc<
+    T,
+    NullGuard<R, Field>,
+    typeof loc
+  >;
+}
+
+type ReturnType<L> = L extends Loc<infer B, infer T, infer P> ? T : any;
+
+/*
+ ** Ascend Loc pointer to parent.
+ */
+export function ascend<T, R, P extends Parent<T>>(
+  loc: Loc<T, R, P>
+):
+  | { parent: NonNullable<P>; field: NonNullable<keyof ReturnType<P>> }
+  | undefined {
+  // At root so return undefined.
+  const lastIndexSlash = loc.lastIndexOf("/");
+  if (lastIndexSlash === -1) return undefined;
+  const field = unescapeField(loc.substring(lastIndexSlash + 1));
+  return {
+    parent: loc.slice(0, lastIndexSlash) as NonNullable<P>,
+    field: Number.isNaN(parseInt(field))
+      ? field
+      : (parseInt(field) as keyof NonNullable<ReturnType<P>>),
+  };
+}
+
+export function pathMeta<
+  Version extends FHIR_VERSION,
+  T extends Data<Version, AllDataTypes>,
+  R,
+  P extends Parent<T>
+>(
+  loc: Loc<T, R, P>
+): { version: FHIR_VERSION; type: DataType<Version>; id: id } {
+  const indexOfLastSlash = loc.indexOf("/");
+  const [fhirVersion, type, id] = loc
+    .substring(0, indexOfLastSlash === -1 ? loc.length : indexOfLastSlash)
+    .split("|");
+  return {
+    version: fhirVersion as FHIR_VERSION,
+    type: type as DataType<Version>,
+    id: id as id,
+  };
+}
+
+export function get<T, R, P extends Parent<T>>(loc: Loc<T, R, P>, v: T): R {
+  const pointer = toJSONPointer(loc);
+
+  if (typeof v !== "object" || v === null) {
+    if (pointer === "") {
+      return v as unknown as R;
+    }
+    throw new Error(`Invalid pointer for primitive value ${typeof v}`);
+  }
+
+  return jsonpointer.get(v, pointer) as R;
+}
+
+export function fields<T extends object, R, P extends Parent<T>>(
+  loc: Loc<T, R, P>
+) {
+  let asc = ascend(loc);
+  const fields = [];
+  while (asc) {
+    fields.unshift(asc.field);
+    asc = ascend(asc.parent);
+  }
+  return fields;
+}
+
+export function root<
+  Version extends FHIR_VERSION,
+  T extends Data<Version, AllDataTypes>,
+  R,
+  P extends Parent<T>
+>(loc: Loc<T, R, P>): Loc<T, T> {
+  const { version, type, id } = pathMeta(loc);
+  return pointer(version, type, id) as any as Loc<T, T>;
+}
+
+function metaString<Version extends FHIR_VERSION>(
+  fhirVersion: FHIR_VERSION,
+  type: DataType<Version>,
+  id: id
+) {
+  return `${fhirVersion}|${type}|${id}`;
+}
+
+/*
+ ** Creates a Loc pointer for a resource.
+ */
+export function pointer<
+  Version extends FHIR_VERSION,
+  T extends DataType<Version>
+>(
+  fhir_version: FHIR_VERSION,
+  resourceType: T,
+  resourceId: id
+): Loc<Data<Version, T>, Data<Version, T>> {
+  return `${metaString(fhir_version, resourceType, resourceId)}` as Loc<
+    Data<Version, T>,
+    Data<Version, T>
+  >;
+}
+
+export function typedPointer<V, T>(): Loc<V, T, Parent<V>> {
+  return metaString(R4, "Unknown" as DataType<R4>, "unknown" as id) as Loc<
+    V,
+    T,
+    Parent<V>
+  >;
+}

package/src/types.ts

@@ -0,0 +1,21 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// Parent Loc
+declare const __parent: unique symbol;
+declare const __root: unique symbol;
+type _Loc<B, T> = { [__root]: (root: B) => T };
+export type Parent<B> = Loc<B, unknown, any> | null;
+
+export type Loc<
+  B,
+  T,
+  P extends Loc<B, unknown, Parent<B>> | null = null,
+> = string & _Loc<B, T> & { [__parent]: P };
+
+/*
+ ** Access field in potentially Nullable V
+ ** If V is nullable then set the return type to potentially nullable as well.
+ */
+export type NullGuard<V, Field extends keyof NonNullable<V>> =
+  V extends NonNullable<V>
+    ? NonNullable<V>[Field]
+    : NonNullable<V>[Field] | undefined;

package/src/utilities.ts

@@ -0,0 +1,8 @@
+// See [https://datatracker.ietf.org/doc/html/rfc6901#section-3] for reference.
+export function escapeField(field: string) {
+  return field.replace("~", "~0").replace("/", "~1");
+}
+
+export function unescapeField(field: string) {
+  return field.replace("~1", "/").replace("~0", "~");
+}