phenoml 4.0.0 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -52,8 +52,8 @@ class phenomlClient {
52
52
  this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
53
53
  "X-Fern-Language": "JavaScript",
54
54
  "X-Fern-SDK-Name": "phenoml",
55
- "X-Fern-SDK-Version": "4.0.0",
56
- "User-Agent": "phenoml/4.0.0",
55
+ "X-Fern-SDK-Version": "5.0.0",
56
+ "User-Agent": "phenoml/5.0.0",
57
57
  "X-Fern-Runtime": core.RUNTIME.type,
58
58
  "X-Fern-Runtime-Version": core.RUNTIME.version,
59
59
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -7,6 +7,8 @@ export interface AgentCreateRequest {
7
7
  prompts: string[];
8
8
  /** Array of MCP server tool IDs to use for this agent */
9
9
  tools?: string[];
10
+ /** Array of workflow IDs to expose as tools for this agent */
11
+ workflows?: string[];
10
12
  /** Tags for categorizing the agent */
11
13
  tags?: string[];
12
14
  /**
@@ -9,6 +9,8 @@ export interface AgentTemplate {
9
9
  prompts?: string[];
10
10
  /** Array of MCP server tool IDs used by this agent */
11
11
  tools?: string[];
12
+ /** Array of workflow IDs exposed as tools by this agent */
13
+ workflows?: string[];
12
14
  /** Tags for categorizing the agent */
13
15
  tags?: string[];
14
16
  /** FHIR provider ID(s) - must be valid UUIDs from existing FHIR providers */
@@ -74,7 +74,16 @@ export declare class Lang2Fhir {
74
74
  search(request: phenoml.lang2Fhir.SearchRequest, requestOptions?: Lang2Fhir.RequestOptions): core.HttpResponsePromise<phenoml.lang2Fhir.SearchResponse>;
75
75
  private __search;
76
76
  /**
77
- * Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service
77
+ * Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service.
78
+ *
79
+ * All metadata is derived from the StructureDefinition JSON itself. The lowercase `id` field
80
+ * from the StructureDefinition is used as the profile's unique identifier and lookup key.
81
+ * To use the uploaded profile with `/lang2fhir/create`, pass this id as the `resource` parameter.
82
+ *
83
+ * Uploads will be rejected if:
84
+ * - A built-in US Core or R4 base profile already exists with the same id
85
+ * - A custom profile with the same id has already been uploaded
86
+ * - A custom profile with the same url has already been uploaded
78
87
  *
79
88
  * @param {phenoml.lang2Fhir.ProfileUploadRequest} request
80
89
  * @param {Lang2Fhir.RequestOptions} requestOptions - Request-specific configuration.
@@ -86,9 +95,7 @@ export declare class Lang2Fhir {
86
95
  *
87
96
  * @example
88
97
  * await client.lang2Fhir.uploadProfile({
89
- * version: "R4",
90
- * resource: "condition-encounter-diagnosis",
91
- * profile: "(base64 encoded JSON string of the FHIR profile)"
98
+ * profile: "(base64 encoded FHIR StructureDefinition JSON)"
92
99
  * })
93
100
  */
94
101
  uploadProfile(request: phenoml.lang2Fhir.ProfileUploadRequest, requestOptions?: Lang2Fhir.RequestOptions): core.HttpResponsePromise<phenoml.lang2Fhir.Lang2FhirUploadProfileResponse>;
@@ -281,7 +281,16 @@ class Lang2Fhir {
281
281
  });
282
282
  }
283
283
  /**
284
- * Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service
284
+ * Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service.
285
+ *
286
+ * All metadata is derived from the StructureDefinition JSON itself. The lowercase `id` field
287
+ * from the StructureDefinition is used as the profile's unique identifier and lookup key.
288
+ * To use the uploaded profile with `/lang2fhir/create`, pass this id as the `resource` parameter.
289
+ *
290
+ * Uploads will be rejected if:
291
+ * - A built-in US Core or R4 base profile already exists with the same id
292
+ * - A custom profile with the same id has already been uploaded
293
+ * - A custom profile with the same url has already been uploaded
285
294
  *
286
295
  * @param {phenoml.lang2Fhir.ProfileUploadRequest} request
287
296
  * @param {Lang2Fhir.RequestOptions} requestOptions - Request-specific configuration.
@@ -293,9 +302,7 @@ class Lang2Fhir {
293
302
  *
294
303
  * @example
295
304
  * await client.lang2Fhir.uploadProfile({
296
- * version: "R4",
297
- * resource: "condition-encounter-diagnosis",
298
- * profile: "(base64 encoded JSON string of the FHIR profile)"
305
+ * profile: "(base64 encoded FHIR StructureDefinition JSON)"
299
306
  * })
300
307
  */
301
308
  uploadProfile(request, requestOptions) {
@@ -1,16 +1,10 @@
1
1
  /**
2
2
  * @example
3
3
  * {
4
- * version: "R4",
5
- * resource: "condition-encounter-diagnosis",
6
- * profile: "(base64 encoded JSON string of the FHIR profile)"
4
+ * profile: "(base64 encoded FHIR StructureDefinition JSON)"
7
5
  * }
8
6
  */
9
7
  export interface ProfileUploadRequest {
10
- /** FHIR version that this profile implements */
11
- version: string;
12
- /** Name for the custom resource profile (will be converted to lowercase) */
13
- resource: string;
14
- /** Base64 encoded JSON string of the FHIR StructureDefinition profile */
8
+ /** Base64 encoded JSON string of a FHIR StructureDefinition. The profile must include id, url, type, and a snapshot with elements. All metadata (version, resource type, identifier) is derived from the StructureDefinition itself. The lowercase id from the StructureDefinition becomes the profile's lookup key. */
15
9
  profile: string;
16
10
  }
@@ -1,7 +1,9 @@
1
1
  export interface Lang2FhirUploadProfileResponse {
2
2
  message?: string;
3
+ /** The lowercase StructureDefinition id, used as the profile's unique identifier and lookup key. Pass this value as the `resource` parameter to `/lang2fhir/create` or `/lang2fhir/profile/json/:version/:resource` to use this profile. */
3
4
  id?: string;
4
- resource?: string;
5
- version?: string;
5
+ /** The FHIR resource type from the StructureDefinition */
6
+ type?: string;
7
+ /** The canonical URL from the StructureDefinition */
6
8
  url?: string;
7
9
  }
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.0.0";
1
+ export declare const SDK_VERSION = "5.0.0";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "4.0.0";
4
+ exports.SDK_VERSION = "5.0.0";
@@ -16,8 +16,8 @@ export class phenomlClient {
16
16
  this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
17
17
  "X-Fern-Language": "JavaScript",
18
18
  "X-Fern-SDK-Name": "phenoml",
19
- "X-Fern-SDK-Version": "4.0.0",
20
- "User-Agent": "phenoml/4.0.0",
19
+ "X-Fern-SDK-Version": "5.0.0",
20
+ "User-Agent": "phenoml/5.0.0",
21
21
  "X-Fern-Runtime": core.RUNTIME.type,
22
22
  "X-Fern-Runtime-Version": core.RUNTIME.version,
23
23
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -7,6 +7,8 @@ export interface AgentCreateRequest {
7
7
  prompts: string[];
8
8
  /** Array of MCP server tool IDs to use for this agent */
9
9
  tools?: string[];
10
+ /** Array of workflow IDs to expose as tools for this agent */
11
+ workflows?: string[];
10
12
  /** Tags for categorizing the agent */
11
13
  tags?: string[];
12
14
  /**
@@ -9,6 +9,8 @@ export interface AgentTemplate {
9
9
  prompts?: string[];
10
10
  /** Array of MCP server tool IDs used by this agent */
11
11
  tools?: string[];
12
+ /** Array of workflow IDs exposed as tools by this agent */
13
+ workflows?: string[];
12
14
  /** Tags for categorizing the agent */
13
15
  tags?: string[];
14
16
  /** FHIR provider ID(s) - must be valid UUIDs from existing FHIR providers */
@@ -74,7 +74,16 @@ export declare class Lang2Fhir {
74
74
  search(request: phenoml.lang2Fhir.SearchRequest, requestOptions?: Lang2Fhir.RequestOptions): core.HttpResponsePromise<phenoml.lang2Fhir.SearchResponse>;
75
75
  private __search;
76
76
  /**
77
- * Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service
77
+ * Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service.
78
+ *
79
+ * All metadata is derived from the StructureDefinition JSON itself. The lowercase `id` field
80
+ * from the StructureDefinition is used as the profile's unique identifier and lookup key.
81
+ * To use the uploaded profile with `/lang2fhir/create`, pass this id as the `resource` parameter.
82
+ *
83
+ * Uploads will be rejected if:
84
+ * - A built-in US Core or R4 base profile already exists with the same id
85
+ * - A custom profile with the same id has already been uploaded
86
+ * - A custom profile with the same url has already been uploaded
78
87
  *
79
88
  * @param {phenoml.lang2Fhir.ProfileUploadRequest} request
80
89
  * @param {Lang2Fhir.RequestOptions} requestOptions - Request-specific configuration.
@@ -86,9 +95,7 @@ export declare class Lang2Fhir {
86
95
  *
87
96
  * @example
88
97
  * await client.lang2Fhir.uploadProfile({
89
- * version: "R4",
90
- * resource: "condition-encounter-diagnosis",
91
- * profile: "(base64 encoded JSON string of the FHIR profile)"
98
+ * profile: "(base64 encoded FHIR StructureDefinition JSON)"
92
99
  * })
93
100
  */
94
101
  uploadProfile(request: phenoml.lang2Fhir.ProfileUploadRequest, requestOptions?: Lang2Fhir.RequestOptions): core.HttpResponsePromise<phenoml.lang2Fhir.Lang2FhirUploadProfileResponse>;
@@ -245,7 +245,16 @@ export class Lang2Fhir {
245
245
  });
246
246
  }
247
247
  /**
248
- * Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service
248
+ * Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service.
249
+ *
250
+ * All metadata is derived from the StructureDefinition JSON itself. The lowercase `id` field
251
+ * from the StructureDefinition is used as the profile's unique identifier and lookup key.
252
+ * To use the uploaded profile with `/lang2fhir/create`, pass this id as the `resource` parameter.
253
+ *
254
+ * Uploads will be rejected if:
255
+ * - A built-in US Core or R4 base profile already exists with the same id
256
+ * - A custom profile with the same id has already been uploaded
257
+ * - A custom profile with the same url has already been uploaded
249
258
  *
250
259
  * @param {phenoml.lang2Fhir.ProfileUploadRequest} request
251
260
  * @param {Lang2Fhir.RequestOptions} requestOptions - Request-specific configuration.
@@ -257,9 +266,7 @@ export class Lang2Fhir {
257
266
  *
258
267
  * @example
259
268
  * await client.lang2Fhir.uploadProfile({
260
- * version: "R4",
261
- * resource: "condition-encounter-diagnosis",
262
- * profile: "(base64 encoded JSON string of the FHIR profile)"
269
+ * profile: "(base64 encoded FHIR StructureDefinition JSON)"
263
270
  * })
264
271
  */
265
272
  uploadProfile(request, requestOptions) {
@@ -1,16 +1,10 @@
1
1
  /**
2
2
  * @example
3
3
  * {
4
- * version: "R4",
5
- * resource: "condition-encounter-diagnosis",
6
- * profile: "(base64 encoded JSON string of the FHIR profile)"
4
+ * profile: "(base64 encoded FHIR StructureDefinition JSON)"
7
5
  * }
8
6
  */
9
7
  export interface ProfileUploadRequest {
10
- /** FHIR version that this profile implements */
11
- version: string;
12
- /** Name for the custom resource profile (will be converted to lowercase) */
13
- resource: string;
14
- /** Base64 encoded JSON string of the FHIR StructureDefinition profile */
8
+ /** Base64 encoded JSON string of a FHIR StructureDefinition. The profile must include id, url, type, and a snapshot with elements. All metadata (version, resource type, identifier) is derived from the StructureDefinition itself. The lowercase id from the StructureDefinition becomes the profile's lookup key. */
15
9
  profile: string;
16
10
  }
@@ -1,7 +1,9 @@
1
1
  export interface Lang2FhirUploadProfileResponse {
2
2
  message?: string;
3
+ /** The lowercase StructureDefinition id, used as the profile's unique identifier and lookup key. Pass this value as the `resource` parameter to `/lang2fhir/create` or `/lang2fhir/profile/json/:version/:resource` to use this profile. */
3
4
  id?: string;
4
- resource?: string;
5
- version?: string;
5
+ /** The FHIR resource type from the StructureDefinition */
6
+ type?: string;
7
+ /** The canonical URL from the StructureDefinition */
6
8
  url?: string;
7
9
  }
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.0.0";
1
+ export declare const SDK_VERSION = "5.0.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "4.0.0";
1
+ export const SDK_VERSION = "5.0.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "phenoml",
3
- "version": "4.0.0",
3
+ "version": "5.0.0",
4
4
  "private": false,
5
5
  "repository": "github:PhenoML/phenoml-ts-sdk",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -3011,7 +3011,16 @@ await client.lang2Fhir.search({
3011
3011
  <dl>
3012
3012
  <dd>
3013
3013
 
3014
- Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service
3014
+ Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service.
3015
+
3016
+ All metadata is derived from the StructureDefinition JSON itself. The lowercase `id` field
3017
+ from the StructureDefinition is used as the profile's unique identifier and lookup key.
3018
+ To use the uploaded profile with `/lang2fhir/create`, pass this id as the `resource` parameter.
3019
+
3020
+ Uploads will be rejected if:
3021
+ - A built-in US Core or R4 base profile already exists with the same id
3022
+ - A custom profile with the same id has already been uploaded
3023
+ - A custom profile with the same url has already been uploaded
3015
3024
  </dd>
3016
3025
  </dl>
3017
3026
  </dd>
@@ -3027,9 +3036,7 @@ Upload a custom FHIR StructureDefinition profile for use with the lang2fhir serv
3027
3036
 
3028
3037
  ```typescript
3029
3038
  await client.lang2Fhir.uploadProfile({
3030
- version: "R4",
3031
- resource: "condition-encounter-diagnosis",
3032
- profile: "(base64 encoded JSON string of the FHIR profile)"
3039
+ profile: "(base64 encoded FHIR StructureDefinition JSON)"
3033
3040
  });
3034
3041
 
3035
3042
  ```