phenoml 0.0.17 → 0.0.18

package/dist/cjs/Client.js

@@ -52,8 +52,8 @@ class phenomlClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "phenoml",
-                "X-Fern-SDK-Version": "0.0.17",
-                "User-Agent": "phenoml/0.0.17",
+                "X-Fern-SDK-Version": "0.0.18",
+                "User-Agent": "phenoml/0.0.18",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/lang2Fhir/client/Client.d.ts

@@ -60,9 +60,9 @@ export declare class Lang2Fhir {
      *
      * @example
      *     await client.lang2Fhir.uploadProfile({
-     *         version: "version",
-     *         resource: "custom-patient",
-     *         profile: "profile"
+     *         version: "R4",
+     *         resource: "condition-encounter-diagnosis",
+     *         profile: "(base64 encoded JSON string of the FHIR profile)"
      *     })
      */
     uploadProfile(request: phenoml.lang2Fhir.ProfileUploadRequest, requestOptions?: Lang2Fhir.RequestOptions): core.HttpResponsePromise<phenoml.lang2Fhir.Lang2FhirUploadProfileResponse>;

package/dist/cjs/api/resources/lang2Fhir/client/Client.js

@@ -211,9 +211,9 @@ class Lang2Fhir {
      *
      * @example
      *     await client.lang2Fhir.uploadProfile({
-     *         version: "version",
-     *         resource: "custom-patient",
-     *         profile: "profile"
+     *         version: "R4",
+     *         resource: "condition-encounter-diagnosis",
+     *         profile: "(base64 encoded JSON string of the FHIR profile)"
      *     })
      */
     uploadProfile(request, requestOptions) {

package/dist/cjs/api/resources/lang2Fhir/client/requests/ProfileUploadRequest.d.ts

@@ -1,9 +1,9 @@
 /**
  * @example
  *     {
- *         version: "version",
- *         resource: "custom-patient",
- *         profile: "profile"
+ *         version: "R4",
+ *         resource: "condition-encounter-diagnosis",
+ *         profile: "(base64 encoded JSON string of the FHIR profile)"
  *     }
  */
 export interface ProfileUploadRequest {

package/dist/cjs/api/resources/summary/client/Client.d.ts

@@ -99,9 +99,10 @@ export declare class Summary {
     deleteTemplate(id: string, requestOptions?: Summary.RequestOptions): core.HttpResponsePromise<phenoml.summary.SummaryDeleteTemplateResponse>;
     private __deleteTemplate;
     /**
-     * Creates a summary from FHIR resources using one of two modes:
+     * Creates a summary from FHIR resources using one of three modes:
      * - **narrative**: Uses a template to substitute FHIR data into placeholders (requires template_id)
      * - **flatten**: Flattens FHIR resources into a searchable format for RAG/search (no template needed)
+     * - **ips**: Generates an International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG. Requires a Bundle with exactly one Patient resource (returns 400 error if no Patient or multiple Patients are present). Automatically filters resources to those referencing the patient and generates sections for allergies, medications, problems, immunizations, procedures, and vital signs.
      *
      * @param {phenoml.summary.CreateSummaryRequest} request
      * @param {Summary.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/summary/client/Client.js

@@ -419,9 +419,10 @@ class Summary {
         });
     }
     /**
-     * Creates a summary from FHIR resources using one of two modes:
+     * Creates a summary from FHIR resources using one of three modes:
      * - **narrative**: Uses a template to substitute FHIR data into placeholders (requires template_id)
      * - **flatten**: Flattens FHIR resources into a searchable format for RAG/search (no template needed)
+     * - **ips**: Generates an International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG. Requires a Bundle with exactly one Patient resource (returns 400 error if no Patient or multiple Patients are present). Automatically filters resources to those referencing the patient and generates sections for allergies, medications, problems, immunizations, procedures, and vital signs.
      *
      * @param {phenoml.summary.CreateSummaryRequest} request
      * @param {Summary.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/summary/client/requests/CreateSummaryRequest.d.ts

@@ -12,11 +12,18 @@ export interface CreateSummaryRequest {
      * Summary generation mode:
      * - narrative: Substitute FHIR data into a template (requires template_id)
      * - flatten: Flatten FHIR resources for RAG/search (no template needed)
+     * - ips: Generate International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG
      */
     mode?: CreateSummaryRequest.Mode;
     /** ID of the template to use (required for narrative mode) */
     template_id?: string;
-    /** FHIR resources (single resource or Bundle) */
+    /**
+     * FHIR resources (single resource or Bundle).
+     * For IPS mode, must be a Bundle containing exactly one Patient resource with at least one
+     * identifier (id, fullUrl, or identifier field). Returns an error if no Patient is found,
+     * if multiple Patients are present, or if the Patient has no identifiers. Resources are
+     * automatically filtered to only include those referencing the patient.
+     */
     fhir_resources: CreateSummaryRequest.FhirResources;
 }
 export declare namespace CreateSummaryRequest {
@@ -24,14 +31,20 @@ export declare namespace CreateSummaryRequest {
      * Summary generation mode:
      * - narrative: Substitute FHIR data into a template (requires template_id)
      * - flatten: Flatten FHIR resources for RAG/search (no template needed)
+     * - ips: Generate International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG
      */
     const Mode: {
         readonly Narrative: "narrative";
         readonly Flatten: "flatten";
+        readonly Ips: "ips";
     };
     type Mode = (typeof Mode)[keyof typeof Mode];
     /**
-     * FHIR resources (single resource or Bundle)
+     * FHIR resources (single resource or Bundle).
+     * For IPS mode, must be a Bundle containing exactly one Patient resource with at least one
+     * identifier (id, fullUrl, or identifier field). Returns an error if no Patient is found,
+     * if multiple Patients are present, or if the Patient has no identifiers. Resources are
+     * automatically filtered to only include those referencing the patient.
      */
     type FhirResources = phenoml.summary.FhirResource | phenoml.summary.FhirBundle;
 }

package/dist/cjs/api/resources/summary/client/requests/CreateSummaryRequest.js

@@ -8,9 +8,11 @@ var CreateSummaryRequest;
      * Summary generation mode:
      * - narrative: Substitute FHIR data into a template (requires template_id)
      * - flatten: Flatten FHIR resources for RAG/search (no template needed)
+     * - ips: Generate International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG
      */
     CreateSummaryRequest.Mode = {
         Narrative: "narrative",
         Flatten: "flatten",
+        Ips: "ips",
     };
 })(CreateSummaryRequest || (exports.CreateSummaryRequest = CreateSummaryRequest = {}));

package/dist/cjs/api/resources/summary/types/ErrorResponse.d.ts

@@ -0,0 +1,5 @@
+export interface ErrorResponse {
+    success?: boolean;
+    /** Error message describing what went wrong */
+    error?: string;
+}

package/dist/cjs/api/resources/summary/types/ErrorResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/summary/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./CreateSummaryResponse.js";
 export * from "./CreateSummaryTemplateResponse.js";
+export * from "./ErrorResponse.js";
 export * from "./FhirBundle.js";
 export * from "./FhirResource.js";
 export * from "./SummaryDeleteTemplateResponse.js";

package/dist/cjs/api/resources/summary/types/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CreateSummaryResponse.js"), exports);
 __exportStar(require("./CreateSummaryTemplateResponse.js"), exports);
+__exportStar(require("./ErrorResponse.js"), exports);
 __exportStar(require("./FhirBundle.js"), exports);
 __exportStar(require("./FhirResource.js"), exports);
 __exportStar(require("./SummaryDeleteTemplateResponse.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.17";
+export declare const SDK_VERSION = "0.0.18";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.17";
+exports.SDK_VERSION = "0.0.18";

package/dist/esm/Client.mjs

@@ -16,8 +16,8 @@ export class phenomlClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "phenoml",
-                "X-Fern-SDK-Version": "0.0.17",
-                "User-Agent": "phenoml/0.0.17",
+                "X-Fern-SDK-Version": "0.0.18",
+                "User-Agent": "phenoml/0.0.18",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/lang2Fhir/client/Client.d.mts

@@ -60,9 +60,9 @@ export declare class Lang2Fhir {
      *
      * @example
      *     await client.lang2Fhir.uploadProfile({
-     *         version: "version",
-     *         resource: "custom-patient",
-     *         profile: "profile"
+     *         version: "R4",
+     *         resource: "condition-encounter-diagnosis",
+     *         profile: "(base64 encoded JSON string of the FHIR profile)"
      *     })
      */
     uploadProfile(request: phenoml.lang2Fhir.ProfileUploadRequest, requestOptions?: Lang2Fhir.RequestOptions): core.HttpResponsePromise<phenoml.lang2Fhir.Lang2FhirUploadProfileResponse>;

package/dist/esm/api/resources/lang2Fhir/client/Client.mjs

@@ -175,9 +175,9 @@ export class Lang2Fhir {
      *
      * @example
      *     await client.lang2Fhir.uploadProfile({
-     *         version: "version",
-     *         resource: "custom-patient",
-     *         profile: "profile"
+     *         version: "R4",
+     *         resource: "condition-encounter-diagnosis",
+     *         profile: "(base64 encoded JSON string of the FHIR profile)"
      *     })
      */
     uploadProfile(request, requestOptions) {

package/dist/esm/api/resources/lang2Fhir/client/requests/ProfileUploadRequest.d.mts

@@ -1,9 +1,9 @@
 /**
  * @example
  *     {
- *         version: "version",
- *         resource: "custom-patient",
- *         profile: "profile"
+ *         version: "R4",
+ *         resource: "condition-encounter-diagnosis",
+ *         profile: "(base64 encoded JSON string of the FHIR profile)"
  *     }
  */
 export interface ProfileUploadRequest {

package/dist/esm/api/resources/summary/client/Client.d.mts

@@ -99,9 +99,10 @@ export declare class Summary {
     deleteTemplate(id: string, requestOptions?: Summary.RequestOptions): core.HttpResponsePromise<phenoml.summary.SummaryDeleteTemplateResponse>;
     private __deleteTemplate;
     /**
-     * Creates a summary from FHIR resources using one of two modes:
+     * Creates a summary from FHIR resources using one of three modes:
      * - **narrative**: Uses a template to substitute FHIR data into placeholders (requires template_id)
      * - **flatten**: Flattens FHIR resources into a searchable format for RAG/search (no template needed)
+     * - **ips**: Generates an International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG. Requires a Bundle with exactly one Patient resource (returns 400 error if no Patient or multiple Patients are present). Automatically filters resources to those referencing the patient and generates sections for allergies, medications, problems, immunizations, procedures, and vital signs.
      *
      * @param {phenoml.summary.CreateSummaryRequest} request
      * @param {Summary.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/summary/client/Client.mjs

@@ -383,9 +383,10 @@ export class Summary {
         });
     }
     /**
-     * Creates a summary from FHIR resources using one of two modes:
+     * Creates a summary from FHIR resources using one of three modes:
      * - **narrative**: Uses a template to substitute FHIR data into placeholders (requires template_id)
      * - **flatten**: Flattens FHIR resources into a searchable format for RAG/search (no template needed)
+     * - **ips**: Generates an International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG. Requires a Bundle with exactly one Patient resource (returns 400 error if no Patient or multiple Patients are present). Automatically filters resources to those referencing the patient and generates sections for allergies, medications, problems, immunizations, procedures, and vital signs.
      *
      * @param {phenoml.summary.CreateSummaryRequest} request
      * @param {Summary.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/summary/client/requests/CreateSummaryRequest.d.mts

@@ -12,11 +12,18 @@ export interface CreateSummaryRequest {
      * Summary generation mode:
      * - narrative: Substitute FHIR data into a template (requires template_id)
      * - flatten: Flatten FHIR resources for RAG/search (no template needed)
+     * - ips: Generate International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG
      */
     mode?: CreateSummaryRequest.Mode;
     /** ID of the template to use (required for narrative mode) */
     template_id?: string;
-    /** FHIR resources (single resource or Bundle) */
+    /**
+     * FHIR resources (single resource or Bundle).
+     * For IPS mode, must be a Bundle containing exactly one Patient resource with at least one
+     * identifier (id, fullUrl, or identifier field). Returns an error if no Patient is found,
+     * if multiple Patients are present, or if the Patient has no identifiers. Resources are
+     * automatically filtered to only include those referencing the patient.
+     */
     fhir_resources: CreateSummaryRequest.FhirResources;
 }
 export declare namespace CreateSummaryRequest {
@@ -24,14 +31,20 @@ export declare namespace CreateSummaryRequest {
      * Summary generation mode:
      * - narrative: Substitute FHIR data into a template (requires template_id)
      * - flatten: Flatten FHIR resources for RAG/search (no template needed)
+     * - ips: Generate International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG
      */
     const Mode: {
         readonly Narrative: "narrative";
         readonly Flatten: "flatten";
+        readonly Ips: "ips";
     };
     type Mode = (typeof Mode)[keyof typeof Mode];
     /**
-     * FHIR resources (single resource or Bundle)
+     * FHIR resources (single resource or Bundle).
+     * For IPS mode, must be a Bundle containing exactly one Patient resource with at least one
+     * identifier (id, fullUrl, or identifier field). Returns an error if no Patient is found,
+     * if multiple Patients are present, or if the Patient has no identifiers. Resources are
+     * automatically filtered to only include those referencing the patient.
      */
     type FhirResources = phenoml.summary.FhirResource | phenoml.summary.FhirBundle;
 }

package/dist/esm/api/resources/summary/client/requests/CreateSummaryRequest.mjs

@@ -5,9 +5,11 @@ export var CreateSummaryRequest;
      * Summary generation mode:
      * - narrative: Substitute FHIR data into a template (requires template_id)
      * - flatten: Flatten FHIR resources for RAG/search (no template needed)
+     * - ips: Generate International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG
      */
     CreateSummaryRequest.Mode = {
         Narrative: "narrative",
         Flatten: "flatten",
+        Ips: "ips",
     };
 })(CreateSummaryRequest || (CreateSummaryRequest = {}));

package/dist/esm/api/resources/summary/types/ErrorResponse.d.mts

@@ -0,0 +1,5 @@
+export interface ErrorResponse {
+    success?: boolean;
+    /** Error message describing what went wrong */
+    error?: string;
+}

package/dist/esm/api/resources/summary/types/ErrorResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/summary/types/index.d.mts

@@ -1,5 +1,6 @@
 export * from "./CreateSummaryResponse.mjs";
 export * from "./CreateSummaryTemplateResponse.mjs";
+export * from "./ErrorResponse.mjs";
 export * from "./FhirBundle.mjs";
 export * from "./FhirResource.mjs";
 export * from "./SummaryDeleteTemplateResponse.mjs";

package/dist/esm/api/resources/summary/types/index.mjs

@@ -1,5 +1,6 @@
 export * from "./CreateSummaryResponse.mjs";
 export * from "./CreateSummaryTemplateResponse.mjs";
+export * from "./ErrorResponse.mjs";
 export * from "./FhirBundle.mjs";
 export * from "./FhirResource.mjs";
 export * from "./SummaryDeleteTemplateResponse.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.17";
+export declare const SDK_VERSION = "0.0.18";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.0.17";
+export const SDK_VERSION = "0.0.18";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "phenoml",
-    "version": "0.0.17",
+    "version": "0.0.18",
     "private": false,
     "repository": "github:PhenoML/phenoml-ts-sdk",
     "type": "commonjs",

package/reference.md

@@ -2531,9 +2531,9 @@ Upload a custom FHIR StructureDefinition profile for use with the lang2fhir serv
 
 ```typescript
 await client.lang2Fhir.uploadProfile({
-    version: "version",
-    resource: "custom-patient",
-    profile: "profile"
+    version: "R4",
+    resource: "condition-encounter-diagnosis",
+    profile: "(base64 encoded JSON string of the FHIR profile)"
 });
 
 ```
@@ -2976,9 +2976,10 @@ await client.summary.deleteTemplate("id");
 <dl>
 <dd>
 
-Creates a summary from FHIR resources using one of two modes:
+Creates a summary from FHIR resources using one of three modes:
 - **narrative**: Uses a template to substitute FHIR data into placeholders (requires template_id)
 - **flatten**: Flattens FHIR resources into a searchable format for RAG/search (no template needed)
+- **ips**: Generates an International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG. Requires a Bundle with exactly one Patient resource (returns 400 error if no Patient or multiple Patients are present). Automatically filters resources to those referencing the patient and generates sections for allergies, medications, problems, immunizations, procedures, and vital signs.
 </dd>
 </dl>
 </dd>