phenoml 0.0.7 → 0.0.8
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.
- package/dist/cjs/BaseClient.d.ts +3 -3
- package/dist/cjs/Client.d.ts +5 -2
- package/dist/cjs/Client.js +14 -9
- package/dist/cjs/api/resources/agent/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/agent/client/Client.js +23 -27
- package/dist/cjs/api/resources/agent/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agent/client/requests/AgentGetChatMessagesRequest.d.ts +1 -1
- package/dist/cjs/api/resources/agent/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/agent/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/agent/errors/ForbiddenError.d.ts +1 -1
- package/dist/cjs/api/resources/agent/errors/InternalServerError.d.ts +1 -1
- package/dist/cjs/api/resources/agent/errors/NotFoundError.d.ts +1 -1
- package/dist/cjs/api/resources/agent/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/resources/agent/errors/index.d.ts +1 -1
- package/dist/cjs/api/resources/agent/errors/index.js +1 -1
- package/dist/cjs/api/resources/agent/index.d.ts +3 -3
- package/dist/cjs/api/resources/agent/index.js +3 -3
- package/dist/cjs/api/resources/agent/resources/index.d.ts +1 -1
- package/dist/cjs/api/resources/agent/resources/index.js +4 -4
- package/dist/cjs/api/resources/agent/resources/prompts/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/agent/resources/prompts/client/Client.js +16 -20
- package/dist/cjs/api/resources/agent/resources/prompts/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agent/resources/prompts/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/agent/resources/prompts/index.d.ts +1 -1
- package/dist/cjs/api/resources/agent/resources/prompts/index.js +1 -1
- package/dist/cjs/api/resources/agent/resources/prompts/types/PromptsListResponse.d.ts +1 -1
- package/dist/cjs/api/resources/agent/resources/prompts/types/index.d.ts +1 -1
- package/dist/cjs/api/resources/agent/resources/prompts/types/index.js +1 -1
- package/dist/cjs/api/resources/agent/types/AgentGetChatMessagesResponse.d.ts +1 -1
- package/dist/cjs/api/resources/agent/types/AgentListResponse.d.ts +1 -1
- package/dist/cjs/api/resources/agent/types/AgentPromptsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/agent/types/AgentResponse.d.ts +1 -1
- package/dist/cjs/api/resources/agent/types/JsonPatch.d.ts +1 -1
- package/dist/cjs/api/resources/agent/types/index.d.ts +7 -7
- package/dist/cjs/api/resources/agent/types/index.js +7 -7
- package/dist/cjs/api/resources/authtoken/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/authtoken/client/Client.js +1 -1
- package/dist/cjs/api/resources/authtoken/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/authtoken/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/resources/authtoken/index.d.ts +2 -2
- package/dist/cjs/api/resources/authtoken/index.js +2 -2
- package/dist/cjs/api/resources/authtoken/resources/auth/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/authtoken/resources/auth/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/authtoken/resources/auth/index.d.ts +1 -1
- package/dist/cjs/api/resources/authtoken/resources/auth/index.js +1 -1
- package/dist/cjs/api/resources/authtoken/resources/index.d.ts +1 -1
- package/dist/cjs/api/resources/authtoken/resources/index.js +4 -4
- package/dist/cjs/api/resources/cohort/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/cohort/client/Client.js +6 -10
- package/dist/cjs/api/resources/cohort/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/cohort/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/cohort/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/cohort/errors/InternalServerError.d.ts +1 -1
- package/dist/cjs/api/resources/cohort/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/resources/cohort/errors/index.d.ts +1 -1
- package/dist/cjs/api/resources/cohort/errors/index.js +1 -1
- package/dist/cjs/api/resources/cohort/index.d.ts +2 -2
- package/dist/cjs/api/resources/cohort/index.js +2 -2
- package/dist/cjs/api/resources/cohort/types/CohortResponse.d.ts +1 -1
- package/dist/cjs/api/resources/construe/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/construe/client/Client.js +8 -12
- package/dist/cjs/api/resources/construe/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/construe/client/requests/ExtractRequest.d.ts +1 -1
- package/dist/cjs/api/resources/construe/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/construe/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/construe/errors/ConflictError.d.ts +1 -1
- package/dist/cjs/api/resources/construe/errors/FailedDependencyError.d.ts +1 -1
- package/dist/cjs/api/resources/construe/errors/InternalServerError.d.ts +1 -1
- package/dist/cjs/api/resources/construe/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/resources/construe/errors/index.d.ts +1 -1
- package/dist/cjs/api/resources/construe/errors/index.js +1 -1
- package/dist/cjs/api/resources/construe/index.d.ts +2 -2
- package/dist/cjs/api/resources/construe/index.js +2 -2
- package/dist/cjs/api/resources/construe/types/ExtractCodesResult.d.ts +1 -1
- package/dist/cjs/api/resources/construe/types/index.d.ts +6 -6
- package/dist/cjs/api/resources/construe/types/index.js +6 -6
- package/dist/cjs/api/resources/fhir/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/fhir/client/Client.js +18 -22
- package/dist/cjs/api/resources/fhir/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/fhir/client/requests/FhirCreateRequest.d.ts +1 -1
- package/dist/cjs/api/resources/fhir/client/requests/FhirExecuteBundleRequest.d.ts +1 -1
- package/dist/cjs/api/resources/fhir/client/requests/FhirPatchRequest.d.ts +1 -1
- package/dist/cjs/api/resources/fhir/client/requests/FhirUpsertRequest.d.ts +1 -1
- package/dist/cjs/api/resources/fhir/client/requests/index.d.ts +6 -6
- package/dist/cjs/api/resources/fhir/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/fhir/errors/InternalServerError.d.ts +1 -1
- package/dist/cjs/api/resources/fhir/errors/NotFoundError.d.ts +1 -1
- package/dist/cjs/api/resources/fhir/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/resources/fhir/errors/index.d.ts +2 -2
- package/dist/cjs/api/resources/fhir/errors/index.js +2 -2
- package/dist/cjs/api/resources/fhir/index.d.ts +2 -2
- package/dist/cjs/api/resources/fhir/index.js +2 -2
- package/dist/cjs/api/resources/fhir/types/FhirSearchResponse.d.ts +1 -1
- package/dist/cjs/api/resources/fhir/types/index.d.ts +3 -3
- package/dist/cjs/api/resources/fhir/types/index.js +3 -3
- package/dist/cjs/api/resources/fhirProvider/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/fhirProvider/client/Client.js +17 -21
- package/dist/cjs/api/resources/fhirProvider/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/fhirProvider/client/requests/FhirProviderAddAuthConfigRequest.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/client/requests/FhirProviderCreateRequest.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/client/requests/index.d.ts +4 -4
- package/dist/cjs/api/resources/fhirProvider/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/errors/ForbiddenError.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/errors/InternalServerError.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/errors/NotFoundError.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/errors/index.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/errors/index.js +1 -1
- package/dist/cjs/api/resources/fhirProvider/index.d.ts +2 -2
- package/dist/cjs/api/resources/fhirProvider/index.js +2 -2
- package/dist/cjs/api/resources/fhirProvider/types/FhirProviderAuthConfig.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/types/FhirProviderListResponse.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/types/FhirProviderRemoveAuthConfigResponse.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/types/FhirProviderResponse.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/types/FhirProviderSetActiveAuthConfigResponse.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/types/FhirProviderTemplate.d.ts +1 -1
- package/dist/cjs/api/resources/fhirProvider/types/index.d.ts +7 -7
- package/dist/cjs/api/resources/fhirProvider/types/index.js +7 -7
- package/dist/cjs/api/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.js +2 -1
- package/dist/cjs/api/resources/lang2Fhir/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/lang2Fhir/client/Client.js +9 -13
- package/dist/cjs/api/resources/lang2Fhir/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/lang2Fhir/client/requests/index.d.ts +4 -4
- package/dist/cjs/api/resources/lang2Fhir/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/lang2Fhir/errors/FailedDependencyError.d.ts +1 -1
- package/dist/cjs/api/resources/lang2Fhir/errors/ForbiddenError.d.ts +1 -1
- package/dist/cjs/api/resources/lang2Fhir/errors/InternalServerError.d.ts +1 -1
- package/dist/cjs/api/resources/lang2Fhir/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/resources/lang2Fhir/errors/index.d.ts +2 -2
- package/dist/cjs/api/resources/lang2Fhir/errors/index.js +2 -2
- package/dist/cjs/api/resources/lang2Fhir/index.d.ts +2 -2
- package/dist/cjs/api/resources/lang2Fhir/index.js +2 -2
- package/dist/cjs/api/resources/lang2Fhir/types/index.d.ts +1 -1
- package/dist/cjs/api/resources/lang2Fhir/types/index.js +1 -1
- package/dist/cjs/api/resources/summary/client/Client.d.ts +125 -0
- package/dist/cjs/api/resources/summary/client/Client.js +510 -0
- package/dist/cjs/api/resources/summary/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/summary/client/index.js +17 -0
- package/dist/cjs/api/resources/summary/client/requests/CreateSummaryRequest.d.ts +37 -0
- package/dist/cjs/api/resources/summary/client/requests/CreateSummaryRequest.js +16 -0
- package/dist/cjs/api/resources/summary/client/requests/CreateSummaryTemplateRequest.d.ts +23 -0
- package/dist/cjs/api/resources/summary/client/requests/CreateSummaryTemplateRequest.js +3 -0
- package/dist/cjs/api/resources/summary/client/requests/UpdateSummaryTemplateRequest.d.ts +18 -0
- package/dist/cjs/api/resources/summary/client/requests/UpdateSummaryTemplateRequest.js +3 -0
- package/dist/cjs/api/resources/summary/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/summary/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/summary/errors/BadRequestError.d.ts +5 -0
- package/dist/cjs/api/resources/summary/errors/BadRequestError.js +50 -0
- package/dist/cjs/api/resources/summary/errors/ForbiddenError.d.ts +5 -0
- package/dist/cjs/api/resources/summary/errors/ForbiddenError.js +50 -0
- package/dist/cjs/api/resources/summary/errors/InternalServerError.d.ts +5 -0
- package/dist/cjs/api/resources/summary/errors/InternalServerError.js +50 -0
- package/dist/cjs/api/resources/summary/errors/NotFoundError.d.ts +5 -0
- package/dist/cjs/api/resources/summary/errors/NotFoundError.js +50 -0
- package/dist/cjs/api/resources/summary/errors/UnauthorizedError.d.ts +5 -0
- package/dist/cjs/api/resources/summary/errors/UnauthorizedError.js +50 -0
- package/dist/cjs/api/resources/summary/errors/index.d.ts +5 -0
- package/dist/cjs/api/resources/summary/errors/index.js +21 -0
- package/dist/cjs/api/resources/summary/index.d.ts +3 -0
- package/dist/cjs/api/resources/summary/index.js +19 -0
- package/dist/cjs/api/resources/summary/types/CreateSummaryResponse.d.ts +8 -0
- package/dist/cjs/api/resources/summary/types/CreateSummaryResponse.js +3 -0
- package/dist/cjs/api/resources/summary/types/CreateSummaryTemplateResponse.d.ts +7 -0
- package/dist/cjs/api/resources/summary/types/CreateSummaryTemplateResponse.js +3 -0
- package/dist/cjs/api/resources/summary/types/FhirBundle.d.ts +13 -0
- package/dist/cjs/api/resources/summary/types/FhirBundle.js +3 -0
- package/dist/cjs/api/resources/summary/types/FhirResource.d.ts +6 -0
- package/dist/cjs/api/resources/summary/types/FhirResource.js +3 -0
- package/dist/cjs/api/resources/summary/types/SummaryDeleteTemplateResponse.d.ts +4 -0
- package/dist/cjs/api/resources/summary/types/SummaryDeleteTemplateResponse.js +3 -0
- package/dist/cjs/api/resources/summary/types/SummaryGetTemplateResponse.d.ts +5 -0
- package/dist/cjs/api/resources/summary/types/SummaryGetTemplateResponse.js +3 -0
- package/dist/cjs/api/resources/summary/types/SummaryListTemplatesResponse.d.ts +5 -0
- package/dist/cjs/api/resources/summary/types/SummaryListTemplatesResponse.js +3 -0
- package/dist/cjs/api/resources/summary/types/SummaryTemplate.d.ts +15 -0
- package/dist/cjs/api/resources/summary/types/SummaryTemplate.js +3 -0
- package/dist/cjs/api/resources/summary/types/SummaryUpdateTemplateResponse.d.ts +6 -0
- package/dist/cjs/api/resources/summary/types/SummaryUpdateTemplateResponse.js +3 -0
- package/dist/cjs/api/resources/summary/types/index.d.ts +9 -0
- package/dist/cjs/api/resources/summary/types/index.js +25 -0
- package/dist/cjs/api/resources/tools/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tools/client/Client.js +8 -12
- package/dist/cjs/api/resources/tools/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/tools/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/tools/errors/FailedDependencyError.d.ts +1 -1
- package/dist/cjs/api/resources/tools/errors/ForbiddenError.d.ts +1 -1
- package/dist/cjs/api/resources/tools/errors/InternalServerError.d.ts +1 -1
- package/dist/cjs/api/resources/tools/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/resources/tools/errors/index.d.ts +2 -2
- package/dist/cjs/api/resources/tools/errors/index.js +2 -2
- package/dist/cjs/api/resources/tools/index.d.ts +2 -2
- package/dist/cjs/api/resources/tools/index.js +2 -2
- package/dist/cjs/api/resources/tools/resources/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/index.js +4 -4
- package/dist/cjs/api/resources/tools/resources/mcpServer/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tools/resources/mcpServer/client/Client.js +11 -15
- package/dist/cjs/api/resources/tools/resources/mcpServer/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/resources/mcpServer/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/mcpServer/resources/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/mcpServer/resources/index.js +4 -4
- package/dist/cjs/api/resources/tools/resources/mcpServer/resources/tools/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tools/resources/mcpServer/resources/tools/client/Client.js +13 -17
- package/dist/cjs/api/resources/tools/resources/mcpServer/resources/tools/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/resources/mcpServer/resources/tools/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/types/CohortResponse.d.ts +1 -1
- package/dist/cjs/api/resources/tools/types/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/types/index.js +1 -1
- package/dist/cjs/api/resources/workflows/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/workflows/client/Client.js +19 -23
- package/dist/cjs/api/resources/workflows/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/workflows/client/requests/index.d.ts +5 -5
- package/dist/cjs/api/resources/workflows/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/errors/ForbiddenError.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/errors/InternalServerError.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/errors/NotFoundError.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/errors/index.d.ts +2 -2
- package/dist/cjs/api/resources/workflows/errors/index.js +2 -2
- package/dist/cjs/api/resources/workflows/index.d.ts +2 -2
- package/dist/cjs/api/resources/workflows/index.js +2 -2
- package/dist/cjs/api/resources/workflows/types/CreateWorkflowResponse.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/types/ListWorkflowsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/types/StepOperation.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/types/WorkflowDefinition.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/types/WorkflowGraph.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/types/WorkflowResponse.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/types/WorkflowStep.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/types/WorkflowsGetResponse.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/types/WorkflowsUpdateResponse.d.ts +1 -1
- package/dist/cjs/api/resources/workflows/types/index.d.ts +11 -11
- package/dist/cjs/api/resources/workflows/types/index.js +11 -11
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +1 -1
- package/dist/cjs/core/fetcher/Fetcher.js +2 -1
- package/dist/cjs/core/fetcher/getErrorResponseBody.js +2 -1
- package/dist/cjs/core/fetcher/getResponseBody.js +3 -3
- package/dist/cjs/core/fetcher/makeRequest.js +2 -2
- package/dist/cjs/core/fetcher/requestWithRetries.js +3 -3
- package/dist/cjs/core/index.d.ts +2 -2
- package/dist/cjs/core/index.js +2 -2
- package/dist/cjs/core/url/encodePathParam.d.ts +1 -0
- package/dist/cjs/core/url/encodePathParam.js +21 -0
- package/dist/cjs/core/url/index.d.ts +1 -0
- package/dist/cjs/core/url/index.js +3 -1
- package/dist/cjs/core/url/join.js +3 -3
- package/dist/cjs/errors/phenomlError.d.ts +1 -1
- package/dist/cjs/errors/phenomlError.js +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +3 -3
- package/dist/esm/BaseClient.mjs +1 -2
- package/dist/esm/Client.d.mts +5 -2
- package/dist/esm/Client.mjs +10 -6
- package/dist/esm/api/resources/agent/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/agent/client/Client.mjs +23 -27
- package/dist/esm/api/resources/agent/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agent/client/index.mjs +0 -1
- package/dist/esm/api/resources/agent/client/requests/AgentGetChatMessagesRequest.d.mts +1 -1
- package/dist/esm/api/resources/agent/client/requests/AgentGetChatMessagesRequest.mjs +1 -1
- package/dist/esm/api/resources/agent/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/agent/client/requests/index.mjs +1 -3
- package/dist/esm/api/resources/agent/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/agent/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/resources/agent/errors/ForbiddenError.d.mts +1 -1
- package/dist/esm/api/resources/agent/errors/ForbiddenError.mjs +0 -1
- package/dist/esm/api/resources/agent/errors/InternalServerError.d.mts +1 -1
- package/dist/esm/api/resources/agent/errors/InternalServerError.mjs +0 -1
- package/dist/esm/api/resources/agent/errors/NotFoundError.d.mts +1 -1
- package/dist/esm/api/resources/agent/errors/NotFoundError.mjs +0 -1
- package/dist/esm/api/resources/agent/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/resources/agent/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/resources/agent/errors/index.d.mts +1 -1
- package/dist/esm/api/resources/agent/errors/index.mjs +1 -1
- package/dist/esm/api/resources/agent/index.d.mts +3 -3
- package/dist/esm/api/resources/agent/index.mjs +3 -3
- package/dist/esm/api/resources/agent/resources/index.d.mts +1 -1
- package/dist/esm/api/resources/agent/resources/index.mjs +1 -1
- package/dist/esm/api/resources/agent/resources/prompts/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/agent/resources/prompts/client/Client.mjs +16 -20
- package/dist/esm/api/resources/agent/resources/prompts/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agent/resources/prompts/client/index.mjs +0 -1
- package/dist/esm/api/resources/agent/resources/prompts/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/agent/resources/prompts/client/requests/index.mjs +1 -2
- package/dist/esm/api/resources/agent/resources/prompts/index.d.mts +1 -1
- package/dist/esm/api/resources/agent/resources/prompts/index.mjs +1 -1
- package/dist/esm/api/resources/agent/resources/prompts/types/PromptsListResponse.d.mts +1 -1
- package/dist/esm/api/resources/agent/resources/prompts/types/PromptsListResponse.mjs +1 -1
- package/dist/esm/api/resources/agent/resources/prompts/types/index.d.mts +1 -1
- package/dist/esm/api/resources/agent/resources/prompts/types/index.mjs +1 -1
- package/dist/esm/api/resources/agent/types/AgentGetChatMessagesResponse.d.mts +1 -1
- package/dist/esm/api/resources/agent/types/AgentGetChatMessagesResponse.mjs +1 -1
- package/dist/esm/api/resources/agent/types/AgentListResponse.d.mts +1 -1
- package/dist/esm/api/resources/agent/types/AgentListResponse.mjs +1 -1
- package/dist/esm/api/resources/agent/types/AgentPromptsResponse.d.mts +1 -1
- package/dist/esm/api/resources/agent/types/AgentPromptsResponse.mjs +1 -1
- package/dist/esm/api/resources/agent/types/AgentResponse.d.mts +1 -1
- package/dist/esm/api/resources/agent/types/AgentResponse.mjs +1 -1
- package/dist/esm/api/resources/agent/types/JsonPatch.d.mts +1 -1
- package/dist/esm/api/resources/agent/types/JsonPatch.mjs +1 -1
- package/dist/esm/api/resources/agent/types/index.d.mts +7 -7
- package/dist/esm/api/resources/agent/types/index.mjs +7 -7
- package/dist/esm/api/resources/authtoken/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/authtoken/client/Client.mjs +1 -3
- package/dist/esm/api/resources/authtoken/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/authtoken/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/resources/authtoken/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/resources/authtoken/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/resources/authtoken/index.d.mts +2 -2
- package/dist/esm/api/resources/authtoken/index.mjs +2 -2
- package/dist/esm/api/resources/authtoken/resources/auth/client/index.d.mts +0 -1
- package/dist/esm/api/resources/authtoken/resources/auth/client/index.mjs +0 -1
- package/dist/esm/api/resources/authtoken/resources/auth/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/authtoken/resources/auth/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/authtoken/resources/auth/index.d.mts +1 -1
- package/dist/esm/api/resources/authtoken/resources/auth/index.mjs +1 -1
- package/dist/esm/api/resources/authtoken/resources/index.d.mts +1 -1
- package/dist/esm/api/resources/authtoken/resources/index.mjs +1 -1
- package/dist/esm/api/resources/cohort/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/cohort/client/Client.mjs +6 -10
- package/dist/esm/api/resources/cohort/client/index.d.mts +0 -1
- package/dist/esm/api/resources/cohort/client/index.mjs +0 -1
- package/dist/esm/api/resources/cohort/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/cohort/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/cohort/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/cohort/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/resources/cohort/errors/InternalServerError.d.mts +1 -1
- package/dist/esm/api/resources/cohort/errors/InternalServerError.mjs +0 -1
- package/dist/esm/api/resources/cohort/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/resources/cohort/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/resources/cohort/errors/index.d.mts +1 -1
- package/dist/esm/api/resources/cohort/errors/index.mjs +1 -1
- package/dist/esm/api/resources/cohort/index.d.mts +2 -2
- package/dist/esm/api/resources/cohort/index.mjs +2 -2
- package/dist/esm/api/resources/cohort/types/CohortResponse.d.mts +1 -1
- package/dist/esm/api/resources/cohort/types/CohortResponse.mjs +1 -1
- package/dist/esm/api/resources/construe/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/construe/client/Client.mjs +8 -12
- package/dist/esm/api/resources/construe/client/index.d.mts +0 -1
- package/dist/esm/api/resources/construe/client/index.mjs +0 -1
- package/dist/esm/api/resources/construe/client/requests/ExtractRequest.d.mts +1 -1
- package/dist/esm/api/resources/construe/client/requests/ExtractRequest.mjs +1 -1
- package/dist/esm/api/resources/construe/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/construe/client/requests/index.mjs +1 -3
- package/dist/esm/api/resources/construe/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/construe/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/resources/construe/errors/ConflictError.d.mts +1 -1
- package/dist/esm/api/resources/construe/errors/ConflictError.mjs +0 -1
- package/dist/esm/api/resources/construe/errors/FailedDependencyError.d.mts +1 -1
- package/dist/esm/api/resources/construe/errors/FailedDependencyError.mjs +0 -1
- package/dist/esm/api/resources/construe/errors/InternalServerError.d.mts +1 -1
- package/dist/esm/api/resources/construe/errors/InternalServerError.mjs +0 -1
- package/dist/esm/api/resources/construe/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/resources/construe/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/resources/construe/errors/index.d.mts +1 -1
- package/dist/esm/api/resources/construe/errors/index.mjs +1 -1
- package/dist/esm/api/resources/construe/index.d.mts +2 -2
- package/dist/esm/api/resources/construe/index.mjs +2 -2
- package/dist/esm/api/resources/construe/types/ExtractCodesResult.d.mts +1 -1
- package/dist/esm/api/resources/construe/types/ExtractCodesResult.mjs +1 -1
- package/dist/esm/api/resources/construe/types/index.d.mts +6 -6
- package/dist/esm/api/resources/construe/types/index.mjs +6 -6
- package/dist/esm/api/resources/fhir/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/fhir/client/Client.mjs +18 -22
- package/dist/esm/api/resources/fhir/client/index.d.mts +0 -1
- package/dist/esm/api/resources/fhir/client/index.mjs +0 -1
- package/dist/esm/api/resources/fhir/client/requests/FhirCreateRequest.d.mts +1 -1
- package/dist/esm/api/resources/fhir/client/requests/FhirCreateRequest.mjs +1 -1
- package/dist/esm/api/resources/fhir/client/requests/FhirExecuteBundleRequest.d.mts +1 -1
- package/dist/esm/api/resources/fhir/client/requests/FhirExecuteBundleRequest.mjs +1 -1
- package/dist/esm/api/resources/fhir/client/requests/FhirPatchRequest.d.mts +1 -1
- package/dist/esm/api/resources/fhir/client/requests/FhirPatchRequest.mjs +1 -1
- package/dist/esm/api/resources/fhir/client/requests/FhirUpsertRequest.d.mts +1 -1
- package/dist/esm/api/resources/fhir/client/requests/FhirUpsertRequest.mjs +1 -1
- package/dist/esm/api/resources/fhir/client/requests/index.d.mts +6 -6
- package/dist/esm/api/resources/fhir/client/requests/index.mjs +1 -6
- package/dist/esm/api/resources/fhir/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/fhir/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/resources/fhir/errors/InternalServerError.d.mts +1 -1
- package/dist/esm/api/resources/fhir/errors/InternalServerError.mjs +0 -1
- package/dist/esm/api/resources/fhir/errors/NotFoundError.d.mts +1 -1
- package/dist/esm/api/resources/fhir/errors/NotFoundError.mjs +0 -1
- package/dist/esm/api/resources/fhir/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/resources/fhir/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/resources/fhir/errors/index.d.mts +2 -2
- package/dist/esm/api/resources/fhir/errors/index.mjs +2 -2
- package/dist/esm/api/resources/fhir/index.d.mts +2 -2
- package/dist/esm/api/resources/fhir/index.mjs +2 -2
- package/dist/esm/api/resources/fhir/types/FhirSearchResponse.d.mts +1 -1
- package/dist/esm/api/resources/fhir/types/FhirSearchResponse.mjs +1 -1
- package/dist/esm/api/resources/fhir/types/index.d.mts +3 -3
- package/dist/esm/api/resources/fhir/types/index.mjs +3 -3
- package/dist/esm/api/resources/fhirProvider/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/fhirProvider/client/Client.mjs +17 -21
- package/dist/esm/api/resources/fhirProvider/client/index.d.mts +0 -1
- package/dist/esm/api/resources/fhirProvider/client/index.mjs +0 -1
- package/dist/esm/api/resources/fhirProvider/client/requests/FhirProviderAddAuthConfigRequest.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/client/requests/FhirProviderAddAuthConfigRequest.mjs +1 -1
- package/dist/esm/api/resources/fhirProvider/client/requests/FhirProviderCreateRequest.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/client/requests/FhirProviderCreateRequest.mjs +1 -1
- package/dist/esm/api/resources/fhirProvider/client/requests/index.d.mts +4 -4
- package/dist/esm/api/resources/fhirProvider/client/requests/index.mjs +1 -4
- package/dist/esm/api/resources/fhirProvider/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/resources/fhirProvider/errors/ForbiddenError.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/errors/ForbiddenError.mjs +0 -1
- package/dist/esm/api/resources/fhirProvider/errors/InternalServerError.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/errors/InternalServerError.mjs +0 -1
- package/dist/esm/api/resources/fhirProvider/errors/NotFoundError.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/errors/NotFoundError.mjs +0 -1
- package/dist/esm/api/resources/fhirProvider/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/resources/fhirProvider/errors/index.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/errors/index.mjs +1 -1
- package/dist/esm/api/resources/fhirProvider/index.d.mts +2 -2
- package/dist/esm/api/resources/fhirProvider/index.mjs +2 -2
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderAuthConfig.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderAuthConfig.mjs +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderListResponse.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderListResponse.mjs +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderRemoveAuthConfigResponse.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderRemoveAuthConfigResponse.mjs +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderResponse.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderResponse.mjs +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderSetActiveAuthConfigResponse.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderSetActiveAuthConfigResponse.mjs +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderTemplate.d.mts +1 -1
- package/dist/esm/api/resources/fhirProvider/types/FhirProviderTemplate.mjs +1 -1
- package/dist/esm/api/resources/fhirProvider/types/index.d.mts +7 -7
- package/dist/esm/api/resources/fhirProvider/types/index.mjs +7 -7
- package/dist/esm/api/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/index.mjs +1 -0
- package/dist/esm/api/resources/lang2Fhir/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/lang2Fhir/client/Client.mjs +9 -13
- package/dist/esm/api/resources/lang2Fhir/client/index.d.mts +0 -1
- package/dist/esm/api/resources/lang2Fhir/client/index.mjs +0 -1
- package/dist/esm/api/resources/lang2Fhir/client/requests/index.d.mts +4 -4
- package/dist/esm/api/resources/lang2Fhir/client/requests/index.mjs +1 -4
- package/dist/esm/api/resources/lang2Fhir/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/lang2Fhir/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/resources/lang2Fhir/errors/FailedDependencyError.d.mts +1 -1
- package/dist/esm/api/resources/lang2Fhir/errors/FailedDependencyError.mjs +0 -1
- package/dist/esm/api/resources/lang2Fhir/errors/ForbiddenError.d.mts +1 -1
- package/dist/esm/api/resources/lang2Fhir/errors/ForbiddenError.mjs +0 -1
- package/dist/esm/api/resources/lang2Fhir/errors/InternalServerError.d.mts +1 -1
- package/dist/esm/api/resources/lang2Fhir/errors/InternalServerError.mjs +0 -1
- package/dist/esm/api/resources/lang2Fhir/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/resources/lang2Fhir/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/resources/lang2Fhir/errors/index.d.mts +2 -2
- package/dist/esm/api/resources/lang2Fhir/errors/index.mjs +2 -2
- package/dist/esm/api/resources/lang2Fhir/index.d.mts +2 -2
- package/dist/esm/api/resources/lang2Fhir/index.mjs +2 -2
- package/dist/esm/api/resources/lang2Fhir/types/index.d.mts +1 -1
- package/dist/esm/api/resources/lang2Fhir/types/index.mjs +1 -1
- package/dist/esm/api/resources/summary/client/Client.d.mts +125 -0
- package/dist/esm/api/resources/summary/client/Client.mjs +473 -0
- package/dist/esm/api/resources/summary/client/index.d.mts +1 -0
- package/dist/esm/api/resources/summary/client/index.mjs +1 -0
- package/dist/esm/api/resources/summary/client/requests/CreateSummaryRequest.d.mts +37 -0
- package/dist/esm/api/resources/summary/client/requests/CreateSummaryRequest.mjs +13 -0
- package/dist/esm/api/resources/summary/client/requests/CreateSummaryTemplateRequest.d.mts +23 -0
- package/dist/esm/api/resources/summary/client/requests/CreateSummaryTemplateRequest.mjs +2 -0
- package/dist/esm/api/resources/summary/client/requests/UpdateSummaryTemplateRequest.d.mts +18 -0
- package/dist/esm/api/resources/summary/client/requests/UpdateSummaryTemplateRequest.mjs +2 -0
- package/dist/esm/api/resources/summary/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/summary/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/summary/errors/BadRequestError.d.mts +5 -0
- package/dist/esm/api/resources/summary/errors/BadRequestError.mjs +13 -0
- package/dist/esm/api/resources/summary/errors/ForbiddenError.d.mts +5 -0
- package/dist/esm/api/resources/summary/errors/ForbiddenError.mjs +13 -0
- package/dist/esm/api/resources/summary/errors/InternalServerError.d.mts +5 -0
- package/dist/esm/api/resources/summary/errors/InternalServerError.mjs +13 -0
- package/dist/esm/api/resources/summary/errors/NotFoundError.d.mts +5 -0
- package/dist/esm/api/resources/summary/errors/NotFoundError.mjs +13 -0
- package/dist/esm/api/resources/summary/errors/UnauthorizedError.d.mts +5 -0
- package/dist/esm/api/resources/summary/errors/UnauthorizedError.mjs +13 -0
- package/dist/esm/api/resources/summary/errors/index.d.mts +5 -0
- package/dist/esm/api/resources/summary/errors/index.mjs +5 -0
- package/dist/esm/api/resources/summary/index.d.mts +3 -0
- package/dist/esm/api/resources/summary/index.mjs +3 -0
- package/dist/esm/api/resources/summary/types/CreateSummaryResponse.d.mts +8 -0
- package/dist/esm/api/resources/summary/types/CreateSummaryResponse.mjs +2 -0
- package/dist/esm/api/resources/summary/types/CreateSummaryTemplateResponse.d.mts +7 -0
- package/dist/esm/api/resources/summary/types/CreateSummaryTemplateResponse.mjs +2 -0
- package/dist/esm/api/resources/summary/types/FhirBundle.d.mts +13 -0
- package/dist/esm/api/resources/summary/types/FhirBundle.mjs +2 -0
- package/dist/esm/api/resources/summary/types/FhirResource.d.mts +6 -0
- package/dist/esm/api/resources/summary/types/FhirResource.mjs +2 -0
- package/dist/esm/api/resources/summary/types/SummaryDeleteTemplateResponse.d.mts +4 -0
- package/dist/esm/api/resources/summary/types/SummaryDeleteTemplateResponse.mjs +2 -0
- package/dist/esm/api/resources/summary/types/SummaryGetTemplateResponse.d.mts +5 -0
- package/dist/esm/api/resources/summary/types/SummaryGetTemplateResponse.mjs +2 -0
- package/dist/esm/api/resources/summary/types/SummaryListTemplatesResponse.d.mts +5 -0
- package/dist/esm/api/resources/summary/types/SummaryListTemplatesResponse.mjs +2 -0
- package/dist/esm/api/resources/summary/types/SummaryTemplate.d.mts +15 -0
- package/dist/esm/api/resources/summary/types/SummaryTemplate.mjs +2 -0
- package/dist/esm/api/resources/summary/types/SummaryUpdateTemplateResponse.d.mts +6 -0
- package/dist/esm/api/resources/summary/types/SummaryUpdateTemplateResponse.mjs +2 -0
- package/dist/esm/api/resources/summary/types/index.d.mts +9 -0
- package/dist/esm/api/resources/summary/types/index.mjs +9 -0
- package/dist/esm/api/resources/tools/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tools/client/Client.mjs +8 -12
- package/dist/esm/api/resources/tools/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/client/index.mjs +0 -1
- package/dist/esm/api/resources/tools/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/tools/client/requests/index.mjs +1 -3
- package/dist/esm/api/resources/tools/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/tools/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/resources/tools/errors/FailedDependencyError.d.mts +1 -1
- package/dist/esm/api/resources/tools/errors/FailedDependencyError.mjs +0 -1
- package/dist/esm/api/resources/tools/errors/ForbiddenError.d.mts +1 -1
- package/dist/esm/api/resources/tools/errors/ForbiddenError.mjs +0 -1
- package/dist/esm/api/resources/tools/errors/InternalServerError.d.mts +1 -1
- package/dist/esm/api/resources/tools/errors/InternalServerError.mjs +0 -1
- package/dist/esm/api/resources/tools/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/resources/tools/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/resources/tools/errors/index.d.mts +2 -2
- package/dist/esm/api/resources/tools/errors/index.mjs +2 -2
- package/dist/esm/api/resources/tools/index.d.mts +2 -2
- package/dist/esm/api/resources/tools/index.mjs +2 -2
- package/dist/esm/api/resources/tools/resources/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/index.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tools/resources/mcpServer/client/Client.mjs +11 -15
- package/dist/esm/api/resources/tools/resources/mcpServer/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/client/index.mjs +0 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/resources/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/resources/index.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/resources/tools/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tools/resources/mcpServer/resources/tools/client/Client.mjs +13 -17
- package/dist/esm/api/resources/tools/resources/mcpServer/resources/tools/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/resources/tools/client/index.mjs +0 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/resources/tools/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/mcpServer/resources/tools/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/tools/types/CohortResponse.d.mts +1 -1
- package/dist/esm/api/resources/tools/types/CohortResponse.mjs +1 -1
- package/dist/esm/api/resources/tools/types/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/types/index.mjs +1 -1
- package/dist/esm/api/resources/workflows/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/workflows/client/Client.mjs +19 -23
- package/dist/esm/api/resources/workflows/client/index.d.mts +0 -1
- package/dist/esm/api/resources/workflows/client/index.mjs +0 -1
- package/dist/esm/api/resources/workflows/client/requests/index.d.mts +5 -5
- package/dist/esm/api/resources/workflows/client/requests/index.mjs +1 -5
- package/dist/esm/api/resources/workflows/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/workflows/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/resources/workflows/errors/ForbiddenError.d.mts +1 -1
- package/dist/esm/api/resources/workflows/errors/ForbiddenError.mjs +0 -1
- package/dist/esm/api/resources/workflows/errors/InternalServerError.d.mts +1 -1
- package/dist/esm/api/resources/workflows/errors/InternalServerError.mjs +0 -1
- package/dist/esm/api/resources/workflows/errors/NotFoundError.d.mts +1 -1
- package/dist/esm/api/resources/workflows/errors/NotFoundError.mjs +0 -1
- package/dist/esm/api/resources/workflows/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/resources/workflows/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/resources/workflows/errors/index.d.mts +2 -2
- package/dist/esm/api/resources/workflows/errors/index.mjs +2 -2
- package/dist/esm/api/resources/workflows/index.d.mts +2 -2
- package/dist/esm/api/resources/workflows/index.mjs +2 -2
- package/dist/esm/api/resources/workflows/types/CreateWorkflowResponse.d.mts +1 -1
- package/dist/esm/api/resources/workflows/types/CreateWorkflowResponse.mjs +1 -1
- package/dist/esm/api/resources/workflows/types/ListWorkflowsResponse.d.mts +1 -1
- package/dist/esm/api/resources/workflows/types/ListWorkflowsResponse.mjs +1 -1
- package/dist/esm/api/resources/workflows/types/StepOperation.d.mts +1 -1
- package/dist/esm/api/resources/workflows/types/StepOperation.mjs +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowDefinition.d.mts +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowDefinition.mjs +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowGraph.d.mts +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowGraph.mjs +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowResponse.d.mts +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowResponse.mjs +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowStep.d.mts +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowStep.mjs +0 -1
- package/dist/esm/api/resources/workflows/types/WorkflowsGetResponse.d.mts +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowsGetResponse.mjs +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowsUpdateResponse.d.mts +1 -1
- package/dist/esm/api/resources/workflows/types/WorkflowsUpdateResponse.mjs +1 -1
- package/dist/esm/api/resources/workflows/types/index.d.mts +11 -11
- package/dist/esm/api/resources/workflows/types/index.mjs +11 -11
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +1 -1
- package/dist/esm/core/fetcher/EndpointSupplier.mjs +0 -1
- package/dist/esm/core/fetcher/Fetcher.mjs +2 -1
- package/dist/esm/core/fetcher/getErrorResponseBody.mjs +2 -1
- package/dist/esm/core/fetcher/getResponseBody.mjs +3 -3
- package/dist/esm/core/fetcher/makeRequest.mjs +2 -2
- package/dist/esm/core/fetcher/requestWithRetries.mjs +3 -3
- package/dist/esm/core/index.d.mts +2 -2
- package/dist/esm/core/index.mjs +2 -2
- package/dist/esm/core/url/encodePathParam.d.mts +1 -0
- package/dist/esm/core/url/encodePathParam.mjs +18 -0
- package/dist/esm/core/url/index.d.mts +1 -0
- package/dist/esm/core/url/index.mjs +1 -0
- package/dist/esm/core/url/join.mjs +3 -3
- package/dist/esm/errors/phenomlError.d.mts +1 -1
- package/dist/esm/errors/phenomlError.mjs +1 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +16 -15
- package/reference.md +829 -465
package/reference.md
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
|
|
3
2
|
## Agent
|
|
4
|
-
|
|
5
3
|
<details><summary><code>client.agent.<a href="/src/api/resources/agent/client/Client.ts">create</a>({ ...params }) -> phenoml.AgentResponse</code></summary>
|
|
6
4
|
<dl>
|
|
7
5
|
<dd>
|
|
@@ -15,7 +13,6 @@
|
|
|
15
13
|
<dd>
|
|
16
14
|
|
|
17
15
|
Creates a new PhenoAgent with specified configuration
|
|
18
|
-
|
|
19
16
|
</dd>
|
|
20
17
|
</dl>
|
|
21
18
|
</dd>
|
|
@@ -33,10 +30,10 @@ Creates a new PhenoAgent with specified configuration
|
|
|
33
30
|
await client.agent.create({
|
|
34
31
|
name: "name",
|
|
35
32
|
prompts: ["prompt_123", "prompt_456"],
|
|
36
|
-
is_active: true
|
|
33
|
+
is_active: true
|
|
37
34
|
});
|
|
38
|
-
```
|
|
39
35
|
|
|
36
|
+
```
|
|
40
37
|
</dd>
|
|
41
38
|
</dl>
|
|
42
39
|
</dd>
|
|
@@ -50,21 +47,22 @@ await client.agent.create({
|
|
|
50
47
|
<dl>
|
|
51
48
|
<dd>
|
|
52
49
|
|
|
53
|
-
**request:** `phenoml.AgentCreateRequest`
|
|
54
|
-
|
|
50
|
+
**request:** `phenoml.AgentCreateRequest`
|
|
51
|
+
|
|
55
52
|
</dd>
|
|
56
53
|
</dl>
|
|
57
54
|
|
|
58
55
|
<dl>
|
|
59
56
|
<dd>
|
|
60
57
|
|
|
61
|
-
**requestOptions:** `Agent.RequestOptions`
|
|
62
|
-
|
|
58
|
+
**requestOptions:** `Agent.RequestOptions`
|
|
59
|
+
|
|
63
60
|
</dd>
|
|
64
61
|
</dl>
|
|
65
62
|
</dd>
|
|
66
63
|
</dl>
|
|
67
64
|
|
|
65
|
+
|
|
68
66
|
</dd>
|
|
69
67
|
</dl>
|
|
70
68
|
</details>
|
|
@@ -82,7 +80,6 @@ await client.agent.create({
|
|
|
82
80
|
<dd>
|
|
83
81
|
|
|
84
82
|
Retrieves a list of PhenoAgents belonging to the authenticated user
|
|
85
|
-
|
|
86
83
|
</dd>
|
|
87
84
|
</dl>
|
|
88
85
|
</dd>
|
|
@@ -99,10 +96,10 @@ Retrieves a list of PhenoAgents belonging to the authenticated user
|
|
|
99
96
|
```typescript
|
|
100
97
|
await client.agent.list({
|
|
101
98
|
is_active: true,
|
|
102
|
-
tags: "tags"
|
|
99
|
+
tags: "tags"
|
|
103
100
|
});
|
|
104
|
-
```
|
|
105
101
|
|
|
102
|
+
```
|
|
106
103
|
</dd>
|
|
107
104
|
</dl>
|
|
108
105
|
</dd>
|
|
@@ -116,21 +113,22 @@ await client.agent.list({
|
|
|
116
113
|
<dl>
|
|
117
114
|
<dd>
|
|
118
115
|
|
|
119
|
-
**request:** `phenoml.agent.AgentListRequest`
|
|
120
|
-
|
|
116
|
+
**request:** `phenoml.agent.AgentListRequest`
|
|
117
|
+
|
|
121
118
|
</dd>
|
|
122
119
|
</dl>
|
|
123
120
|
|
|
124
121
|
<dl>
|
|
125
122
|
<dd>
|
|
126
123
|
|
|
127
|
-
**requestOptions:** `Agent.RequestOptions`
|
|
128
|
-
|
|
124
|
+
**requestOptions:** `Agent.RequestOptions`
|
|
125
|
+
|
|
129
126
|
</dd>
|
|
130
127
|
</dl>
|
|
131
128
|
</dd>
|
|
132
129
|
</dl>
|
|
133
130
|
|
|
131
|
+
|
|
134
132
|
</dd>
|
|
135
133
|
</dl>
|
|
136
134
|
</details>
|
|
@@ -148,7 +146,6 @@ await client.agent.list({
|
|
|
148
146
|
<dd>
|
|
149
147
|
|
|
150
148
|
Retrieves a specific agent by its ID
|
|
151
|
-
|
|
152
149
|
</dd>
|
|
153
150
|
</dl>
|
|
154
151
|
</dd>
|
|
@@ -164,8 +161,8 @@ Retrieves a specific agent by its ID
|
|
|
164
161
|
|
|
165
162
|
```typescript
|
|
166
163
|
await client.agent.get("id");
|
|
167
|
-
```
|
|
168
164
|
|
|
165
|
+
```
|
|
169
166
|
</dd>
|
|
170
167
|
</dl>
|
|
171
168
|
</dd>
|
|
@@ -180,20 +177,21 @@ await client.agent.get("id");
|
|
|
180
177
|
<dd>
|
|
181
178
|
|
|
182
179
|
**id:** `string` — Agent ID
|
|
183
|
-
|
|
180
|
+
|
|
184
181
|
</dd>
|
|
185
182
|
</dl>
|
|
186
183
|
|
|
187
184
|
<dl>
|
|
188
185
|
<dd>
|
|
189
186
|
|
|
190
|
-
**requestOptions:** `Agent.RequestOptions`
|
|
191
|
-
|
|
187
|
+
**requestOptions:** `Agent.RequestOptions`
|
|
188
|
+
|
|
192
189
|
</dd>
|
|
193
190
|
</dl>
|
|
194
191
|
</dd>
|
|
195
192
|
</dl>
|
|
196
193
|
|
|
194
|
+
|
|
197
195
|
</dd>
|
|
198
196
|
</dl>
|
|
199
197
|
</details>
|
|
@@ -211,7 +209,6 @@ await client.agent.get("id");
|
|
|
211
209
|
<dd>
|
|
212
210
|
|
|
213
211
|
Updates an existing agent's configuration
|
|
214
|
-
|
|
215
212
|
</dd>
|
|
216
213
|
</dl>
|
|
217
214
|
</dd>
|
|
@@ -229,10 +226,10 @@ Updates an existing agent's configuration
|
|
|
229
226
|
await client.agent.update("id", {
|
|
230
227
|
name: "name",
|
|
231
228
|
prompts: ["prompt_123", "prompt_456"],
|
|
232
|
-
is_active: true
|
|
229
|
+
is_active: true
|
|
233
230
|
});
|
|
234
|
-
```
|
|
235
231
|
|
|
232
|
+
```
|
|
236
233
|
</dd>
|
|
237
234
|
</dl>
|
|
238
235
|
</dd>
|
|
@@ -247,28 +244,29 @@ await client.agent.update("id", {
|
|
|
247
244
|
<dd>
|
|
248
245
|
|
|
249
246
|
**id:** `string` — Agent ID
|
|
250
|
-
|
|
247
|
+
|
|
251
248
|
</dd>
|
|
252
249
|
</dl>
|
|
253
250
|
|
|
254
251
|
<dl>
|
|
255
252
|
<dd>
|
|
256
253
|
|
|
257
|
-
**request:** `phenoml.AgentCreateRequest`
|
|
258
|
-
|
|
254
|
+
**request:** `phenoml.AgentCreateRequest`
|
|
255
|
+
|
|
259
256
|
</dd>
|
|
260
257
|
</dl>
|
|
261
258
|
|
|
262
259
|
<dl>
|
|
263
260
|
<dd>
|
|
264
261
|
|
|
265
|
-
**requestOptions:** `Agent.RequestOptions`
|
|
266
|
-
|
|
262
|
+
**requestOptions:** `Agent.RequestOptions`
|
|
263
|
+
|
|
267
264
|
</dd>
|
|
268
265
|
</dl>
|
|
269
266
|
</dd>
|
|
270
267
|
</dl>
|
|
271
268
|
|
|
269
|
+
|
|
272
270
|
</dd>
|
|
273
271
|
</dl>
|
|
274
272
|
</details>
|
|
@@ -286,7 +284,6 @@ await client.agent.update("id", {
|
|
|
286
284
|
<dd>
|
|
287
285
|
|
|
288
286
|
Deletes an existing agent
|
|
289
|
-
|
|
290
287
|
</dd>
|
|
291
288
|
</dl>
|
|
292
289
|
</dd>
|
|
@@ -302,8 +299,8 @@ Deletes an existing agent
|
|
|
302
299
|
|
|
303
300
|
```typescript
|
|
304
301
|
await client.agent.delete("id");
|
|
305
|
-
```
|
|
306
302
|
|
|
303
|
+
```
|
|
307
304
|
</dd>
|
|
308
305
|
</dl>
|
|
309
306
|
</dd>
|
|
@@ -318,20 +315,21 @@ await client.agent.delete("id");
|
|
|
318
315
|
<dd>
|
|
319
316
|
|
|
320
317
|
**id:** `string` — Agent ID
|
|
321
|
-
|
|
318
|
+
|
|
322
319
|
</dd>
|
|
323
320
|
</dl>
|
|
324
321
|
|
|
325
322
|
<dl>
|
|
326
323
|
<dd>
|
|
327
324
|
|
|
328
|
-
**requestOptions:** `Agent.RequestOptions`
|
|
329
|
-
|
|
325
|
+
**requestOptions:** `Agent.RequestOptions`
|
|
326
|
+
|
|
330
327
|
</dd>
|
|
331
328
|
</dl>
|
|
332
329
|
</dd>
|
|
333
330
|
</dl>
|
|
334
331
|
|
|
332
|
+
|
|
335
333
|
</dd>
|
|
336
334
|
</dl>
|
|
337
335
|
</details>
|
|
@@ -349,7 +347,6 @@ await client.agent.delete("id");
|
|
|
349
347
|
<dd>
|
|
350
348
|
|
|
351
349
|
Patches an existing agent's configuration
|
|
352
|
-
|
|
353
350
|
</dd>
|
|
354
351
|
</dl>
|
|
355
352
|
</dd>
|
|
@@ -364,24 +361,20 @@ Patches an existing agent's configuration
|
|
|
364
361
|
<dd>
|
|
365
362
|
|
|
366
363
|
```typescript
|
|
367
|
-
await client.agent.patch("id", [
|
|
368
|
-
{
|
|
364
|
+
await client.agent.patch("id", [{
|
|
369
365
|
op: "replace",
|
|
370
366
|
path: "/name",
|
|
371
|
-
value: "Updated Agent Name"
|
|
372
|
-
},
|
|
373
|
-
{
|
|
367
|
+
value: "Updated Agent Name"
|
|
368
|
+
}, {
|
|
374
369
|
op: "add",
|
|
375
370
|
path: "/tags/-",
|
|
376
|
-
value: "new-tag"
|
|
377
|
-
},
|
|
378
|
-
{
|
|
371
|
+
value: "new-tag"
|
|
372
|
+
}, {
|
|
379
373
|
op: "remove",
|
|
380
|
-
path: "/description"
|
|
381
|
-
}
|
|
382
|
-
]);
|
|
383
|
-
```
|
|
374
|
+
path: "/description"
|
|
375
|
+
}]);
|
|
384
376
|
|
|
377
|
+
```
|
|
385
378
|
</dd>
|
|
386
379
|
</dl>
|
|
387
380
|
</dd>
|
|
@@ -396,28 +389,29 @@ await client.agent.patch("id", [
|
|
|
396
389
|
<dd>
|
|
397
390
|
|
|
398
391
|
**id:** `string` — Agent ID
|
|
399
|
-
|
|
392
|
+
|
|
400
393
|
</dd>
|
|
401
394
|
</dl>
|
|
402
395
|
|
|
403
396
|
<dl>
|
|
404
397
|
<dd>
|
|
405
398
|
|
|
406
|
-
**request:** `phenoml.JsonPatch`
|
|
407
|
-
|
|
399
|
+
**request:** `phenoml.JsonPatch`
|
|
400
|
+
|
|
408
401
|
</dd>
|
|
409
402
|
</dl>
|
|
410
403
|
|
|
411
404
|
<dl>
|
|
412
405
|
<dd>
|
|
413
406
|
|
|
414
|
-
**requestOptions:** `Agent.RequestOptions`
|
|
415
|
-
|
|
407
|
+
**requestOptions:** `Agent.RequestOptions`
|
|
408
|
+
|
|
416
409
|
</dd>
|
|
417
410
|
</dl>
|
|
418
411
|
</dd>
|
|
419
412
|
</dl>
|
|
420
413
|
|
|
414
|
+
|
|
421
415
|
</dd>
|
|
422
416
|
</dl>
|
|
423
417
|
</details>
|
|
@@ -435,7 +429,6 @@ await client.agent.patch("id", [
|
|
|
435
429
|
<dd>
|
|
436
430
|
|
|
437
431
|
Send a message to an agent and receive a response
|
|
438
|
-
|
|
439
432
|
</dd>
|
|
440
433
|
</dl>
|
|
441
434
|
</dd>
|
|
@@ -452,10 +445,10 @@ Send a message to an agent and receive a response
|
|
|
452
445
|
```typescript
|
|
453
446
|
await client.agent.chat({
|
|
454
447
|
message: "What is the patient's current condition?",
|
|
455
|
-
agent_id: "agent-123"
|
|
448
|
+
agent_id: "agent-123"
|
|
456
449
|
});
|
|
457
|
-
```
|
|
458
450
|
|
|
451
|
+
```
|
|
459
452
|
</dd>
|
|
460
453
|
</dl>
|
|
461
454
|
</dd>
|
|
@@ -469,21 +462,22 @@ await client.agent.chat({
|
|
|
469
462
|
<dl>
|
|
470
463
|
<dd>
|
|
471
464
|
|
|
472
|
-
**request:** `phenoml.agent.AgentChatRequest`
|
|
473
|
-
|
|
465
|
+
**request:** `phenoml.agent.AgentChatRequest`
|
|
466
|
+
|
|
474
467
|
</dd>
|
|
475
468
|
</dl>
|
|
476
469
|
|
|
477
470
|
<dl>
|
|
478
471
|
<dd>
|
|
479
472
|
|
|
480
|
-
**requestOptions:** `Agent.RequestOptions`
|
|
481
|
-
|
|
473
|
+
**requestOptions:** `Agent.RequestOptions`
|
|
474
|
+
|
|
482
475
|
</dd>
|
|
483
476
|
</dl>
|
|
484
477
|
</dd>
|
|
485
478
|
</dl>
|
|
486
479
|
|
|
480
|
+
|
|
487
481
|
</dd>
|
|
488
482
|
</dl>
|
|
489
483
|
</details>
|
|
@@ -501,7 +495,6 @@ await client.agent.chat({
|
|
|
501
495
|
<dd>
|
|
502
496
|
|
|
503
497
|
Retrieves a list of chat messages for a given chat session
|
|
504
|
-
|
|
505
498
|
</dd>
|
|
506
499
|
</dl>
|
|
507
500
|
</dd>
|
|
@@ -520,10 +513,10 @@ await client.agent.getChatMessages({
|
|
|
520
513
|
chat_session_id: "chat_session_id",
|
|
521
514
|
num_messages: 1,
|
|
522
515
|
role: "role",
|
|
523
|
-
order: "asc"
|
|
516
|
+
order: "asc"
|
|
524
517
|
});
|
|
525
|
-
```
|
|
526
518
|
|
|
519
|
+
```
|
|
527
520
|
</dd>
|
|
528
521
|
</dl>
|
|
529
522
|
</dd>
|
|
@@ -537,27 +530,27 @@ await client.agent.getChatMessages({
|
|
|
537
530
|
<dl>
|
|
538
531
|
<dd>
|
|
539
532
|
|
|
540
|
-
**request:** `phenoml.agent.AgentGetChatMessagesRequest`
|
|
541
|
-
|
|
533
|
+
**request:** `phenoml.agent.AgentGetChatMessagesRequest`
|
|
534
|
+
|
|
542
535
|
</dd>
|
|
543
536
|
</dl>
|
|
544
537
|
|
|
545
538
|
<dl>
|
|
546
539
|
<dd>
|
|
547
540
|
|
|
548
|
-
**requestOptions:** `Agent.RequestOptions`
|
|
549
|
-
|
|
541
|
+
**requestOptions:** `Agent.RequestOptions`
|
|
542
|
+
|
|
550
543
|
</dd>
|
|
551
544
|
</dl>
|
|
552
545
|
</dd>
|
|
553
546
|
</dl>
|
|
554
547
|
|
|
548
|
+
|
|
555
549
|
</dd>
|
|
556
550
|
</dl>
|
|
557
551
|
</details>
|
|
558
552
|
|
|
559
553
|
## Agent Prompts
|
|
560
|
-
|
|
561
554
|
<details><summary><code>client.agent.prompts.<a href="/src/api/resources/agent/resources/prompts/client/Client.ts">create</a>({ ...params }) -> phenoml.AgentPromptsResponse</code></summary>
|
|
562
555
|
<dl>
|
|
563
556
|
<dd>
|
|
@@ -571,7 +564,6 @@ await client.agent.getChatMessages({
|
|
|
571
564
|
<dd>
|
|
572
565
|
|
|
573
566
|
Creates a new agent prompt
|
|
574
|
-
|
|
575
567
|
</dd>
|
|
576
568
|
</dl>
|
|
577
569
|
</dd>
|
|
@@ -589,10 +581,10 @@ Creates a new agent prompt
|
|
|
589
581
|
await client.agent.prompts.create({
|
|
590
582
|
name: "Medical Assistant System Prompt",
|
|
591
583
|
content: "You are a helpful medical assistant specialized in FHIR data processing...",
|
|
592
|
-
is_active: true
|
|
584
|
+
is_active: true
|
|
593
585
|
});
|
|
594
|
-
```
|
|
595
586
|
|
|
587
|
+
```
|
|
596
588
|
</dd>
|
|
597
589
|
</dl>
|
|
598
590
|
</dd>
|
|
@@ -606,21 +598,22 @@ await client.agent.prompts.create({
|
|
|
606
598
|
<dl>
|
|
607
599
|
<dd>
|
|
608
600
|
|
|
609
|
-
**request:** `phenoml.agent.AgentPromptsCreateRequest`
|
|
610
|
-
|
|
601
|
+
**request:** `phenoml.agent.AgentPromptsCreateRequest`
|
|
602
|
+
|
|
611
603
|
</dd>
|
|
612
604
|
</dl>
|
|
613
605
|
|
|
614
606
|
<dl>
|
|
615
607
|
<dd>
|
|
616
608
|
|
|
617
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
618
|
-
|
|
609
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
610
|
+
|
|
619
611
|
</dd>
|
|
620
612
|
</dl>
|
|
621
613
|
</dd>
|
|
622
614
|
</dl>
|
|
623
615
|
|
|
616
|
+
|
|
624
617
|
</dd>
|
|
625
618
|
</dl>
|
|
626
619
|
</details>
|
|
@@ -638,7 +631,6 @@ await client.agent.prompts.create({
|
|
|
638
631
|
<dd>
|
|
639
632
|
|
|
640
633
|
Retrieves a list of agent prompts belonging to the authenticated user
|
|
641
|
-
|
|
642
634
|
</dd>
|
|
643
635
|
</dl>
|
|
644
636
|
</dd>
|
|
@@ -654,8 +646,8 @@ Retrieves a list of agent prompts belonging to the authenticated user
|
|
|
654
646
|
|
|
655
647
|
```typescript
|
|
656
648
|
await client.agent.prompts.list();
|
|
657
|
-
```
|
|
658
649
|
|
|
650
|
+
```
|
|
659
651
|
</dd>
|
|
660
652
|
</dl>
|
|
661
653
|
</dd>
|
|
@@ -669,13 +661,14 @@ await client.agent.prompts.list();
|
|
|
669
661
|
<dl>
|
|
670
662
|
<dd>
|
|
671
663
|
|
|
672
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
673
|
-
|
|
664
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
665
|
+
|
|
674
666
|
</dd>
|
|
675
667
|
</dl>
|
|
676
668
|
</dd>
|
|
677
669
|
</dl>
|
|
678
670
|
|
|
671
|
+
|
|
679
672
|
</dd>
|
|
680
673
|
</dl>
|
|
681
674
|
</details>
|
|
@@ -693,7 +686,6 @@ await client.agent.prompts.list();
|
|
|
693
686
|
<dd>
|
|
694
687
|
|
|
695
688
|
Retrieves a specific prompt by its ID
|
|
696
|
-
|
|
697
689
|
</dd>
|
|
698
690
|
</dl>
|
|
699
691
|
</dd>
|
|
@@ -709,8 +701,8 @@ Retrieves a specific prompt by its ID
|
|
|
709
701
|
|
|
710
702
|
```typescript
|
|
711
703
|
await client.agent.prompts.get("id");
|
|
712
|
-
```
|
|
713
704
|
|
|
705
|
+
```
|
|
714
706
|
</dd>
|
|
715
707
|
</dl>
|
|
716
708
|
</dd>
|
|
@@ -725,20 +717,21 @@ await client.agent.prompts.get("id");
|
|
|
725
717
|
<dd>
|
|
726
718
|
|
|
727
719
|
**id:** `string` — Prompt ID
|
|
728
|
-
|
|
720
|
+
|
|
729
721
|
</dd>
|
|
730
722
|
</dl>
|
|
731
723
|
|
|
732
724
|
<dl>
|
|
733
725
|
<dd>
|
|
734
726
|
|
|
735
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
736
|
-
|
|
727
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
728
|
+
|
|
737
729
|
</dd>
|
|
738
730
|
</dl>
|
|
739
731
|
</dd>
|
|
740
732
|
</dl>
|
|
741
733
|
|
|
734
|
+
|
|
742
735
|
</dd>
|
|
743
736
|
</dl>
|
|
744
737
|
</details>
|
|
@@ -756,7 +749,6 @@ await client.agent.prompts.get("id");
|
|
|
756
749
|
<dd>
|
|
757
750
|
|
|
758
751
|
Updates an existing prompt
|
|
759
|
-
|
|
760
752
|
</dd>
|
|
761
753
|
</dl>
|
|
762
754
|
</dd>
|
|
@@ -772,8 +764,8 @@ Updates an existing prompt
|
|
|
772
764
|
|
|
773
765
|
```typescript
|
|
774
766
|
await client.agent.prompts.update("id");
|
|
775
|
-
```
|
|
776
767
|
|
|
768
|
+
```
|
|
777
769
|
</dd>
|
|
778
770
|
</dl>
|
|
779
771
|
</dd>
|
|
@@ -788,28 +780,29 @@ await client.agent.prompts.update("id");
|
|
|
788
780
|
<dd>
|
|
789
781
|
|
|
790
782
|
**id:** `string` — Prompt ID
|
|
791
|
-
|
|
783
|
+
|
|
792
784
|
</dd>
|
|
793
785
|
</dl>
|
|
794
786
|
|
|
795
787
|
<dl>
|
|
796
788
|
<dd>
|
|
797
789
|
|
|
798
|
-
**request:** `phenoml.agent.AgentPromptsUpdateRequest`
|
|
799
|
-
|
|
790
|
+
**request:** `phenoml.agent.AgentPromptsUpdateRequest`
|
|
791
|
+
|
|
800
792
|
</dd>
|
|
801
793
|
</dl>
|
|
802
794
|
|
|
803
795
|
<dl>
|
|
804
796
|
<dd>
|
|
805
797
|
|
|
806
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
807
|
-
|
|
798
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
799
|
+
|
|
808
800
|
</dd>
|
|
809
801
|
</dl>
|
|
810
802
|
</dd>
|
|
811
803
|
</dl>
|
|
812
804
|
|
|
805
|
+
|
|
813
806
|
</dd>
|
|
814
807
|
</dl>
|
|
815
808
|
</details>
|
|
@@ -827,7 +820,6 @@ await client.agent.prompts.update("id");
|
|
|
827
820
|
<dd>
|
|
828
821
|
|
|
829
822
|
Soft deletes a prompt by setting is_active to false
|
|
830
|
-
|
|
831
823
|
</dd>
|
|
832
824
|
</dl>
|
|
833
825
|
</dd>
|
|
@@ -843,8 +835,8 @@ Soft deletes a prompt by setting is_active to false
|
|
|
843
835
|
|
|
844
836
|
```typescript
|
|
845
837
|
await client.agent.prompts.delete("id");
|
|
846
|
-
```
|
|
847
838
|
|
|
839
|
+
```
|
|
848
840
|
</dd>
|
|
849
841
|
</dl>
|
|
850
842
|
</dd>
|
|
@@ -859,20 +851,21 @@ await client.agent.prompts.delete("id");
|
|
|
859
851
|
<dd>
|
|
860
852
|
|
|
861
853
|
**id:** `string` — Prompt ID
|
|
862
|
-
|
|
854
|
+
|
|
863
855
|
</dd>
|
|
864
856
|
</dl>
|
|
865
857
|
|
|
866
858
|
<dl>
|
|
867
859
|
<dd>
|
|
868
860
|
|
|
869
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
870
|
-
|
|
861
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
862
|
+
|
|
871
863
|
</dd>
|
|
872
864
|
</dl>
|
|
873
865
|
</dd>
|
|
874
866
|
</dl>
|
|
875
867
|
|
|
868
|
+
|
|
876
869
|
</dd>
|
|
877
870
|
</dl>
|
|
878
871
|
</details>
|
|
@@ -890,7 +883,6 @@ await client.agent.prompts.delete("id");
|
|
|
890
883
|
<dd>
|
|
891
884
|
|
|
892
885
|
Patches an existing prompt
|
|
893
|
-
|
|
894
886
|
</dd>
|
|
895
887
|
</dl>
|
|
896
888
|
</dd>
|
|
@@ -905,24 +897,20 @@ Patches an existing prompt
|
|
|
905
897
|
<dd>
|
|
906
898
|
|
|
907
899
|
```typescript
|
|
908
|
-
await client.agent.prompts.patch("id", [
|
|
909
|
-
{
|
|
900
|
+
await client.agent.prompts.patch("id", [{
|
|
910
901
|
op: "replace",
|
|
911
902
|
path: "/name",
|
|
912
|
-
value: "Updated Agent Name"
|
|
913
|
-
},
|
|
914
|
-
{
|
|
903
|
+
value: "Updated Agent Name"
|
|
904
|
+
}, {
|
|
915
905
|
op: "add",
|
|
916
906
|
path: "/tags/-",
|
|
917
|
-
value: "new-tag"
|
|
918
|
-
},
|
|
919
|
-
{
|
|
907
|
+
value: "new-tag"
|
|
908
|
+
}, {
|
|
920
909
|
op: "remove",
|
|
921
|
-
path: "/description"
|
|
922
|
-
}
|
|
923
|
-
]);
|
|
924
|
-
```
|
|
910
|
+
path: "/description"
|
|
911
|
+
}]);
|
|
925
912
|
|
|
913
|
+
```
|
|
926
914
|
</dd>
|
|
927
915
|
</dl>
|
|
928
916
|
</dd>
|
|
@@ -937,28 +925,29 @@ await client.agent.prompts.patch("id", [
|
|
|
937
925
|
<dd>
|
|
938
926
|
|
|
939
927
|
**id:** `string` — Agent Prompt ID
|
|
940
|
-
|
|
928
|
+
|
|
941
929
|
</dd>
|
|
942
930
|
</dl>
|
|
943
931
|
|
|
944
932
|
<dl>
|
|
945
933
|
<dd>
|
|
946
934
|
|
|
947
|
-
**request:** `phenoml.JsonPatch`
|
|
948
|
-
|
|
935
|
+
**request:** `phenoml.JsonPatch`
|
|
936
|
+
|
|
949
937
|
</dd>
|
|
950
938
|
</dl>
|
|
951
939
|
|
|
952
940
|
<dl>
|
|
953
941
|
<dd>
|
|
954
942
|
|
|
955
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
956
|
-
|
|
943
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
944
|
+
|
|
957
945
|
</dd>
|
|
958
946
|
</dl>
|
|
959
947
|
</dd>
|
|
960
948
|
</dl>
|
|
961
949
|
|
|
950
|
+
|
|
962
951
|
</dd>
|
|
963
952
|
</dl>
|
|
964
953
|
</details>
|
|
@@ -976,7 +965,6 @@ await client.agent.prompts.patch("id", [
|
|
|
976
965
|
<dd>
|
|
977
966
|
|
|
978
967
|
Loads default agent prompts for the authenticated user
|
|
979
|
-
|
|
980
968
|
</dd>
|
|
981
969
|
</dl>
|
|
982
970
|
</dd>
|
|
@@ -992,8 +980,8 @@ Loads default agent prompts for the authenticated user
|
|
|
992
980
|
|
|
993
981
|
```typescript
|
|
994
982
|
await client.agent.prompts.loadDefaults();
|
|
995
|
-
```
|
|
996
983
|
|
|
984
|
+
```
|
|
997
985
|
</dd>
|
|
998
986
|
</dl>
|
|
999
987
|
</dd>
|
|
@@ -1007,19 +995,19 @@ await client.agent.prompts.loadDefaults();
|
|
|
1007
995
|
<dl>
|
|
1008
996
|
<dd>
|
|
1009
997
|
|
|
1010
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
1011
|
-
|
|
998
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
999
|
+
|
|
1012
1000
|
</dd>
|
|
1013
1001
|
</dl>
|
|
1014
1002
|
</dd>
|
|
1015
1003
|
</dl>
|
|
1016
1004
|
|
|
1005
|
+
|
|
1017
1006
|
</dd>
|
|
1018
1007
|
</dl>
|
|
1019
1008
|
</details>
|
|
1020
1009
|
|
|
1021
1010
|
## Authtoken Auth
|
|
1022
|
-
|
|
1023
1011
|
<details><summary><code>client.authtoken.auth.<a href="/src/api/resources/authtoken/resources/auth/client/Client.ts">generateToken</a>({ ...params }) -> phenoml.AuthGenerateTokenResponse</code></summary>
|
|
1024
1012
|
<dl>
|
|
1025
1013
|
<dd>
|
|
@@ -1033,7 +1021,6 @@ await client.agent.prompts.loadDefaults();
|
|
|
1033
1021
|
<dd>
|
|
1034
1022
|
|
|
1035
1023
|
Obtain an access token using client credentials
|
|
1036
|
-
|
|
1037
1024
|
</dd>
|
|
1038
1025
|
</dl>
|
|
1039
1026
|
</dd>
|
|
@@ -1050,10 +1037,10 @@ Obtain an access token using client credentials
|
|
|
1050
1037
|
```typescript
|
|
1051
1038
|
await client.authtoken.auth.generateToken({
|
|
1052
1039
|
username: "username",
|
|
1053
|
-
password: "password"
|
|
1040
|
+
password: "password"
|
|
1054
1041
|
});
|
|
1055
|
-
```
|
|
1056
1042
|
|
|
1043
|
+
```
|
|
1057
1044
|
</dd>
|
|
1058
1045
|
</dl>
|
|
1059
1046
|
</dd>
|
|
@@ -1067,27 +1054,27 @@ await client.authtoken.auth.generateToken({
|
|
|
1067
1054
|
<dl>
|
|
1068
1055
|
<dd>
|
|
1069
1056
|
|
|
1070
|
-
**request:** `phenoml.authtoken.AuthGenerateTokenRequest`
|
|
1071
|
-
|
|
1057
|
+
**request:** `phenoml.authtoken.AuthGenerateTokenRequest`
|
|
1058
|
+
|
|
1072
1059
|
</dd>
|
|
1073
1060
|
</dl>
|
|
1074
1061
|
|
|
1075
1062
|
<dl>
|
|
1076
1063
|
<dd>
|
|
1077
1064
|
|
|
1078
|
-
**requestOptions:** `Auth.RequestOptions`
|
|
1079
|
-
|
|
1065
|
+
**requestOptions:** `Auth.RequestOptions`
|
|
1066
|
+
|
|
1080
1067
|
</dd>
|
|
1081
1068
|
</dl>
|
|
1082
1069
|
</dd>
|
|
1083
1070
|
</dl>
|
|
1084
1071
|
|
|
1072
|
+
|
|
1085
1073
|
</dd>
|
|
1086
1074
|
</dl>
|
|
1087
1075
|
</details>
|
|
1088
1076
|
|
|
1089
1077
|
## Cohort
|
|
1090
|
-
|
|
1091
1078
|
<details><summary><code>client.cohort.<a href="/src/api/resources/cohort/client/Client.ts">analyze</a>({ ...params }) -> phenoml.CohortResponse</code></summary>
|
|
1092
1079
|
<dl>
|
|
1093
1080
|
<dd>
|
|
@@ -1101,7 +1088,6 @@ await client.authtoken.auth.generateToken({
|
|
|
1101
1088
|
<dd>
|
|
1102
1089
|
|
|
1103
1090
|
Converts natural language text into structured FHIR search queries for patient cohort analysis
|
|
1104
|
-
|
|
1105
1091
|
</dd>
|
|
1106
1092
|
</dl>
|
|
1107
1093
|
</dd>
|
|
@@ -1117,10 +1103,10 @@ Converts natural language text into structured FHIR search queries for patient c
|
|
|
1117
1103
|
|
|
1118
1104
|
```typescript
|
|
1119
1105
|
await client.cohort.analyze({
|
|
1120
|
-
text: "female patients over 65 with diabetes but not hypertension"
|
|
1106
|
+
text: "female patients over 65 with diabetes but not hypertension"
|
|
1121
1107
|
});
|
|
1122
|
-
```
|
|
1123
1108
|
|
|
1109
|
+
```
|
|
1124
1110
|
</dd>
|
|
1125
1111
|
</dl>
|
|
1126
1112
|
</dd>
|
|
@@ -1134,27 +1120,27 @@ await client.cohort.analyze({
|
|
|
1134
1120
|
<dl>
|
|
1135
1121
|
<dd>
|
|
1136
1122
|
|
|
1137
|
-
**request:** `phenoml.cohort.CohortRequest`
|
|
1138
|
-
|
|
1123
|
+
**request:** `phenoml.cohort.CohortRequest`
|
|
1124
|
+
|
|
1139
1125
|
</dd>
|
|
1140
1126
|
</dl>
|
|
1141
1127
|
|
|
1142
1128
|
<dl>
|
|
1143
1129
|
<dd>
|
|
1144
1130
|
|
|
1145
|
-
**requestOptions:** `Cohort.RequestOptions`
|
|
1146
|
-
|
|
1131
|
+
**requestOptions:** `Cohort.RequestOptions`
|
|
1132
|
+
|
|
1147
1133
|
</dd>
|
|
1148
1134
|
</dl>
|
|
1149
1135
|
</dd>
|
|
1150
1136
|
</dl>
|
|
1151
1137
|
|
|
1138
|
+
|
|
1152
1139
|
</dd>
|
|
1153
1140
|
</dl>
|
|
1154
1141
|
</details>
|
|
1155
1142
|
|
|
1156
1143
|
## Construe
|
|
1157
|
-
|
|
1158
1144
|
<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">uploadCodeSystem</a>({ ...params }) -> phenoml.ConstrueUploadCodeSystemResponse</code></summary>
|
|
1159
1145
|
<dl>
|
|
1160
1146
|
<dd>
|
|
@@ -1170,7 +1156,6 @@ await client.cohort.analyze({
|
|
|
1170
1156
|
Upload a custom medical code system with codes and descriptions for use in code extraction.
|
|
1171
1157
|
Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
|
|
1172
1158
|
subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
|
|
1173
|
-
|
|
1174
1159
|
</dd>
|
|
1175
1160
|
</dl>
|
|
1176
1161
|
</dd>
|
|
@@ -1189,10 +1174,10 @@ await client.construe.uploadCodeSystem({
|
|
|
1189
1174
|
name: "CUSTOM_CODES",
|
|
1190
1175
|
version: "1.0",
|
|
1191
1176
|
format: "json",
|
|
1192
|
-
file: "file"
|
|
1177
|
+
file: "file"
|
|
1193
1178
|
});
|
|
1194
|
-
```
|
|
1195
1179
|
|
|
1180
|
+
```
|
|
1196
1181
|
</dd>
|
|
1197
1182
|
</dl>
|
|
1198
1183
|
</dd>
|
|
@@ -1206,21 +1191,22 @@ await client.construe.uploadCodeSystem({
|
|
|
1206
1191
|
<dl>
|
|
1207
1192
|
<dd>
|
|
1208
1193
|
|
|
1209
|
-
**request:** `phenoml.construe.UploadRequest`
|
|
1210
|
-
|
|
1194
|
+
**request:** `phenoml.construe.UploadRequest`
|
|
1195
|
+
|
|
1211
1196
|
</dd>
|
|
1212
1197
|
</dl>
|
|
1213
1198
|
|
|
1214
1199
|
<dl>
|
|
1215
1200
|
<dd>
|
|
1216
1201
|
|
|
1217
|
-
**requestOptions:** `Construe.RequestOptions`
|
|
1218
|
-
|
|
1202
|
+
**requestOptions:** `Construe.RequestOptions`
|
|
1203
|
+
|
|
1219
1204
|
</dd>
|
|
1220
1205
|
</dl>
|
|
1221
1206
|
</dd>
|
|
1222
1207
|
</dl>
|
|
1223
1208
|
|
|
1209
|
+
|
|
1224
1210
|
</dd>
|
|
1225
1211
|
</dl>
|
|
1226
1212
|
</details>
|
|
@@ -1238,7 +1224,6 @@ await client.construe.uploadCodeSystem({
|
|
|
1238
1224
|
<dd>
|
|
1239
1225
|
|
|
1240
1226
|
Converts natural language text into structured medical codes
|
|
1241
|
-
|
|
1242
1227
|
</dd>
|
|
1243
1228
|
</dl>
|
|
1244
1229
|
</dd>
|
|
@@ -1254,10 +1239,10 @@ Converts natural language text into structured medical codes
|
|
|
1254
1239
|
|
|
1255
1240
|
```typescript
|
|
1256
1241
|
await client.construe.extractCodes({
|
|
1257
|
-
text: "Patient is a 14-year-old female, previously healthy, who is here for evaluation of abnormal renal ultrasound with atrophic right kidney"
|
|
1242
|
+
text: "Patient is a 14-year-old female, previously healthy, who is here for evaluation of abnormal renal ultrasound with atrophic right kidney"
|
|
1258
1243
|
});
|
|
1259
|
-
```
|
|
1260
1244
|
|
|
1245
|
+
```
|
|
1261
1246
|
</dd>
|
|
1262
1247
|
</dl>
|
|
1263
1248
|
</dd>
|
|
@@ -1271,21 +1256,22 @@ await client.construe.extractCodes({
|
|
|
1271
1256
|
<dl>
|
|
1272
1257
|
<dd>
|
|
1273
1258
|
|
|
1274
|
-
**request:** `phenoml.construe.ExtractRequest`
|
|
1275
|
-
|
|
1259
|
+
**request:** `phenoml.construe.ExtractRequest`
|
|
1260
|
+
|
|
1276
1261
|
</dd>
|
|
1277
1262
|
</dl>
|
|
1278
1263
|
|
|
1279
1264
|
<dl>
|
|
1280
1265
|
<dd>
|
|
1281
1266
|
|
|
1282
|
-
**requestOptions:** `Construe.RequestOptions`
|
|
1283
|
-
|
|
1267
|
+
**requestOptions:** `Construe.RequestOptions`
|
|
1268
|
+
|
|
1284
1269
|
</dd>
|
|
1285
1270
|
</dl>
|
|
1286
1271
|
</dd>
|
|
1287
1272
|
</dl>
|
|
1288
1273
|
|
|
1274
|
+
|
|
1289
1275
|
</dd>
|
|
1290
1276
|
</dl>
|
|
1291
1277
|
</details>
|
|
@@ -1304,7 +1290,6 @@ await client.construe.extractCodes({
|
|
|
1304
1290
|
|
|
1305
1291
|
Creates a patient cohort based on a natural language description.
|
|
1306
1292
|
Translates the description into FHIR search queries and optional SQL queries.
|
|
1307
|
-
|
|
1308
1293
|
</dd>
|
|
1309
1294
|
</dl>
|
|
1310
1295
|
</dd>
|
|
@@ -1320,10 +1305,10 @@ Translates the description into FHIR search queries and optional SQL queries.
|
|
|
1320
1305
|
|
|
1321
1306
|
```typescript
|
|
1322
1307
|
await client.construe.cohort({
|
|
1323
|
-
text: "Between 20 and 40 years old with hyperlipidemia"
|
|
1308
|
+
text: "Between 20 and 40 years old with hyperlipidemia"
|
|
1324
1309
|
});
|
|
1325
|
-
```
|
|
1326
1310
|
|
|
1311
|
+
```
|
|
1327
1312
|
</dd>
|
|
1328
1313
|
</dl>
|
|
1329
1314
|
</dd>
|
|
@@ -1337,27 +1322,27 @@ await client.construe.cohort({
|
|
|
1337
1322
|
<dl>
|
|
1338
1323
|
<dd>
|
|
1339
1324
|
|
|
1340
|
-
**request:** `phenoml.construe.ConstrueCohortRequest`
|
|
1341
|
-
|
|
1325
|
+
**request:** `phenoml.construe.ConstrueCohortRequest`
|
|
1326
|
+
|
|
1342
1327
|
</dd>
|
|
1343
1328
|
</dl>
|
|
1344
1329
|
|
|
1345
1330
|
<dl>
|
|
1346
1331
|
<dd>
|
|
1347
1332
|
|
|
1348
|
-
**requestOptions:** `Construe.RequestOptions`
|
|
1349
|
-
|
|
1333
|
+
**requestOptions:** `Construe.RequestOptions`
|
|
1334
|
+
|
|
1350
1335
|
</dd>
|
|
1351
1336
|
</dl>
|
|
1352
1337
|
</dd>
|
|
1353
1338
|
</dl>
|
|
1354
1339
|
|
|
1340
|
+
|
|
1355
1341
|
</dd>
|
|
1356
1342
|
</dl>
|
|
1357
1343
|
</details>
|
|
1358
1344
|
|
|
1359
1345
|
## Fhir
|
|
1360
|
-
|
|
1361
1346
|
<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">search</a>(fhirProviderId, fhirPath, { ...params }) -> phenoml.FhirSearchResponse</code></summary>
|
|
1362
1347
|
<dl>
|
|
1363
1348
|
<dd>
|
|
@@ -1373,7 +1358,6 @@ await client.construe.cohort({
|
|
|
1373
1358
|
Retrieves FHIR resources from the specified provider. Supports both individual resource retrieval and search operations based on the FHIR path and query parameters.
|
|
1374
1359
|
|
|
1375
1360
|
The request is proxied to the configured FHIR server with appropriate authentication headers.
|
|
1376
|
-
|
|
1377
1361
|
</dd>
|
|
1378
1362
|
</dl>
|
|
1379
1363
|
</dd>
|
|
@@ -1389,10 +1373,10 @@ The request is proxied to the configured FHIR server with appropriate authentica
|
|
|
1389
1373
|
|
|
1390
1374
|
```typescript
|
|
1391
1375
|
await client.fhir.search("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
1392
|
-
"X-Phenoml-On-Behalf-Of": "user@example.com"
|
|
1376
|
+
"X-Phenoml-On-Behalf-Of": "user@example.com"
|
|
1393
1377
|
});
|
|
1394
|
-
```
|
|
1395
1378
|
|
|
1379
|
+
```
|
|
1396
1380
|
</dd>
|
|
1397
1381
|
</dl>
|
|
1398
1382
|
</dd>
|
|
@@ -1406,49 +1390,48 @@ await client.fhir.search("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
|
1406
1390
|
<dl>
|
|
1407
1391
|
<dd>
|
|
1408
1392
|
|
|
1409
|
-
**fhirProviderId:** `string`
|
|
1393
|
+
**fhirProviderId:** `string`
|
|
1410
1394
|
|
|
1411
1395
|
The ID of the FHIR provider to use. Can be either:
|
|
1412
|
-
|
|
1413
1396
|
- A UUID representing the provider ID
|
|
1414
1397
|
- A provider name (legacy support - will just use the most recently updated provider with this name)
|
|
1415
|
-
|
|
1398
|
+
|
|
1416
1399
|
</dd>
|
|
1417
1400
|
</dl>
|
|
1418
1401
|
|
|
1419
1402
|
<dl>
|
|
1420
1403
|
<dd>
|
|
1421
1404
|
|
|
1422
|
-
**fhirPath:** `string`
|
|
1405
|
+
**fhirPath:** `string`
|
|
1423
1406
|
|
|
1424
1407
|
The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
|
|
1425
1408
|
Examples:
|
|
1426
|
-
|
|
1427
1409
|
- "Patient" (for resource type operations)
|
|
1428
1410
|
- "Patient/123" (for specific resource operations)
|
|
1429
|
-
- "Patient/123
|
|
1430
|
-
|
|
1411
|
+
- "Patient/123/_history" (for history operations)
|
|
1412
|
+
|
|
1431
1413
|
</dd>
|
|
1432
1414
|
</dl>
|
|
1433
1415
|
|
|
1434
1416
|
<dl>
|
|
1435
1417
|
<dd>
|
|
1436
1418
|
|
|
1437
|
-
**request:** `phenoml.fhir.FhirSearchRequest`
|
|
1438
|
-
|
|
1419
|
+
**request:** `phenoml.fhir.FhirSearchRequest`
|
|
1420
|
+
|
|
1439
1421
|
</dd>
|
|
1440
1422
|
</dl>
|
|
1441
1423
|
|
|
1442
1424
|
<dl>
|
|
1443
1425
|
<dd>
|
|
1444
1426
|
|
|
1445
|
-
**requestOptions:** `Fhir.RequestOptions`
|
|
1446
|
-
|
|
1427
|
+
**requestOptions:** `Fhir.RequestOptions`
|
|
1428
|
+
|
|
1447
1429
|
</dd>
|
|
1448
1430
|
</dl>
|
|
1449
1431
|
</dd>
|
|
1450
1432
|
</dl>
|
|
1451
1433
|
|
|
1434
|
+
|
|
1452
1435
|
</dd>
|
|
1453
1436
|
</dl>
|
|
1454
1437
|
</details>
|
|
@@ -1468,7 +1451,6 @@ Examples:
|
|
|
1468
1451
|
Creates a new FHIR resource on the specified provider. The request body should contain a valid FHIR resource in JSON format.
|
|
1469
1452
|
|
|
1470
1453
|
The request is proxied to the configured FHIR server with appropriate authentication headers.
|
|
1471
|
-
|
|
1472
1454
|
</dd>
|
|
1473
1455
|
</dl>
|
|
1474
1456
|
</dd>
|
|
@@ -1489,16 +1471,18 @@ await client.fhir.create("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
|
1489
1471
|
resourceType: "Patient",
|
|
1490
1472
|
name: [
|
|
1491
1473
|
{
|
|
1492
|
-
family: "Doe",
|
|
1493
|
-
given: [
|
|
1494
|
-
|
|
1474
|
+
"family": "Doe",
|
|
1475
|
+
"given": [
|
|
1476
|
+
"Jane"
|
|
1477
|
+
]
|
|
1478
|
+
}
|
|
1495
1479
|
],
|
|
1496
1480
|
gender: "female",
|
|
1497
|
-
birthDate: "1990-01-01"
|
|
1498
|
-
}
|
|
1481
|
+
birthDate: "1990-01-01"
|
|
1482
|
+
}
|
|
1499
1483
|
});
|
|
1500
|
-
```
|
|
1501
1484
|
|
|
1485
|
+
```
|
|
1502
1486
|
</dd>
|
|
1503
1487
|
</dl>
|
|
1504
1488
|
</dd>
|
|
@@ -1512,49 +1496,48 @@ await client.fhir.create("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
|
1512
1496
|
<dl>
|
|
1513
1497
|
<dd>
|
|
1514
1498
|
|
|
1515
|
-
**fhirProviderId:** `string`
|
|
1499
|
+
**fhirProviderId:** `string`
|
|
1516
1500
|
|
|
1517
1501
|
The ID of the FHIR provider to use. Can be either:
|
|
1518
|
-
|
|
1519
1502
|
- A UUID representing the provider ID
|
|
1520
1503
|
- A provider name (legacy support - will just use the most recently updated provider with this name)
|
|
1521
|
-
|
|
1504
|
+
|
|
1522
1505
|
</dd>
|
|
1523
1506
|
</dl>
|
|
1524
1507
|
|
|
1525
1508
|
<dl>
|
|
1526
1509
|
<dd>
|
|
1527
1510
|
|
|
1528
|
-
**fhirPath:** `string`
|
|
1511
|
+
**fhirPath:** `string`
|
|
1529
1512
|
|
|
1530
1513
|
The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
|
|
1531
1514
|
Examples:
|
|
1532
|
-
|
|
1533
1515
|
- "Patient" (for resource type operations)
|
|
1534
1516
|
- "Patient/123" (for specific resource operations)
|
|
1535
|
-
- "Patient/123
|
|
1536
|
-
|
|
1517
|
+
- "Patient/123/_history" (for history operations)
|
|
1518
|
+
|
|
1537
1519
|
</dd>
|
|
1538
1520
|
</dl>
|
|
1539
1521
|
|
|
1540
1522
|
<dl>
|
|
1541
1523
|
<dd>
|
|
1542
1524
|
|
|
1543
|
-
**request:** `phenoml.fhir.FhirCreateRequest`
|
|
1544
|
-
|
|
1525
|
+
**request:** `phenoml.fhir.FhirCreateRequest`
|
|
1526
|
+
|
|
1545
1527
|
</dd>
|
|
1546
1528
|
</dl>
|
|
1547
1529
|
|
|
1548
1530
|
<dl>
|
|
1549
1531
|
<dd>
|
|
1550
1532
|
|
|
1551
|
-
**requestOptions:** `Fhir.RequestOptions`
|
|
1552
|
-
|
|
1533
|
+
**requestOptions:** `Fhir.RequestOptions`
|
|
1534
|
+
|
|
1553
1535
|
</dd>
|
|
1554
1536
|
</dl>
|
|
1555
1537
|
</dd>
|
|
1556
1538
|
</dl>
|
|
1557
1539
|
|
|
1540
|
+
|
|
1558
1541
|
</dd>
|
|
1559
1542
|
</dl>
|
|
1560
1543
|
</details>
|
|
@@ -1574,7 +1557,6 @@ Examples:
|
|
|
1574
1557
|
Creates or updates a FHIR resource on the specified provider. If the resource exists, it will be updated; otherwise, it will be created.
|
|
1575
1558
|
|
|
1576
1559
|
The request is proxied to the configured FHIR server with appropriate authentication headers.
|
|
1577
|
-
|
|
1578
1560
|
</dd>
|
|
1579
1561
|
</dl>
|
|
1580
1562
|
</dd>
|
|
@@ -1596,16 +1578,19 @@ await client.fhir.upsert("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
|
1596
1578
|
id: "123",
|
|
1597
1579
|
name: [
|
|
1598
1580
|
{
|
|
1599
|
-
family: "Doe",
|
|
1600
|
-
given: [
|
|
1601
|
-
|
|
1581
|
+
"family": "Doe",
|
|
1582
|
+
"given": [
|
|
1583
|
+
"John",
|
|
1584
|
+
"Updated"
|
|
1585
|
+
]
|
|
1586
|
+
}
|
|
1602
1587
|
],
|
|
1603
1588
|
gender: "male",
|
|
1604
|
-
birthDate: "1985-05-15"
|
|
1605
|
-
}
|
|
1589
|
+
birthDate: "1985-05-15"
|
|
1590
|
+
}
|
|
1606
1591
|
});
|
|
1607
|
-
```
|
|
1608
1592
|
|
|
1593
|
+
```
|
|
1609
1594
|
</dd>
|
|
1610
1595
|
</dl>
|
|
1611
1596
|
</dd>
|
|
@@ -1619,49 +1604,48 @@ await client.fhir.upsert("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
|
1619
1604
|
<dl>
|
|
1620
1605
|
<dd>
|
|
1621
1606
|
|
|
1622
|
-
**fhirProviderId:** `string`
|
|
1607
|
+
**fhirProviderId:** `string`
|
|
1623
1608
|
|
|
1624
1609
|
The ID of the FHIR provider to use. Can be either:
|
|
1625
|
-
|
|
1626
1610
|
- A UUID representing the provider ID
|
|
1627
1611
|
- A provider name (legacy support - will just use the most recently updated provider with this name)
|
|
1628
|
-
|
|
1612
|
+
|
|
1629
1613
|
</dd>
|
|
1630
1614
|
</dl>
|
|
1631
1615
|
|
|
1632
1616
|
<dl>
|
|
1633
1617
|
<dd>
|
|
1634
1618
|
|
|
1635
|
-
**fhirPath:** `string`
|
|
1619
|
+
**fhirPath:** `string`
|
|
1636
1620
|
|
|
1637
1621
|
The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
|
|
1638
1622
|
Examples:
|
|
1639
|
-
|
|
1640
1623
|
- "Patient" (for resource type operations)
|
|
1641
1624
|
- "Patient/123" (for specific resource operations)
|
|
1642
|
-
- "Patient/123
|
|
1643
|
-
|
|
1625
|
+
- "Patient/123/_history" (for history operations)
|
|
1626
|
+
|
|
1644
1627
|
</dd>
|
|
1645
1628
|
</dl>
|
|
1646
1629
|
|
|
1647
1630
|
<dl>
|
|
1648
1631
|
<dd>
|
|
1649
1632
|
|
|
1650
|
-
**request:** `phenoml.fhir.FhirUpsertRequest`
|
|
1651
|
-
|
|
1633
|
+
**request:** `phenoml.fhir.FhirUpsertRequest`
|
|
1634
|
+
|
|
1652
1635
|
</dd>
|
|
1653
1636
|
</dl>
|
|
1654
1637
|
|
|
1655
1638
|
<dl>
|
|
1656
1639
|
<dd>
|
|
1657
1640
|
|
|
1658
|
-
**requestOptions:** `Fhir.RequestOptions`
|
|
1659
|
-
|
|
1641
|
+
**requestOptions:** `Fhir.RequestOptions`
|
|
1642
|
+
|
|
1660
1643
|
</dd>
|
|
1661
1644
|
</dl>
|
|
1662
1645
|
</dd>
|
|
1663
1646
|
</dl>
|
|
1664
1647
|
|
|
1648
|
+
|
|
1665
1649
|
</dd>
|
|
1666
1650
|
</dl>
|
|
1667
1651
|
</details>
|
|
@@ -1681,7 +1665,6 @@ Examples:
|
|
|
1681
1665
|
Deletes a FHIR resource from the specified provider.
|
|
1682
1666
|
|
|
1683
1667
|
The request is proxied to the configured FHIR server with appropriate authentication headers.
|
|
1684
|
-
|
|
1685
1668
|
</dd>
|
|
1686
1669
|
</dl>
|
|
1687
1670
|
</dd>
|
|
@@ -1697,10 +1680,10 @@ The request is proxied to the configured FHIR server with appropriate authentica
|
|
|
1697
1680
|
|
|
1698
1681
|
```typescript
|
|
1699
1682
|
await client.fhir.delete("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
1700
|
-
"X-Phenoml-On-Behalf-Of": "user@example.com"
|
|
1683
|
+
"X-Phenoml-On-Behalf-Of": "user@example.com"
|
|
1701
1684
|
});
|
|
1702
|
-
```
|
|
1703
1685
|
|
|
1686
|
+
```
|
|
1704
1687
|
</dd>
|
|
1705
1688
|
</dl>
|
|
1706
1689
|
</dd>
|
|
@@ -1714,49 +1697,48 @@ await client.fhir.delete("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
|
1714
1697
|
<dl>
|
|
1715
1698
|
<dd>
|
|
1716
1699
|
|
|
1717
|
-
**fhirProviderId:** `string`
|
|
1700
|
+
**fhirProviderId:** `string`
|
|
1718
1701
|
|
|
1719
1702
|
The ID of the FHIR provider to use. Can be either:
|
|
1720
|
-
|
|
1721
1703
|
- A UUID representing the provider ID
|
|
1722
1704
|
- A provider name (legacy support - will just use the most recently updated provider with this name)
|
|
1723
|
-
|
|
1705
|
+
|
|
1724
1706
|
</dd>
|
|
1725
1707
|
</dl>
|
|
1726
1708
|
|
|
1727
1709
|
<dl>
|
|
1728
1710
|
<dd>
|
|
1729
1711
|
|
|
1730
|
-
**fhirPath:** `string`
|
|
1712
|
+
**fhirPath:** `string`
|
|
1731
1713
|
|
|
1732
1714
|
The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
|
|
1733
1715
|
Examples:
|
|
1734
|
-
|
|
1735
1716
|
- "Patient" (for resource type operations)
|
|
1736
1717
|
- "Patient/123" (for specific resource operations)
|
|
1737
|
-
- "Patient/123
|
|
1738
|
-
|
|
1718
|
+
- "Patient/123/_history" (for history operations)
|
|
1719
|
+
|
|
1739
1720
|
</dd>
|
|
1740
1721
|
</dl>
|
|
1741
1722
|
|
|
1742
1723
|
<dl>
|
|
1743
1724
|
<dd>
|
|
1744
1725
|
|
|
1745
|
-
**request:** `phenoml.fhir.FhirDeleteRequest`
|
|
1746
|
-
|
|
1726
|
+
**request:** `phenoml.fhir.FhirDeleteRequest`
|
|
1727
|
+
|
|
1747
1728
|
</dd>
|
|
1748
1729
|
</dl>
|
|
1749
1730
|
|
|
1750
1731
|
<dl>
|
|
1751
1732
|
<dd>
|
|
1752
1733
|
|
|
1753
|
-
**requestOptions:** `Fhir.RequestOptions`
|
|
1754
|
-
|
|
1734
|
+
**requestOptions:** `Fhir.RequestOptions`
|
|
1735
|
+
|
|
1755
1736
|
</dd>
|
|
1756
1737
|
</dl>
|
|
1757
1738
|
</dd>
|
|
1758
1739
|
</dl>
|
|
1759
1740
|
|
|
1741
|
+
|
|
1760
1742
|
</dd>
|
|
1761
1743
|
</dl>
|
|
1762
1744
|
</details>
|
|
@@ -1776,13 +1758,11 @@ Examples:
|
|
|
1776
1758
|
Partially updates a FHIR resource on the specified provider using JSON Patch operations as defined in RFC 6902.
|
|
1777
1759
|
|
|
1778
1760
|
The request body should contain an array of JSON Patch operations. Each operation specifies:
|
|
1779
|
-
|
|
1780
1761
|
- `op`: The operation type (add, remove, replace, move, copy, test)
|
|
1781
1762
|
- `path`: JSON Pointer to the target location in the resource
|
|
1782
1763
|
- `value`: The value to use (required for add, replace, and test operations)
|
|
1783
1764
|
|
|
1784
1765
|
The request is proxied to the configured FHIR server with appropriate authentication headers.
|
|
1785
|
-
|
|
1786
1766
|
</dd>
|
|
1787
1767
|
</dl>
|
|
1788
1768
|
</dd>
|
|
@@ -1799,16 +1779,14 @@ The request is proxied to the configured FHIR server with appropriate authentica
|
|
|
1799
1779
|
```typescript
|
|
1800
1780
|
await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
1801
1781
|
"X-Phenoml-On-Behalf-Of": "user@example.com",
|
|
1802
|
-
body: [
|
|
1803
|
-
{
|
|
1782
|
+
body: [{
|
|
1804
1783
|
op: "replace",
|
|
1805
1784
|
path: "/name/0/family",
|
|
1806
|
-
value: "NewFamilyName"
|
|
1807
|
-
}
|
|
1808
|
-
],
|
|
1785
|
+
value: "NewFamilyName"
|
|
1786
|
+
}]
|
|
1809
1787
|
});
|
|
1810
|
-
```
|
|
1811
1788
|
|
|
1789
|
+
```
|
|
1812
1790
|
</dd>
|
|
1813
1791
|
</dl>
|
|
1814
1792
|
</dd>
|
|
@@ -1822,49 +1800,48 @@ await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
|
|
|
1822
1800
|
<dl>
|
|
1823
1801
|
<dd>
|
|
1824
1802
|
|
|
1825
|
-
**fhirProviderId:** `string`
|
|
1803
|
+
**fhirProviderId:** `string`
|
|
1826
1804
|
|
|
1827
1805
|
The ID of the FHIR provider to use. Can be either:
|
|
1828
|
-
|
|
1829
1806
|
- A UUID representing the provider ID
|
|
1830
1807
|
- A provider name (legacy support - will just use the most recently updated provider with this name)
|
|
1831
|
-
|
|
1808
|
+
|
|
1832
1809
|
</dd>
|
|
1833
1810
|
</dl>
|
|
1834
1811
|
|
|
1835
1812
|
<dl>
|
|
1836
1813
|
<dd>
|
|
1837
1814
|
|
|
1838
|
-
**fhirPath:** `string`
|
|
1815
|
+
**fhirPath:** `string`
|
|
1839
1816
|
|
|
1840
1817
|
The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
|
|
1841
1818
|
Examples:
|
|
1842
|
-
|
|
1843
1819
|
- "Patient" (for resource type operations)
|
|
1844
1820
|
- "Patient/123" (for specific resource operations)
|
|
1845
|
-
- "Patient/123
|
|
1846
|
-
|
|
1821
|
+
- "Patient/123/_history" (for history operations)
|
|
1822
|
+
|
|
1847
1823
|
</dd>
|
|
1848
1824
|
</dl>
|
|
1849
1825
|
|
|
1850
1826
|
<dl>
|
|
1851
1827
|
<dd>
|
|
1852
1828
|
|
|
1853
|
-
**request:** `phenoml.fhir.FhirPatchRequest`
|
|
1854
|
-
|
|
1829
|
+
**request:** `phenoml.fhir.FhirPatchRequest`
|
|
1830
|
+
|
|
1855
1831
|
</dd>
|
|
1856
1832
|
</dl>
|
|
1857
1833
|
|
|
1858
1834
|
<dl>
|
|
1859
1835
|
<dd>
|
|
1860
1836
|
|
|
1861
|
-
**requestOptions:** `Fhir.RequestOptions`
|
|
1862
|
-
|
|
1837
|
+
**requestOptions:** `Fhir.RequestOptions`
|
|
1838
|
+
|
|
1863
1839
|
</dd>
|
|
1864
1840
|
</dl>
|
|
1865
1841
|
</dd>
|
|
1866
1842
|
</dl>
|
|
1867
1843
|
|
|
1844
|
+
|
|
1868
1845
|
</dd>
|
|
1869
1846
|
</dl>
|
|
1870
1847
|
</details>
|
|
@@ -1886,7 +1863,6 @@ Executes a FHIR Bundle transaction or batch operation on the specified provider.
|
|
|
1886
1863
|
The request body should contain a valid FHIR Bundle resource with transaction or batch type.
|
|
1887
1864
|
|
|
1888
1865
|
The request is proxied to the configured FHIR server with appropriate authentication headers.
|
|
1889
|
-
|
|
1890
1866
|
</dd>
|
|
1891
1867
|
</dl>
|
|
1892
1868
|
</dd>
|
|
@@ -1905,40 +1881,39 @@ await client.fhir.executeBundle("550e8400-e29b-41d4-a716-446655440000", {
|
|
|
1905
1881
|
"X-Phenoml-On-Behalf-Of": "user@example.com",
|
|
1906
1882
|
body: {
|
|
1907
1883
|
resourceType: "Bundle",
|
|
1908
|
-
entry: [
|
|
1909
|
-
{
|
|
1884
|
+
entry: [{
|
|
1910
1885
|
resource: {
|
|
1911
|
-
resourceType: "Patient",
|
|
1912
|
-
name: [
|
|
1886
|
+
"resourceType": "Patient",
|
|
1887
|
+
"name": [
|
|
1913
1888
|
{
|
|
1914
|
-
family: "Doe",
|
|
1915
|
-
given: [
|
|
1916
|
-
|
|
1917
|
-
|
|
1889
|
+
"family": "Doe",
|
|
1890
|
+
"given": [
|
|
1891
|
+
"John"
|
|
1892
|
+
]
|
|
1893
|
+
}
|
|
1894
|
+
]
|
|
1918
1895
|
},
|
|
1919
1896
|
request: {
|
|
1920
1897
|
method: "POST",
|
|
1921
|
-
url: "Patient"
|
|
1922
|
-
}
|
|
1923
|
-
},
|
|
1924
|
-
{
|
|
1898
|
+
url: "Patient"
|
|
1899
|
+
}
|
|
1900
|
+
}, {
|
|
1925
1901
|
resource: {
|
|
1926
|
-
resourceType: "Observation",
|
|
1927
|
-
status: "final",
|
|
1928
|
-
subject: {
|
|
1929
|
-
reference: "Patient/123"
|
|
1930
|
-
}
|
|
1902
|
+
"resourceType": "Observation",
|
|
1903
|
+
"status": "final",
|
|
1904
|
+
"subject": {
|
|
1905
|
+
"reference": "Patient/123"
|
|
1906
|
+
}
|
|
1931
1907
|
},
|
|
1932
1908
|
request: {
|
|
1933
1909
|
method: "POST",
|
|
1934
|
-
url: "Observation"
|
|
1935
|
-
}
|
|
1936
|
-
}
|
|
1937
|
-
|
|
1938
|
-
},
|
|
1910
|
+
url: "Observation"
|
|
1911
|
+
}
|
|
1912
|
+
}]
|
|
1913
|
+
}
|
|
1939
1914
|
});
|
|
1940
|
-
```
|
|
1941
1915
|
|
|
1916
|
+
```
|
|
1942
1917
|
</dd>
|
|
1943
1918
|
</dl>
|
|
1944
1919
|
</dd>
|
|
@@ -1952,40 +1927,39 @@ await client.fhir.executeBundle("550e8400-e29b-41d4-a716-446655440000", {
|
|
|
1952
1927
|
<dl>
|
|
1953
1928
|
<dd>
|
|
1954
1929
|
|
|
1955
|
-
**fhirProviderId:** `string`
|
|
1930
|
+
**fhirProviderId:** `string`
|
|
1956
1931
|
|
|
1957
1932
|
The ID of the FHIR provider to use. Can be either:
|
|
1958
|
-
|
|
1959
1933
|
- A UUID representing the provider ID
|
|
1960
1934
|
- A provider name (legacy support - will just use the most recently updated provider with this name)
|
|
1961
|
-
|
|
1935
|
+
|
|
1962
1936
|
</dd>
|
|
1963
1937
|
</dl>
|
|
1964
1938
|
|
|
1965
1939
|
<dl>
|
|
1966
1940
|
<dd>
|
|
1967
1941
|
|
|
1968
|
-
**request:** `phenoml.fhir.FhirExecuteBundleRequest`
|
|
1969
|
-
|
|
1942
|
+
**request:** `phenoml.fhir.FhirExecuteBundleRequest`
|
|
1943
|
+
|
|
1970
1944
|
</dd>
|
|
1971
1945
|
</dl>
|
|
1972
1946
|
|
|
1973
1947
|
<dl>
|
|
1974
1948
|
<dd>
|
|
1975
1949
|
|
|
1976
|
-
**requestOptions:** `Fhir.RequestOptions`
|
|
1977
|
-
|
|
1950
|
+
**requestOptions:** `Fhir.RequestOptions`
|
|
1951
|
+
|
|
1978
1952
|
</dd>
|
|
1979
1953
|
</dl>
|
|
1980
1954
|
</dd>
|
|
1981
1955
|
</dl>
|
|
1982
1956
|
|
|
1957
|
+
|
|
1983
1958
|
</dd>
|
|
1984
1959
|
</dl>
|
|
1985
1960
|
</details>
|
|
1986
1961
|
|
|
1987
1962
|
## FhirProvider
|
|
1988
|
-
|
|
1989
1963
|
<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">create</a>({ ...params }) -> phenoml.FhirProviderResponse</code></summary>
|
|
1990
1964
|
<dl>
|
|
1991
1965
|
<dd>
|
|
@@ -1999,7 +1973,6 @@ The ID of the FHIR provider to use. Can be either:
|
|
|
1999
1973
|
<dd>
|
|
2000
1974
|
|
|
2001
1975
|
Creates a new FHIR provider configuration with authentication credentials
|
|
2002
|
-
|
|
2003
1976
|
</dd>
|
|
2004
1977
|
</dl>
|
|
2005
1978
|
</dd>
|
|
@@ -2018,10 +1991,10 @@ await client.fhirProvider.create({
|
|
|
2018
1991
|
name: "Epic Sandbox",
|
|
2019
1992
|
provider: "athenahealth",
|
|
2020
1993
|
auth_method: "client_secret",
|
|
2021
|
-
base_url: "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4"
|
|
1994
|
+
base_url: "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4"
|
|
2022
1995
|
});
|
|
2023
|
-
```
|
|
2024
1996
|
|
|
1997
|
+
```
|
|
2025
1998
|
</dd>
|
|
2026
1999
|
</dl>
|
|
2027
2000
|
</dd>
|
|
@@ -2035,21 +2008,22 @@ await client.fhirProvider.create({
|
|
|
2035
2008
|
<dl>
|
|
2036
2009
|
<dd>
|
|
2037
2010
|
|
|
2038
|
-
**request:** `phenoml.fhirProvider.FhirProviderCreateRequest`
|
|
2039
|
-
|
|
2011
|
+
**request:** `phenoml.fhirProvider.FhirProviderCreateRequest`
|
|
2012
|
+
|
|
2040
2013
|
</dd>
|
|
2041
2014
|
</dl>
|
|
2042
2015
|
|
|
2043
2016
|
<dl>
|
|
2044
2017
|
<dd>
|
|
2045
2018
|
|
|
2046
|
-
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2047
|
-
|
|
2019
|
+
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2020
|
+
|
|
2048
2021
|
</dd>
|
|
2049
2022
|
</dl>
|
|
2050
2023
|
</dd>
|
|
2051
2024
|
</dl>
|
|
2052
2025
|
|
|
2026
|
+
|
|
2053
2027
|
</dd>
|
|
2054
2028
|
</dl>
|
|
2055
2029
|
</details>
|
|
@@ -2067,7 +2041,6 @@ await client.fhirProvider.create({
|
|
|
2067
2041
|
<dd>
|
|
2068
2042
|
|
|
2069
2043
|
Retrieves a list of all active FHIR providers for the authenticated user
|
|
2070
|
-
|
|
2071
2044
|
</dd>
|
|
2072
2045
|
</dl>
|
|
2073
2046
|
</dd>
|
|
@@ -2083,8 +2056,8 @@ Retrieves a list of all active FHIR providers for the authenticated user
|
|
|
2083
2056
|
|
|
2084
2057
|
```typescript
|
|
2085
2058
|
await client.fhirProvider.list();
|
|
2086
|
-
```
|
|
2087
2059
|
|
|
2060
|
+
```
|
|
2088
2061
|
</dd>
|
|
2089
2062
|
</dl>
|
|
2090
2063
|
</dd>
|
|
@@ -2098,13 +2071,14 @@ await client.fhirProvider.list();
|
|
|
2098
2071
|
<dl>
|
|
2099
2072
|
<dd>
|
|
2100
2073
|
|
|
2101
|
-
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2102
|
-
|
|
2074
|
+
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2075
|
+
|
|
2103
2076
|
</dd>
|
|
2104
2077
|
</dl>
|
|
2105
2078
|
</dd>
|
|
2106
2079
|
</dl>
|
|
2107
2080
|
|
|
2081
|
+
|
|
2108
2082
|
</dd>
|
|
2109
2083
|
</dl>
|
|
2110
2084
|
</details>
|
|
@@ -2122,7 +2096,6 @@ await client.fhirProvider.list();
|
|
|
2122
2096
|
<dd>
|
|
2123
2097
|
|
|
2124
2098
|
Retrieves a specific FHIR provider configuration by its ID
|
|
2125
|
-
|
|
2126
2099
|
</dd>
|
|
2127
2100
|
</dl>
|
|
2128
2101
|
</dd>
|
|
@@ -2138,8 +2111,8 @@ Retrieves a specific FHIR provider configuration by its ID
|
|
|
2138
2111
|
|
|
2139
2112
|
```typescript
|
|
2140
2113
|
await client.fhirProvider.get("fhir_provider_id");
|
|
2141
|
-
```
|
|
2142
2114
|
|
|
2115
|
+
```
|
|
2143
2116
|
</dd>
|
|
2144
2117
|
</dl>
|
|
2145
2118
|
</dd>
|
|
@@ -2154,20 +2127,21 @@ await client.fhirProvider.get("fhir_provider_id");
|
|
|
2154
2127
|
<dd>
|
|
2155
2128
|
|
|
2156
2129
|
**fhirProviderId:** `string` — ID of the FHIR provider to retrieve
|
|
2157
|
-
|
|
2130
|
+
|
|
2158
2131
|
</dd>
|
|
2159
2132
|
</dl>
|
|
2160
2133
|
|
|
2161
2134
|
<dl>
|
|
2162
2135
|
<dd>
|
|
2163
2136
|
|
|
2164
|
-
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2165
|
-
|
|
2137
|
+
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2138
|
+
|
|
2166
2139
|
</dd>
|
|
2167
2140
|
</dl>
|
|
2168
2141
|
</dd>
|
|
2169
2142
|
</dl>
|
|
2170
2143
|
|
|
2144
|
+
|
|
2171
2145
|
</dd>
|
|
2172
2146
|
</dl>
|
|
2173
2147
|
</details>
|
|
@@ -2185,7 +2159,6 @@ await client.fhirProvider.get("fhir_provider_id");
|
|
|
2185
2159
|
<dd>
|
|
2186
2160
|
|
|
2187
2161
|
Soft deletes a FHIR provider by setting is_active to false
|
|
2188
|
-
|
|
2189
2162
|
</dd>
|
|
2190
2163
|
</dl>
|
|
2191
2164
|
</dd>
|
|
@@ -2201,8 +2174,8 @@ Soft deletes a FHIR provider by setting is_active to false
|
|
|
2201
2174
|
|
|
2202
2175
|
```typescript
|
|
2203
2176
|
await client.fhirProvider.delete("fhir_provider_id");
|
|
2204
|
-
```
|
|
2205
2177
|
|
|
2178
|
+
```
|
|
2206
2179
|
</dd>
|
|
2207
2180
|
</dl>
|
|
2208
2181
|
</dd>
|
|
@@ -2217,20 +2190,21 @@ await client.fhirProvider.delete("fhir_provider_id");
|
|
|
2217
2190
|
<dd>
|
|
2218
2191
|
|
|
2219
2192
|
**fhirProviderId:** `string` — ID of the FHIR provider to delete
|
|
2220
|
-
|
|
2193
|
+
|
|
2221
2194
|
</dd>
|
|
2222
2195
|
</dl>
|
|
2223
2196
|
|
|
2224
2197
|
<dl>
|
|
2225
2198
|
<dd>
|
|
2226
2199
|
|
|
2227
|
-
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2228
|
-
|
|
2200
|
+
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2201
|
+
|
|
2229
2202
|
</dd>
|
|
2230
2203
|
</dl>
|
|
2231
2204
|
</dd>
|
|
2232
2205
|
</dl>
|
|
2233
2206
|
|
|
2207
|
+
|
|
2234
2208
|
</dd>
|
|
2235
2209
|
</dl>
|
|
2236
2210
|
</details>
|
|
@@ -2248,7 +2222,6 @@ await client.fhirProvider.delete("fhir_provider_id");
|
|
|
2248
2222
|
<dd>
|
|
2249
2223
|
|
|
2250
2224
|
Adds a new authentication configuration to an existing FHIR provider. This enables key rotation and multiple auth configurations per provider.
|
|
2251
|
-
|
|
2252
2225
|
</dd>
|
|
2253
2226
|
</dl>
|
|
2254
2227
|
</dd>
|
|
@@ -2264,10 +2237,10 @@ Adds a new authentication configuration to an existing FHIR provider. This enabl
|
|
|
2264
2237
|
|
|
2265
2238
|
```typescript
|
|
2266
2239
|
await client.fhirProvider.addAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad", {
|
|
2267
|
-
auth_method: "client_secret"
|
|
2240
|
+
auth_method: "client_secret"
|
|
2268
2241
|
});
|
|
2269
|
-
```
|
|
2270
2242
|
|
|
2243
|
+
```
|
|
2271
2244
|
</dd>
|
|
2272
2245
|
</dl>
|
|
2273
2246
|
</dd>
|
|
@@ -2282,28 +2255,29 @@ await client.fhirProvider.addAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad",
|
|
|
2282
2255
|
<dd>
|
|
2283
2256
|
|
|
2284
2257
|
**fhirProviderId:** `string` — ID of the FHIR provider to add auth config to
|
|
2285
|
-
|
|
2258
|
+
|
|
2286
2259
|
</dd>
|
|
2287
2260
|
</dl>
|
|
2288
2261
|
|
|
2289
2262
|
<dl>
|
|
2290
2263
|
<dd>
|
|
2291
2264
|
|
|
2292
|
-
**request:** `phenoml.fhirProvider.FhirProviderAddAuthConfigRequest`
|
|
2293
|
-
|
|
2265
|
+
**request:** `phenoml.fhirProvider.FhirProviderAddAuthConfigRequest`
|
|
2266
|
+
|
|
2294
2267
|
</dd>
|
|
2295
2268
|
</dl>
|
|
2296
2269
|
|
|
2297
2270
|
<dl>
|
|
2298
2271
|
<dd>
|
|
2299
2272
|
|
|
2300
|
-
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2301
|
-
|
|
2273
|
+
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2274
|
+
|
|
2302
2275
|
</dd>
|
|
2303
2276
|
</dl>
|
|
2304
2277
|
</dd>
|
|
2305
2278
|
</dl>
|
|
2306
2279
|
|
|
2280
|
+
|
|
2307
2281
|
</dd>
|
|
2308
2282
|
</dl>
|
|
2309
2283
|
</details>
|
|
@@ -2321,7 +2295,6 @@ await client.fhirProvider.addAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad",
|
|
|
2321
2295
|
<dd>
|
|
2322
2296
|
|
|
2323
2297
|
Sets which authentication configuration should be active for a FHIR provider. Only one auth config can be active at a time.
|
|
2324
|
-
|
|
2325
2298
|
</dd>
|
|
2326
2299
|
</dl>
|
|
2327
2300
|
</dd>
|
|
@@ -2337,10 +2310,10 @@ Sets which authentication configuration should be active for a FHIR provider. On
|
|
|
2337
2310
|
|
|
2338
2311
|
```typescript
|
|
2339
2312
|
await client.fhirProvider.setActiveAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad", {
|
|
2340
|
-
auth_config_id: "auth-config-123"
|
|
2313
|
+
auth_config_id: "auth-config-123"
|
|
2341
2314
|
});
|
|
2342
|
-
```
|
|
2343
2315
|
|
|
2316
|
+
```
|
|
2344
2317
|
</dd>
|
|
2345
2318
|
</dl>
|
|
2346
2319
|
</dd>
|
|
@@ -2355,28 +2328,29 @@ await client.fhirProvider.setActiveAuthConfig("1716d214-de93-43a4-aa6b-a878d864e
|
|
|
2355
2328
|
<dd>
|
|
2356
2329
|
|
|
2357
2330
|
**fhirProviderId:** `string` — ID of the FHIR provider
|
|
2358
|
-
|
|
2331
|
+
|
|
2359
2332
|
</dd>
|
|
2360
2333
|
</dl>
|
|
2361
2334
|
|
|
2362
2335
|
<dl>
|
|
2363
2336
|
<dd>
|
|
2364
2337
|
|
|
2365
|
-
**request:** `phenoml.fhirProvider.FhirProviderSetActiveAuthConfigRequest`
|
|
2366
|
-
|
|
2338
|
+
**request:** `phenoml.fhirProvider.FhirProviderSetActiveAuthConfigRequest`
|
|
2339
|
+
|
|
2367
2340
|
</dd>
|
|
2368
2341
|
</dl>
|
|
2369
2342
|
|
|
2370
2343
|
<dl>
|
|
2371
2344
|
<dd>
|
|
2372
2345
|
|
|
2373
|
-
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2374
|
-
|
|
2346
|
+
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2347
|
+
|
|
2375
2348
|
</dd>
|
|
2376
2349
|
</dl>
|
|
2377
2350
|
</dd>
|
|
2378
2351
|
</dl>
|
|
2379
2352
|
|
|
2353
|
+
|
|
2380
2354
|
</dd>
|
|
2381
2355
|
</dl>
|
|
2382
2356
|
</details>
|
|
@@ -2394,7 +2368,6 @@ await client.fhirProvider.setActiveAuthConfig("1716d214-de93-43a4-aa6b-a878d864e
|
|
|
2394
2368
|
<dd>
|
|
2395
2369
|
|
|
2396
2370
|
Removes an authentication configuration from a FHIR provider. Cannot remove the currently active auth configuration.
|
|
2397
|
-
|
|
2398
2371
|
</dd>
|
|
2399
2372
|
</dl>
|
|
2400
2373
|
</dd>
|
|
@@ -2410,10 +2383,10 @@ Removes an authentication configuration from a FHIR provider. Cannot remove the
|
|
|
2410
2383
|
|
|
2411
2384
|
```typescript
|
|
2412
2385
|
await client.fhirProvider.removeAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad", {
|
|
2413
|
-
auth_config_id: "auth-config-123"
|
|
2386
|
+
auth_config_id: "auth-config-123"
|
|
2414
2387
|
});
|
|
2415
|
-
```
|
|
2416
2388
|
|
|
2389
|
+
```
|
|
2417
2390
|
</dd>
|
|
2418
2391
|
</dl>
|
|
2419
2392
|
</dd>
|
|
@@ -2428,34 +2401,34 @@ await client.fhirProvider.removeAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad
|
|
|
2428
2401
|
<dd>
|
|
2429
2402
|
|
|
2430
2403
|
**fhirProviderId:** `string` — ID of the FHIR provider
|
|
2431
|
-
|
|
2404
|
+
|
|
2432
2405
|
</dd>
|
|
2433
2406
|
</dl>
|
|
2434
2407
|
|
|
2435
2408
|
<dl>
|
|
2436
2409
|
<dd>
|
|
2437
2410
|
|
|
2438
|
-
**request:** `phenoml.fhirProvider.FhirProviderRemoveAuthConfigRequest`
|
|
2439
|
-
|
|
2411
|
+
**request:** `phenoml.fhirProvider.FhirProviderRemoveAuthConfigRequest`
|
|
2412
|
+
|
|
2440
2413
|
</dd>
|
|
2441
2414
|
</dl>
|
|
2442
2415
|
|
|
2443
2416
|
<dl>
|
|
2444
2417
|
<dd>
|
|
2445
2418
|
|
|
2446
|
-
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2447
|
-
|
|
2419
|
+
**requestOptions:** `FhirProvider.RequestOptions`
|
|
2420
|
+
|
|
2448
2421
|
</dd>
|
|
2449
2422
|
</dl>
|
|
2450
2423
|
</dd>
|
|
2451
2424
|
</dl>
|
|
2452
2425
|
|
|
2426
|
+
|
|
2453
2427
|
</dd>
|
|
2454
2428
|
</dl>
|
|
2455
2429
|
</details>
|
|
2456
2430
|
|
|
2457
2431
|
## Lang2Fhir
|
|
2458
|
-
|
|
2459
2432
|
<details><summary><code>client.lang2Fhir.<a href="/src/api/resources/lang2Fhir/client/Client.ts">create</a>({ ...params }) -> phenoml.FhirResource</code></summary>
|
|
2460
2433
|
<dl>
|
|
2461
2434
|
<dd>
|
|
@@ -2469,7 +2442,6 @@ await client.fhirProvider.removeAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad
|
|
|
2469
2442
|
<dd>
|
|
2470
2443
|
|
|
2471
2444
|
Converts natural language text into a structured FHIR resource
|
|
2472
|
-
|
|
2473
2445
|
</dd>
|
|
2474
2446
|
</dl>
|
|
2475
2447
|
</dd>
|
|
@@ -2487,10 +2459,10 @@ Converts natural language text into a structured FHIR resource
|
|
|
2487
2459
|
await client.lang2Fhir.create({
|
|
2488
2460
|
version: "R4",
|
|
2489
2461
|
resource: "auto",
|
|
2490
|
-
text: "Patient has severe asthma with acute exacerbation"
|
|
2462
|
+
text: "Patient has severe asthma with acute exacerbation"
|
|
2491
2463
|
});
|
|
2492
|
-
```
|
|
2493
2464
|
|
|
2465
|
+
```
|
|
2494
2466
|
</dd>
|
|
2495
2467
|
</dl>
|
|
2496
2468
|
</dd>
|
|
@@ -2504,21 +2476,22 @@ await client.lang2Fhir.create({
|
|
|
2504
2476
|
<dl>
|
|
2505
2477
|
<dd>
|
|
2506
2478
|
|
|
2507
|
-
**request:** `phenoml.lang2Fhir.CreateRequest`
|
|
2508
|
-
|
|
2479
|
+
**request:** `phenoml.lang2Fhir.CreateRequest`
|
|
2480
|
+
|
|
2509
2481
|
</dd>
|
|
2510
2482
|
</dl>
|
|
2511
2483
|
|
|
2512
2484
|
<dl>
|
|
2513
2485
|
<dd>
|
|
2514
2486
|
|
|
2515
|
-
**requestOptions:** `Lang2Fhir.RequestOptions`
|
|
2516
|
-
|
|
2487
|
+
**requestOptions:** `Lang2Fhir.RequestOptions`
|
|
2488
|
+
|
|
2517
2489
|
</dd>
|
|
2518
2490
|
</dl>
|
|
2519
2491
|
</dd>
|
|
2520
2492
|
</dl>
|
|
2521
2493
|
|
|
2494
|
+
|
|
2522
2495
|
</dd>
|
|
2523
2496
|
</dl>
|
|
2524
2497
|
</details>
|
|
@@ -2536,7 +2509,6 @@ await client.lang2Fhir.create({
|
|
|
2536
2509
|
<dd>
|
|
2537
2510
|
|
|
2538
2511
|
Converts natural language text into FHIR search parameters
|
|
2539
|
-
|
|
2540
2512
|
</dd>
|
|
2541
2513
|
</dl>
|
|
2542
2514
|
</dd>
|
|
@@ -2552,10 +2524,10 @@ Converts natural language text into FHIR search parameters
|
|
|
2552
2524
|
|
|
2553
2525
|
```typescript
|
|
2554
2526
|
await client.lang2Fhir.search({
|
|
2555
|
-
text: "Appointments between March 2-9, 2025"
|
|
2527
|
+
text: "Appointments between March 2-9, 2025"
|
|
2556
2528
|
});
|
|
2557
|
-
```
|
|
2558
2529
|
|
|
2530
|
+
```
|
|
2559
2531
|
</dd>
|
|
2560
2532
|
</dl>
|
|
2561
2533
|
</dd>
|
|
@@ -2569,21 +2541,22 @@ await client.lang2Fhir.search({
|
|
|
2569
2541
|
<dl>
|
|
2570
2542
|
<dd>
|
|
2571
2543
|
|
|
2572
|
-
**request:** `phenoml.lang2Fhir.SearchRequest`
|
|
2573
|
-
|
|
2544
|
+
**request:** `phenoml.lang2Fhir.SearchRequest`
|
|
2545
|
+
|
|
2574
2546
|
</dd>
|
|
2575
2547
|
</dl>
|
|
2576
2548
|
|
|
2577
2549
|
<dl>
|
|
2578
2550
|
<dd>
|
|
2579
2551
|
|
|
2580
|
-
**requestOptions:** `Lang2Fhir.RequestOptions`
|
|
2581
|
-
|
|
2552
|
+
**requestOptions:** `Lang2Fhir.RequestOptions`
|
|
2553
|
+
|
|
2582
2554
|
</dd>
|
|
2583
2555
|
</dl>
|
|
2584
2556
|
</dd>
|
|
2585
2557
|
</dl>
|
|
2586
2558
|
|
|
2559
|
+
|
|
2587
2560
|
</dd>
|
|
2588
2561
|
</dl>
|
|
2589
2562
|
</details>
|
|
@@ -2601,7 +2574,6 @@ await client.lang2Fhir.search({
|
|
|
2601
2574
|
<dd>
|
|
2602
2575
|
|
|
2603
2576
|
Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service
|
|
2604
|
-
|
|
2605
2577
|
</dd>
|
|
2606
2578
|
</dl>
|
|
2607
2579
|
</dd>
|
|
@@ -2619,10 +2591,10 @@ Upload a custom FHIR StructureDefinition profile for use with the lang2fhir serv
|
|
|
2619
2591
|
await client.lang2Fhir.uploadProfile({
|
|
2620
2592
|
version: "version",
|
|
2621
2593
|
resource: "custom-patient",
|
|
2622
|
-
profile: "profile"
|
|
2594
|
+
profile: "profile"
|
|
2623
2595
|
});
|
|
2624
|
-
```
|
|
2625
2596
|
|
|
2597
|
+
```
|
|
2626
2598
|
</dd>
|
|
2627
2599
|
</dl>
|
|
2628
2600
|
</dd>
|
|
@@ -2636,21 +2608,22 @@ await client.lang2Fhir.uploadProfile({
|
|
|
2636
2608
|
<dl>
|
|
2637
2609
|
<dd>
|
|
2638
2610
|
|
|
2639
|
-
**request:** `phenoml.lang2Fhir.ProfileUploadRequest`
|
|
2640
|
-
|
|
2611
|
+
**request:** `phenoml.lang2Fhir.ProfileUploadRequest`
|
|
2612
|
+
|
|
2641
2613
|
</dd>
|
|
2642
2614
|
</dl>
|
|
2643
2615
|
|
|
2644
2616
|
<dl>
|
|
2645
2617
|
<dd>
|
|
2646
2618
|
|
|
2647
|
-
**requestOptions:** `Lang2Fhir.RequestOptions`
|
|
2648
|
-
|
|
2619
|
+
**requestOptions:** `Lang2Fhir.RequestOptions`
|
|
2620
|
+
|
|
2649
2621
|
</dd>
|
|
2650
2622
|
</dl>
|
|
2651
2623
|
</dd>
|
|
2652
2624
|
</dl>
|
|
2653
2625
|
|
|
2626
|
+
|
|
2654
2627
|
</dd>
|
|
2655
2628
|
</dl>
|
|
2656
2629
|
</details>
|
|
@@ -2668,7 +2641,6 @@ await client.lang2Fhir.uploadProfile({
|
|
|
2668
2641
|
<dd>
|
|
2669
2642
|
|
|
2670
2643
|
Extracts text from a document (PDF or image) and converts it into a structured FHIR resource
|
|
2671
|
-
|
|
2672
2644
|
</dd>
|
|
2673
2645
|
</dl>
|
|
2674
2646
|
</dd>
|
|
@@ -2687,10 +2659,74 @@ await client.lang2Fhir.document({
|
|
|
2687
2659
|
version: "R4",
|
|
2688
2660
|
resource: "questionnaire",
|
|
2689
2661
|
content: "content",
|
|
2690
|
-
fileType: "application/pdf"
|
|
2662
|
+
fileType: "application/pdf"
|
|
2691
2663
|
});
|
|
2664
|
+
|
|
2692
2665
|
```
|
|
2666
|
+
</dd>
|
|
2667
|
+
</dl>
|
|
2668
|
+
</dd>
|
|
2669
|
+
</dl>
|
|
2670
|
+
|
|
2671
|
+
#### ⚙️ Parameters
|
|
2672
|
+
|
|
2673
|
+
<dl>
|
|
2674
|
+
<dd>
|
|
2675
|
+
|
|
2676
|
+
<dl>
|
|
2677
|
+
<dd>
|
|
2678
|
+
|
|
2679
|
+
**request:** `phenoml.lang2Fhir.DocumentRequest`
|
|
2680
|
+
|
|
2681
|
+
</dd>
|
|
2682
|
+
</dl>
|
|
2683
|
+
|
|
2684
|
+
<dl>
|
|
2685
|
+
<dd>
|
|
2686
|
+
|
|
2687
|
+
**requestOptions:** `Lang2Fhir.RequestOptions`
|
|
2688
|
+
|
|
2689
|
+
</dd>
|
|
2690
|
+
</dl>
|
|
2691
|
+
</dd>
|
|
2692
|
+
</dl>
|
|
2693
|
+
|
|
2694
|
+
|
|
2695
|
+
</dd>
|
|
2696
|
+
</dl>
|
|
2697
|
+
</details>
|
|
2698
|
+
|
|
2699
|
+
## Summary
|
|
2700
|
+
<details><summary><code>client.summary.<a href="/src/api/resources/summary/client/Client.ts">listTemplates</a>() -> phenoml.SummaryListTemplatesResponse</code></summary>
|
|
2701
|
+
<dl>
|
|
2702
|
+
<dd>
|
|
2703
|
+
|
|
2704
|
+
#### 📝 Description
|
|
2705
|
+
|
|
2706
|
+
<dl>
|
|
2707
|
+
<dd>
|
|
2708
|
+
|
|
2709
|
+
<dl>
|
|
2710
|
+
<dd>
|
|
2711
|
+
|
|
2712
|
+
Retrieves all summary templates for the authenticated user
|
|
2713
|
+
</dd>
|
|
2714
|
+
</dl>
|
|
2715
|
+
</dd>
|
|
2716
|
+
</dl>
|
|
2717
|
+
|
|
2718
|
+
#### 🔌 Usage
|
|
2719
|
+
|
|
2720
|
+
<dl>
|
|
2721
|
+
<dd>
|
|
2693
2722
|
|
|
2723
|
+
<dl>
|
|
2724
|
+
<dd>
|
|
2725
|
+
|
|
2726
|
+
```typescript
|
|
2727
|
+
await client.summary.listTemplates();
|
|
2728
|
+
|
|
2729
|
+
```
|
|
2694
2730
|
</dd>
|
|
2695
2731
|
</dl>
|
|
2696
2732
|
</dd>
|
|
@@ -2704,27 +2740,358 @@ await client.lang2Fhir.document({
|
|
|
2704
2740
|
<dl>
|
|
2705
2741
|
<dd>
|
|
2706
2742
|
|
|
2707
|
-
**
|
|
2743
|
+
**requestOptions:** `Summary.RequestOptions`
|
|
2744
|
+
|
|
2745
|
+
</dd>
|
|
2746
|
+
</dl>
|
|
2747
|
+
</dd>
|
|
2748
|
+
</dl>
|
|
2749
|
+
|
|
2708
2750
|
|
|
2709
2751
|
</dd>
|
|
2710
2752
|
</dl>
|
|
2753
|
+
</details>
|
|
2711
2754
|
|
|
2755
|
+
<details><summary><code>client.summary.<a href="/src/api/resources/summary/client/Client.ts">createTemplate</a>({ ...params }) -> phenoml.CreateSummaryTemplateResponse</code></summary>
|
|
2712
2756
|
<dl>
|
|
2713
2757
|
<dd>
|
|
2714
2758
|
|
|
2715
|
-
|
|
2759
|
+
#### 📝 Description
|
|
2716
2760
|
|
|
2761
|
+
<dl>
|
|
2762
|
+
<dd>
|
|
2763
|
+
|
|
2764
|
+
<dl>
|
|
2765
|
+
<dd>
|
|
2766
|
+
|
|
2767
|
+
Creates a summary template from an example using LLM function calling
|
|
2717
2768
|
</dd>
|
|
2718
2769
|
</dl>
|
|
2719
2770
|
</dd>
|
|
2720
2771
|
</dl>
|
|
2721
2772
|
|
|
2773
|
+
#### 🔌 Usage
|
|
2774
|
+
|
|
2775
|
+
<dl>
|
|
2776
|
+
<dd>
|
|
2777
|
+
|
|
2778
|
+
<dl>
|
|
2779
|
+
<dd>
|
|
2780
|
+
|
|
2781
|
+
```typescript
|
|
2782
|
+
await client.summary.createTemplate({
|
|
2783
|
+
name: "name",
|
|
2784
|
+
example_summary: "Patient John Doe, age 45, presents with hypertension diagnosed on 2024-01-15.",
|
|
2785
|
+
target_resources: ["Patient", "Condition", "Observation"],
|
|
2786
|
+
mode: "mode"
|
|
2787
|
+
});
|
|
2788
|
+
|
|
2789
|
+
```
|
|
2790
|
+
</dd>
|
|
2791
|
+
</dl>
|
|
2792
|
+
</dd>
|
|
2793
|
+
</dl>
|
|
2794
|
+
|
|
2795
|
+
#### ⚙️ Parameters
|
|
2796
|
+
|
|
2797
|
+
<dl>
|
|
2798
|
+
<dd>
|
|
2799
|
+
|
|
2800
|
+
<dl>
|
|
2801
|
+
<dd>
|
|
2802
|
+
|
|
2803
|
+
**request:** `phenoml.summary.CreateSummaryTemplateRequest`
|
|
2804
|
+
|
|
2805
|
+
</dd>
|
|
2806
|
+
</dl>
|
|
2807
|
+
|
|
2808
|
+
<dl>
|
|
2809
|
+
<dd>
|
|
2810
|
+
|
|
2811
|
+
**requestOptions:** `Summary.RequestOptions`
|
|
2812
|
+
|
|
2813
|
+
</dd>
|
|
2814
|
+
</dl>
|
|
2815
|
+
</dd>
|
|
2816
|
+
</dl>
|
|
2817
|
+
|
|
2818
|
+
|
|
2722
2819
|
</dd>
|
|
2723
2820
|
</dl>
|
|
2724
2821
|
</details>
|
|
2725
2822
|
|
|
2726
|
-
|
|
2823
|
+
<details><summary><code>client.summary.<a href="/src/api/resources/summary/client/Client.ts">getTemplate</a>(id) -> phenoml.SummaryGetTemplateResponse</code></summary>
|
|
2824
|
+
<dl>
|
|
2825
|
+
<dd>
|
|
2826
|
+
|
|
2827
|
+
#### 📝 Description
|
|
2828
|
+
|
|
2829
|
+
<dl>
|
|
2830
|
+
<dd>
|
|
2831
|
+
|
|
2832
|
+
<dl>
|
|
2833
|
+
<dd>
|
|
2834
|
+
|
|
2835
|
+
Retrieves a specific summary template
|
|
2836
|
+
</dd>
|
|
2837
|
+
</dl>
|
|
2838
|
+
</dd>
|
|
2839
|
+
</dl>
|
|
2840
|
+
|
|
2841
|
+
#### 🔌 Usage
|
|
2842
|
+
|
|
2843
|
+
<dl>
|
|
2844
|
+
<dd>
|
|
2845
|
+
|
|
2846
|
+
<dl>
|
|
2847
|
+
<dd>
|
|
2848
|
+
|
|
2849
|
+
```typescript
|
|
2850
|
+
await client.summary.getTemplate("id");
|
|
2851
|
+
|
|
2852
|
+
```
|
|
2853
|
+
</dd>
|
|
2854
|
+
</dl>
|
|
2855
|
+
</dd>
|
|
2856
|
+
</dl>
|
|
2857
|
+
|
|
2858
|
+
#### ⚙️ Parameters
|
|
2859
|
+
|
|
2860
|
+
<dl>
|
|
2861
|
+
<dd>
|
|
2862
|
+
|
|
2863
|
+
<dl>
|
|
2864
|
+
<dd>
|
|
2865
|
+
|
|
2866
|
+
**id:** `string` — Template ID
|
|
2867
|
+
|
|
2868
|
+
</dd>
|
|
2869
|
+
</dl>
|
|
2870
|
+
|
|
2871
|
+
<dl>
|
|
2872
|
+
<dd>
|
|
2873
|
+
|
|
2874
|
+
**requestOptions:** `Summary.RequestOptions`
|
|
2875
|
+
|
|
2876
|
+
</dd>
|
|
2877
|
+
</dl>
|
|
2878
|
+
</dd>
|
|
2879
|
+
</dl>
|
|
2880
|
+
|
|
2881
|
+
|
|
2882
|
+
</dd>
|
|
2883
|
+
</dl>
|
|
2884
|
+
</details>
|
|
2885
|
+
|
|
2886
|
+
<details><summary><code>client.summary.<a href="/src/api/resources/summary/client/Client.ts">updateTemplate</a>(id, { ...params }) -> phenoml.SummaryUpdateTemplateResponse</code></summary>
|
|
2887
|
+
<dl>
|
|
2888
|
+
<dd>
|
|
2889
|
+
|
|
2890
|
+
#### 📝 Description
|
|
2891
|
+
|
|
2892
|
+
<dl>
|
|
2893
|
+
<dd>
|
|
2894
|
+
|
|
2895
|
+
<dl>
|
|
2896
|
+
<dd>
|
|
2897
|
+
|
|
2898
|
+
Updates an existing summary template
|
|
2899
|
+
</dd>
|
|
2900
|
+
</dl>
|
|
2901
|
+
</dd>
|
|
2902
|
+
</dl>
|
|
2903
|
+
|
|
2904
|
+
#### 🔌 Usage
|
|
2905
|
+
|
|
2906
|
+
<dl>
|
|
2907
|
+
<dd>
|
|
2908
|
+
|
|
2909
|
+
<dl>
|
|
2910
|
+
<dd>
|
|
2911
|
+
|
|
2912
|
+
```typescript
|
|
2913
|
+
await client.summary.updateTemplate("id", {
|
|
2914
|
+
name: "name",
|
|
2915
|
+
template: "template",
|
|
2916
|
+
target_resources: ["target_resources"],
|
|
2917
|
+
mode: "mode"
|
|
2918
|
+
});
|
|
2919
|
+
|
|
2920
|
+
```
|
|
2921
|
+
</dd>
|
|
2922
|
+
</dl>
|
|
2923
|
+
</dd>
|
|
2924
|
+
</dl>
|
|
2925
|
+
|
|
2926
|
+
#### ⚙️ Parameters
|
|
2927
|
+
|
|
2928
|
+
<dl>
|
|
2929
|
+
<dd>
|
|
2930
|
+
|
|
2931
|
+
<dl>
|
|
2932
|
+
<dd>
|
|
2933
|
+
|
|
2934
|
+
**id:** `string` — Template ID
|
|
2935
|
+
|
|
2936
|
+
</dd>
|
|
2937
|
+
</dl>
|
|
2938
|
+
|
|
2939
|
+
<dl>
|
|
2940
|
+
<dd>
|
|
2941
|
+
|
|
2942
|
+
**request:** `phenoml.summary.UpdateSummaryTemplateRequest`
|
|
2943
|
+
|
|
2944
|
+
</dd>
|
|
2945
|
+
</dl>
|
|
2946
|
+
|
|
2947
|
+
<dl>
|
|
2948
|
+
<dd>
|
|
2949
|
+
|
|
2950
|
+
**requestOptions:** `Summary.RequestOptions`
|
|
2951
|
+
|
|
2952
|
+
</dd>
|
|
2953
|
+
</dl>
|
|
2954
|
+
</dd>
|
|
2955
|
+
</dl>
|
|
2956
|
+
|
|
2957
|
+
|
|
2958
|
+
</dd>
|
|
2959
|
+
</dl>
|
|
2960
|
+
</details>
|
|
2961
|
+
|
|
2962
|
+
<details><summary><code>client.summary.<a href="/src/api/resources/summary/client/Client.ts">deleteTemplate</a>(id) -> phenoml.SummaryDeleteTemplateResponse</code></summary>
|
|
2963
|
+
<dl>
|
|
2964
|
+
<dd>
|
|
2965
|
+
|
|
2966
|
+
#### 📝 Description
|
|
2967
|
+
|
|
2968
|
+
<dl>
|
|
2969
|
+
<dd>
|
|
2970
|
+
|
|
2971
|
+
<dl>
|
|
2972
|
+
<dd>
|
|
2973
|
+
|
|
2974
|
+
Deletes a summary template
|
|
2975
|
+
</dd>
|
|
2976
|
+
</dl>
|
|
2977
|
+
</dd>
|
|
2978
|
+
</dl>
|
|
2979
|
+
|
|
2980
|
+
#### 🔌 Usage
|
|
2981
|
+
|
|
2982
|
+
<dl>
|
|
2983
|
+
<dd>
|
|
2984
|
+
|
|
2985
|
+
<dl>
|
|
2986
|
+
<dd>
|
|
2987
|
+
|
|
2988
|
+
```typescript
|
|
2989
|
+
await client.summary.deleteTemplate("id");
|
|
2990
|
+
|
|
2991
|
+
```
|
|
2992
|
+
</dd>
|
|
2993
|
+
</dl>
|
|
2994
|
+
</dd>
|
|
2995
|
+
</dl>
|
|
2996
|
+
|
|
2997
|
+
#### ⚙️ Parameters
|
|
2998
|
+
|
|
2999
|
+
<dl>
|
|
3000
|
+
<dd>
|
|
3001
|
+
|
|
3002
|
+
<dl>
|
|
3003
|
+
<dd>
|
|
3004
|
+
|
|
3005
|
+
**id:** `string` — Template ID
|
|
3006
|
+
|
|
3007
|
+
</dd>
|
|
3008
|
+
</dl>
|
|
3009
|
+
|
|
3010
|
+
<dl>
|
|
3011
|
+
<dd>
|
|
3012
|
+
|
|
3013
|
+
**requestOptions:** `Summary.RequestOptions`
|
|
3014
|
+
|
|
3015
|
+
</dd>
|
|
3016
|
+
</dl>
|
|
3017
|
+
</dd>
|
|
3018
|
+
</dl>
|
|
3019
|
+
|
|
3020
|
+
|
|
3021
|
+
</dd>
|
|
3022
|
+
</dl>
|
|
3023
|
+
</details>
|
|
3024
|
+
|
|
3025
|
+
<details><summary><code>client.summary.<a href="/src/api/resources/summary/client/Client.ts">create</a>({ ...params }) -> phenoml.CreateSummaryResponse</code></summary>
|
|
3026
|
+
<dl>
|
|
3027
|
+
<dd>
|
|
3028
|
+
|
|
3029
|
+
#### 📝 Description
|
|
3030
|
+
|
|
3031
|
+
<dl>
|
|
3032
|
+
<dd>
|
|
3033
|
+
|
|
3034
|
+
<dl>
|
|
3035
|
+
<dd>
|
|
3036
|
+
|
|
3037
|
+
Creates a summary from FHIR resources using one of two modes:
|
|
3038
|
+
- **narrative**: Uses a template to substitute FHIR data into placeholders (requires template_id)
|
|
3039
|
+
- **flatten**: Flattens FHIR resources into a searchable format for RAG/search (no template needed)
|
|
3040
|
+
</dd>
|
|
3041
|
+
</dl>
|
|
3042
|
+
</dd>
|
|
3043
|
+
</dl>
|
|
3044
|
+
|
|
3045
|
+
#### 🔌 Usage
|
|
3046
|
+
|
|
3047
|
+
<dl>
|
|
3048
|
+
<dd>
|
|
3049
|
+
|
|
3050
|
+
<dl>
|
|
3051
|
+
<dd>
|
|
3052
|
+
|
|
3053
|
+
```typescript
|
|
3054
|
+
await client.summary.create({
|
|
3055
|
+
fhir_resources: {
|
|
3056
|
+
resourceType: "resourceType"
|
|
3057
|
+
}
|
|
3058
|
+
});
|
|
3059
|
+
|
|
3060
|
+
```
|
|
3061
|
+
</dd>
|
|
3062
|
+
</dl>
|
|
3063
|
+
</dd>
|
|
3064
|
+
</dl>
|
|
3065
|
+
|
|
3066
|
+
#### ⚙️ Parameters
|
|
3067
|
+
|
|
3068
|
+
<dl>
|
|
3069
|
+
<dd>
|
|
3070
|
+
|
|
3071
|
+
<dl>
|
|
3072
|
+
<dd>
|
|
3073
|
+
|
|
3074
|
+
**request:** `phenoml.summary.CreateSummaryRequest`
|
|
3075
|
+
|
|
3076
|
+
</dd>
|
|
3077
|
+
</dl>
|
|
3078
|
+
|
|
3079
|
+
<dl>
|
|
3080
|
+
<dd>
|
|
3081
|
+
|
|
3082
|
+
**requestOptions:** `Summary.RequestOptions`
|
|
3083
|
+
|
|
3084
|
+
</dd>
|
|
3085
|
+
</dl>
|
|
3086
|
+
</dd>
|
|
3087
|
+
</dl>
|
|
3088
|
+
|
|
2727
3089
|
|
|
3090
|
+
</dd>
|
|
3091
|
+
</dl>
|
|
3092
|
+
</details>
|
|
3093
|
+
|
|
3094
|
+
## Tools
|
|
2728
3095
|
<details><summary><code>client.tools.<a href="/src/api/resources/tools/client/Client.ts">createFhirResource</a>({ ...params }) -> phenoml.Lang2FhirAndCreateResponse</code></summary>
|
|
2729
3096
|
<dl>
|
|
2730
3097
|
<dd>
|
|
@@ -2738,7 +3105,6 @@ await client.lang2Fhir.document({
|
|
|
2738
3105
|
<dd>
|
|
2739
3106
|
|
|
2740
3107
|
Converts natural language to FHIR resource and optionally stores it in a FHIR server
|
|
2741
|
-
|
|
2742
3108
|
</dd>
|
|
2743
3109
|
</dl>
|
|
2744
3110
|
</dd>
|
|
@@ -2755,10 +3121,10 @@ Converts natural language to FHIR resource and optionally stores it in a FHIR se
|
|
|
2755
3121
|
```typescript
|
|
2756
3122
|
await client.tools.createFhirResource({
|
|
2757
3123
|
resource: "auto",
|
|
2758
|
-
text: "Patient John Doe has severe asthma with acute exacerbation"
|
|
3124
|
+
text: "Patient John Doe has severe asthma with acute exacerbation"
|
|
2759
3125
|
});
|
|
2760
|
-
```
|
|
2761
3126
|
|
|
3127
|
+
```
|
|
2762
3128
|
</dd>
|
|
2763
3129
|
</dl>
|
|
2764
3130
|
</dd>
|
|
@@ -2772,21 +3138,22 @@ await client.tools.createFhirResource({
|
|
|
2772
3138
|
<dl>
|
|
2773
3139
|
<dd>
|
|
2774
3140
|
|
|
2775
|
-
**request:** `phenoml.tools.Lang2FhirAndCreateRequest`
|
|
2776
|
-
|
|
3141
|
+
**request:** `phenoml.tools.Lang2FhirAndCreateRequest`
|
|
3142
|
+
|
|
2777
3143
|
</dd>
|
|
2778
3144
|
</dl>
|
|
2779
3145
|
|
|
2780
3146
|
<dl>
|
|
2781
3147
|
<dd>
|
|
2782
3148
|
|
|
2783
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
2784
|
-
|
|
3149
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3150
|
+
|
|
2785
3151
|
</dd>
|
|
2786
3152
|
</dl>
|
|
2787
3153
|
</dd>
|
|
2788
3154
|
</dl>
|
|
2789
3155
|
|
|
3156
|
+
|
|
2790
3157
|
</dd>
|
|
2791
3158
|
</dl>
|
|
2792
3159
|
</details>
|
|
@@ -2804,7 +3171,6 @@ await client.tools.createFhirResource({
|
|
|
2804
3171
|
<dd>
|
|
2805
3172
|
|
|
2806
3173
|
Converts natural language to FHIR search parameters and executes search in FHIR server
|
|
2807
|
-
|
|
2808
3174
|
</dd>
|
|
2809
3175
|
</dl>
|
|
2810
3176
|
</dd>
|
|
@@ -2820,10 +3186,10 @@ Converts natural language to FHIR search parameters and executes search in FHIR
|
|
|
2820
3186
|
|
|
2821
3187
|
```typescript
|
|
2822
3188
|
await client.tools.searchFhirResources({
|
|
2823
|
-
text: "Find all appointments for patient John Doe next week"
|
|
3189
|
+
text: "Find all appointments for patient John Doe next week"
|
|
2824
3190
|
});
|
|
2825
|
-
```
|
|
2826
3191
|
|
|
3192
|
+
```
|
|
2827
3193
|
</dd>
|
|
2828
3194
|
</dl>
|
|
2829
3195
|
</dd>
|
|
@@ -2837,21 +3203,22 @@ await client.tools.searchFhirResources({
|
|
|
2837
3203
|
<dl>
|
|
2838
3204
|
<dd>
|
|
2839
3205
|
|
|
2840
|
-
**request:** `phenoml.tools.Lang2FhirAndSearchRequest`
|
|
2841
|
-
|
|
3206
|
+
**request:** `phenoml.tools.Lang2FhirAndSearchRequest`
|
|
3207
|
+
|
|
2842
3208
|
</dd>
|
|
2843
3209
|
</dl>
|
|
2844
3210
|
|
|
2845
3211
|
<dl>
|
|
2846
3212
|
<dd>
|
|
2847
3213
|
|
|
2848
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
2849
|
-
|
|
3214
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3215
|
+
|
|
2850
3216
|
</dd>
|
|
2851
3217
|
</dl>
|
|
2852
3218
|
</dd>
|
|
2853
3219
|
</dl>
|
|
2854
3220
|
|
|
3221
|
+
|
|
2855
3222
|
</dd>
|
|
2856
3223
|
</dl>
|
|
2857
3224
|
</details>
|
|
@@ -2869,7 +3236,6 @@ await client.tools.searchFhirResources({
|
|
|
2869
3236
|
<dd>
|
|
2870
3237
|
|
|
2871
3238
|
Uses LLM to extract search concepts from natural language and builds patient cohorts with inclusion/exclusion criteria
|
|
2872
|
-
|
|
2873
3239
|
</dd>
|
|
2874
3240
|
</dl>
|
|
2875
3241
|
</dd>
|
|
@@ -2886,10 +3252,10 @@ Uses LLM to extract search concepts from natural language and builds patient coh
|
|
|
2886
3252
|
```typescript
|
|
2887
3253
|
await client.tools.analyzeCohort({
|
|
2888
3254
|
text: "female patients over 20 with diabetes but not hypertension",
|
|
2889
|
-
provider: "550e8400-e29b-41d4-a716-446655440000"
|
|
3255
|
+
provider: "550e8400-e29b-41d4-a716-446655440000"
|
|
2890
3256
|
});
|
|
2891
|
-
```
|
|
2892
3257
|
|
|
3258
|
+
```
|
|
2893
3259
|
</dd>
|
|
2894
3260
|
</dl>
|
|
2895
3261
|
</dd>
|
|
@@ -2903,27 +3269,27 @@ await client.tools.analyzeCohort({
|
|
|
2903
3269
|
<dl>
|
|
2904
3270
|
<dd>
|
|
2905
3271
|
|
|
2906
|
-
**request:** `phenoml.tools.CohortRequest`
|
|
2907
|
-
|
|
3272
|
+
**request:** `phenoml.tools.CohortRequest`
|
|
3273
|
+
|
|
2908
3274
|
</dd>
|
|
2909
3275
|
</dl>
|
|
2910
3276
|
|
|
2911
3277
|
<dl>
|
|
2912
3278
|
<dd>
|
|
2913
3279
|
|
|
2914
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
2915
|
-
|
|
3280
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3281
|
+
|
|
2916
3282
|
</dd>
|
|
2917
3283
|
</dl>
|
|
2918
3284
|
</dd>
|
|
2919
3285
|
</dl>
|
|
2920
3286
|
|
|
3287
|
+
|
|
2921
3288
|
</dd>
|
|
2922
3289
|
</dl>
|
|
2923
3290
|
</details>
|
|
2924
3291
|
|
|
2925
3292
|
## Tools McpServer
|
|
2926
|
-
|
|
2927
3293
|
<details><summary><code>client.tools.mcpServer.<a href="/src/api/resources/tools/resources/mcpServer/client/Client.ts">create</a>({ ...params }) -> phenoml.McpServerResponse</code></summary>
|
|
2928
3294
|
<dl>
|
|
2929
3295
|
<dd>
|
|
@@ -2937,7 +3303,6 @@ await client.tools.analyzeCohort({
|
|
|
2937
3303
|
<dd>
|
|
2938
3304
|
|
|
2939
3305
|
Creates a new MCP server
|
|
2940
|
-
|
|
2941
3306
|
</dd>
|
|
2942
3307
|
</dl>
|
|
2943
3308
|
</dd>
|
|
@@ -2954,10 +3319,10 @@ Creates a new MCP server
|
|
|
2954
3319
|
```typescript
|
|
2955
3320
|
await client.tools.mcpServer.create({
|
|
2956
3321
|
name: "My MCP Server",
|
|
2957
|
-
mcp_server_url: "https://mcp.example.com"
|
|
3322
|
+
mcp_server_url: "https://mcp.example.com"
|
|
2958
3323
|
});
|
|
2959
|
-
```
|
|
2960
3324
|
|
|
3325
|
+
```
|
|
2961
3326
|
</dd>
|
|
2962
3327
|
</dl>
|
|
2963
3328
|
</dd>
|
|
@@ -2971,21 +3336,22 @@ await client.tools.mcpServer.create({
|
|
|
2971
3336
|
<dl>
|
|
2972
3337
|
<dd>
|
|
2973
3338
|
|
|
2974
|
-
**request:** `phenoml.tools.McpServerCreateRequest`
|
|
2975
|
-
|
|
3339
|
+
**request:** `phenoml.tools.McpServerCreateRequest`
|
|
3340
|
+
|
|
2976
3341
|
</dd>
|
|
2977
3342
|
</dl>
|
|
2978
3343
|
|
|
2979
3344
|
<dl>
|
|
2980
3345
|
<dd>
|
|
2981
3346
|
|
|
2982
|
-
**requestOptions:** `McpServer.RequestOptions`
|
|
2983
|
-
|
|
3347
|
+
**requestOptions:** `McpServer.RequestOptions`
|
|
3348
|
+
|
|
2984
3349
|
</dd>
|
|
2985
3350
|
</dl>
|
|
2986
3351
|
</dd>
|
|
2987
3352
|
</dl>
|
|
2988
3353
|
|
|
3354
|
+
|
|
2989
3355
|
</dd>
|
|
2990
3356
|
</dl>
|
|
2991
3357
|
</details>
|
|
@@ -3003,7 +3369,6 @@ await client.tools.mcpServer.create({
|
|
|
3003
3369
|
<dd>
|
|
3004
3370
|
|
|
3005
3371
|
Lists all MCP servers for a specific user
|
|
3006
|
-
|
|
3007
3372
|
</dd>
|
|
3008
3373
|
</dl>
|
|
3009
3374
|
</dd>
|
|
@@ -3019,8 +3384,8 @@ Lists all MCP servers for a specific user
|
|
|
3019
3384
|
|
|
3020
3385
|
```typescript
|
|
3021
3386
|
await client.tools.mcpServer.list();
|
|
3022
|
-
```
|
|
3023
3387
|
|
|
3388
|
+
```
|
|
3024
3389
|
</dd>
|
|
3025
3390
|
</dl>
|
|
3026
3391
|
</dd>
|
|
@@ -3034,13 +3399,14 @@ await client.tools.mcpServer.list();
|
|
|
3034
3399
|
<dl>
|
|
3035
3400
|
<dd>
|
|
3036
3401
|
|
|
3037
|
-
**requestOptions:** `McpServer.RequestOptions`
|
|
3038
|
-
|
|
3402
|
+
**requestOptions:** `McpServer.RequestOptions`
|
|
3403
|
+
|
|
3039
3404
|
</dd>
|
|
3040
3405
|
</dl>
|
|
3041
3406
|
</dd>
|
|
3042
3407
|
</dl>
|
|
3043
3408
|
|
|
3409
|
+
|
|
3044
3410
|
</dd>
|
|
3045
3411
|
</dl>
|
|
3046
3412
|
</details>
|
|
@@ -3058,7 +3424,6 @@ await client.tools.mcpServer.list();
|
|
|
3058
3424
|
<dd>
|
|
3059
3425
|
|
|
3060
3426
|
Gets a MCP server by ID
|
|
3061
|
-
|
|
3062
3427
|
</dd>
|
|
3063
3428
|
</dl>
|
|
3064
3429
|
</dd>
|
|
@@ -3074,8 +3439,8 @@ Gets a MCP server by ID
|
|
|
3074
3439
|
|
|
3075
3440
|
```typescript
|
|
3076
3441
|
await client.tools.mcpServer.get("mcp_server_id");
|
|
3077
|
-
```
|
|
3078
3442
|
|
|
3443
|
+
```
|
|
3079
3444
|
</dd>
|
|
3080
3445
|
</dl>
|
|
3081
3446
|
</dd>
|
|
@@ -3090,20 +3455,21 @@ await client.tools.mcpServer.get("mcp_server_id");
|
|
|
3090
3455
|
<dd>
|
|
3091
3456
|
|
|
3092
3457
|
**mcpServerId:** `string` — ID of the MCP server to retrieve
|
|
3093
|
-
|
|
3458
|
+
|
|
3094
3459
|
</dd>
|
|
3095
3460
|
</dl>
|
|
3096
3461
|
|
|
3097
3462
|
<dl>
|
|
3098
3463
|
<dd>
|
|
3099
3464
|
|
|
3100
|
-
**requestOptions:** `McpServer.RequestOptions`
|
|
3101
|
-
|
|
3465
|
+
**requestOptions:** `McpServer.RequestOptions`
|
|
3466
|
+
|
|
3102
3467
|
</dd>
|
|
3103
3468
|
</dl>
|
|
3104
3469
|
</dd>
|
|
3105
3470
|
</dl>
|
|
3106
3471
|
|
|
3472
|
+
|
|
3107
3473
|
</dd>
|
|
3108
3474
|
</dl>
|
|
3109
3475
|
</details>
|
|
@@ -3121,7 +3487,6 @@ await client.tools.mcpServer.get("mcp_server_id");
|
|
|
3121
3487
|
<dd>
|
|
3122
3488
|
|
|
3123
3489
|
Deletes a MCP server by ID
|
|
3124
|
-
|
|
3125
3490
|
</dd>
|
|
3126
3491
|
</dl>
|
|
3127
3492
|
</dd>
|
|
@@ -3137,8 +3502,8 @@ Deletes a MCP server by ID
|
|
|
3137
3502
|
|
|
3138
3503
|
```typescript
|
|
3139
3504
|
await client.tools.mcpServer.delete("mcp_server_id");
|
|
3140
|
-
```
|
|
3141
3505
|
|
|
3506
|
+
```
|
|
3142
3507
|
</dd>
|
|
3143
3508
|
</dl>
|
|
3144
3509
|
</dd>
|
|
@@ -3153,26 +3518,26 @@ await client.tools.mcpServer.delete("mcp_server_id");
|
|
|
3153
3518
|
<dd>
|
|
3154
3519
|
|
|
3155
3520
|
**mcpServerId:** `string` — ID of the MCP server to delete
|
|
3156
|
-
|
|
3521
|
+
|
|
3157
3522
|
</dd>
|
|
3158
3523
|
</dl>
|
|
3159
3524
|
|
|
3160
3525
|
<dl>
|
|
3161
3526
|
<dd>
|
|
3162
3527
|
|
|
3163
|
-
**requestOptions:** `McpServer.RequestOptions`
|
|
3164
|
-
|
|
3528
|
+
**requestOptions:** `McpServer.RequestOptions`
|
|
3529
|
+
|
|
3165
3530
|
</dd>
|
|
3166
3531
|
</dl>
|
|
3167
3532
|
</dd>
|
|
3168
3533
|
</dl>
|
|
3169
3534
|
|
|
3535
|
+
|
|
3170
3536
|
</dd>
|
|
3171
3537
|
</dl>
|
|
3172
3538
|
</details>
|
|
3173
3539
|
|
|
3174
3540
|
## Tools McpServer Tools
|
|
3175
|
-
|
|
3176
3541
|
<details><summary><code>client.tools.mcpServer.tools.<a href="/src/api/resources/tools/resources/mcpServer/resources/tools/client/Client.ts">list</a>(mcpServerId) -> phenoml.McpServerToolResponse</code></summary>
|
|
3177
3542
|
<dl>
|
|
3178
3543
|
<dd>
|
|
@@ -3186,7 +3551,6 @@ await client.tools.mcpServer.delete("mcp_server_id");
|
|
|
3186
3551
|
<dd>
|
|
3187
3552
|
|
|
3188
3553
|
Lists all MCP server tools for a specific MCP server
|
|
3189
|
-
|
|
3190
3554
|
</dd>
|
|
3191
3555
|
</dl>
|
|
3192
3556
|
</dd>
|
|
@@ -3202,8 +3566,8 @@ Lists all MCP server tools for a specific MCP server
|
|
|
3202
3566
|
|
|
3203
3567
|
```typescript
|
|
3204
3568
|
await client.tools.mcpServer.tools.list("mcp_server_id");
|
|
3205
|
-
```
|
|
3206
3569
|
|
|
3570
|
+
```
|
|
3207
3571
|
</dd>
|
|
3208
3572
|
</dl>
|
|
3209
3573
|
</dd>
|
|
@@ -3218,20 +3582,21 @@ await client.tools.mcpServer.tools.list("mcp_server_id");
|
|
|
3218
3582
|
<dd>
|
|
3219
3583
|
|
|
3220
3584
|
**mcpServerId:** `string` — ID of the MCP server to list tools for
|
|
3221
|
-
|
|
3585
|
+
|
|
3222
3586
|
</dd>
|
|
3223
3587
|
</dl>
|
|
3224
3588
|
|
|
3225
3589
|
<dl>
|
|
3226
3590
|
<dd>
|
|
3227
3591
|
|
|
3228
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
3229
|
-
|
|
3592
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3593
|
+
|
|
3230
3594
|
</dd>
|
|
3231
3595
|
</dl>
|
|
3232
3596
|
</dd>
|
|
3233
3597
|
</dl>
|
|
3234
3598
|
|
|
3599
|
+
|
|
3235
3600
|
</dd>
|
|
3236
3601
|
</dl>
|
|
3237
3602
|
</details>
|
|
@@ -3249,7 +3614,6 @@ await client.tools.mcpServer.tools.list("mcp_server_id");
|
|
|
3249
3614
|
<dd>
|
|
3250
3615
|
|
|
3251
3616
|
Gets a MCP server tool by ID
|
|
3252
|
-
|
|
3253
3617
|
</dd>
|
|
3254
3618
|
</dl>
|
|
3255
3619
|
</dd>
|
|
@@ -3265,8 +3629,8 @@ Gets a MCP server tool by ID
|
|
|
3265
3629
|
|
|
3266
3630
|
```typescript
|
|
3267
3631
|
await client.tools.mcpServer.tools.get("mcp_server_tool_id");
|
|
3268
|
-
```
|
|
3269
3632
|
|
|
3633
|
+
```
|
|
3270
3634
|
</dd>
|
|
3271
3635
|
</dl>
|
|
3272
3636
|
</dd>
|
|
@@ -3281,20 +3645,21 @@ await client.tools.mcpServer.tools.get("mcp_server_tool_id");
|
|
|
3281
3645
|
<dd>
|
|
3282
3646
|
|
|
3283
3647
|
**mcpServerToolId:** `string` — ID of the MCP server tool to retrieve
|
|
3284
|
-
|
|
3648
|
+
|
|
3285
3649
|
</dd>
|
|
3286
3650
|
</dl>
|
|
3287
3651
|
|
|
3288
3652
|
<dl>
|
|
3289
3653
|
<dd>
|
|
3290
3654
|
|
|
3291
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
3292
|
-
|
|
3655
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3656
|
+
|
|
3293
3657
|
</dd>
|
|
3294
3658
|
</dl>
|
|
3295
3659
|
</dd>
|
|
3296
3660
|
</dl>
|
|
3297
3661
|
|
|
3662
|
+
|
|
3298
3663
|
</dd>
|
|
3299
3664
|
</dl>
|
|
3300
3665
|
</details>
|
|
@@ -3312,7 +3677,6 @@ await client.tools.mcpServer.tools.get("mcp_server_tool_id");
|
|
|
3312
3677
|
<dd>
|
|
3313
3678
|
|
|
3314
3679
|
Deletes a MCP server tool by ID
|
|
3315
|
-
|
|
3316
3680
|
</dd>
|
|
3317
3681
|
</dl>
|
|
3318
3682
|
</dd>
|
|
@@ -3328,8 +3692,8 @@ Deletes a MCP server tool by ID
|
|
|
3328
3692
|
|
|
3329
3693
|
```typescript
|
|
3330
3694
|
await client.tools.mcpServer.tools.delete("mcp_server_tool_id");
|
|
3331
|
-
```
|
|
3332
3695
|
|
|
3696
|
+
```
|
|
3333
3697
|
</dd>
|
|
3334
3698
|
</dl>
|
|
3335
3699
|
</dd>
|
|
@@ -3344,20 +3708,21 @@ await client.tools.mcpServer.tools.delete("mcp_server_tool_id");
|
|
|
3344
3708
|
<dd>
|
|
3345
3709
|
|
|
3346
3710
|
**mcpServerToolId:** `string` — ID of the MCP server tool to delete
|
|
3347
|
-
|
|
3711
|
+
|
|
3348
3712
|
</dd>
|
|
3349
3713
|
</dl>
|
|
3350
3714
|
|
|
3351
3715
|
<dl>
|
|
3352
3716
|
<dd>
|
|
3353
3717
|
|
|
3354
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
3355
|
-
|
|
3718
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3719
|
+
|
|
3356
3720
|
</dd>
|
|
3357
3721
|
</dl>
|
|
3358
3722
|
</dd>
|
|
3359
3723
|
</dl>
|
|
3360
3724
|
|
|
3725
|
+
|
|
3361
3726
|
</dd>
|
|
3362
3727
|
</dl>
|
|
3363
3728
|
</details>
|
|
@@ -3375,7 +3740,6 @@ await client.tools.mcpServer.tools.delete("mcp_server_tool_id");
|
|
|
3375
3740
|
<dd>
|
|
3376
3741
|
|
|
3377
3742
|
Calls a MCP server tool
|
|
3378
|
-
|
|
3379
3743
|
</dd>
|
|
3380
3744
|
</dl>
|
|
3381
3745
|
</dd>
|
|
@@ -3392,11 +3756,11 @@ Calls a MCP server tool
|
|
|
3392
3756
|
```typescript
|
|
3393
3757
|
await client.tools.mcpServer.tools.call("mcp_server_tool_id", {
|
|
3394
3758
|
arguments: {
|
|
3395
|
-
title: "PhenoML Agent API"
|
|
3396
|
-
}
|
|
3759
|
+
"title": "PhenoML Agent API"
|
|
3760
|
+
}
|
|
3397
3761
|
});
|
|
3398
|
-
```
|
|
3399
3762
|
|
|
3763
|
+
```
|
|
3400
3764
|
</dd>
|
|
3401
3765
|
</dl>
|
|
3402
3766
|
</dd>
|
|
@@ -3411,34 +3775,34 @@ await client.tools.mcpServer.tools.call("mcp_server_tool_id", {
|
|
|
3411
3775
|
<dd>
|
|
3412
3776
|
|
|
3413
3777
|
**mcpServerToolId:** `string` — ID of the MCP server tool to call
|
|
3414
|
-
|
|
3778
|
+
|
|
3415
3779
|
</dd>
|
|
3416
3780
|
</dl>
|
|
3417
3781
|
|
|
3418
3782
|
<dl>
|
|
3419
3783
|
<dd>
|
|
3420
3784
|
|
|
3421
|
-
**request:** `phenoml.tools.mcpServer.McpServerToolCallRequest`
|
|
3422
|
-
|
|
3785
|
+
**request:** `phenoml.tools.mcpServer.McpServerToolCallRequest`
|
|
3786
|
+
|
|
3423
3787
|
</dd>
|
|
3424
3788
|
</dl>
|
|
3425
3789
|
|
|
3426
3790
|
<dl>
|
|
3427
3791
|
<dd>
|
|
3428
3792
|
|
|
3429
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
3430
|
-
|
|
3793
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3794
|
+
|
|
3431
3795
|
</dd>
|
|
3432
3796
|
</dl>
|
|
3433
3797
|
</dd>
|
|
3434
3798
|
</dl>
|
|
3435
3799
|
|
|
3800
|
+
|
|
3436
3801
|
</dd>
|
|
3437
3802
|
</dl>
|
|
3438
3803
|
</details>
|
|
3439
3804
|
|
|
3440
3805
|
## Workflows
|
|
3441
|
-
|
|
3442
3806
|
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">list</a>({ ...params }) -> phenoml.ListWorkflowsResponse</code></summary>
|
|
3443
3807
|
<dl>
|
|
3444
3808
|
<dd>
|
|
@@ -3452,7 +3816,6 @@ await client.tools.mcpServer.tools.call("mcp_server_tool_id", {
|
|
|
3452
3816
|
<dd>
|
|
3453
3817
|
|
|
3454
3818
|
Retrieves all workflow definitions for the authenticated user
|
|
3455
|
-
|
|
3456
3819
|
</dd>
|
|
3457
3820
|
</dl>
|
|
3458
3821
|
</dd>
|
|
@@ -3468,10 +3831,10 @@ Retrieves all workflow definitions for the authenticated user
|
|
|
3468
3831
|
|
|
3469
3832
|
```typescript
|
|
3470
3833
|
await client.workflows.list({
|
|
3471
|
-
verbose: true
|
|
3834
|
+
verbose: true
|
|
3472
3835
|
});
|
|
3473
|
-
```
|
|
3474
3836
|
|
|
3837
|
+
```
|
|
3475
3838
|
</dd>
|
|
3476
3839
|
</dl>
|
|
3477
3840
|
</dd>
|
|
@@ -3485,21 +3848,22 @@ await client.workflows.list({
|
|
|
3485
3848
|
<dl>
|
|
3486
3849
|
<dd>
|
|
3487
3850
|
|
|
3488
|
-
**request:** `phenoml.workflows.WorkflowsListRequest`
|
|
3489
|
-
|
|
3851
|
+
**request:** `phenoml.workflows.WorkflowsListRequest`
|
|
3852
|
+
|
|
3490
3853
|
</dd>
|
|
3491
3854
|
</dl>
|
|
3492
3855
|
|
|
3493
3856
|
<dl>
|
|
3494
3857
|
<dd>
|
|
3495
3858
|
|
|
3496
|
-
**requestOptions:** `Workflows.RequestOptions`
|
|
3497
|
-
|
|
3859
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
3860
|
+
|
|
3498
3861
|
</dd>
|
|
3499
3862
|
</dl>
|
|
3500
3863
|
</dd>
|
|
3501
3864
|
</dl>
|
|
3502
3865
|
|
|
3866
|
+
|
|
3503
3867
|
</dd>
|
|
3504
3868
|
</dl>
|
|
3505
3869
|
</details>
|
|
@@ -3517,7 +3881,6 @@ await client.workflows.list({
|
|
|
3517
3881
|
<dd>
|
|
3518
3882
|
|
|
3519
3883
|
Creates a new workflow definition with graph generation from workflow instructions
|
|
3520
|
-
|
|
3521
3884
|
</dd>
|
|
3522
3885
|
</dl>
|
|
3523
3886
|
</dd>
|
|
@@ -3537,14 +3900,14 @@ await client.workflows.create({
|
|
|
3537
3900
|
name: "Patient Data Mapping Workflow",
|
|
3538
3901
|
workflow_instructions: "Given diagnosis data, find the patient and create condition record",
|
|
3539
3902
|
sample_data: {
|
|
3540
|
-
patient_last_name: "Rippin",
|
|
3541
|
-
patient_first_name: "Clay",
|
|
3542
|
-
diagnosis_code: "I10"
|
|
3903
|
+
"patient_last_name": "Rippin",
|
|
3904
|
+
"patient_first_name": "Clay",
|
|
3905
|
+
"diagnosis_code": "I10"
|
|
3543
3906
|
},
|
|
3544
|
-
fhir_provider_id: "550e8400-e29b-41d4-a716-446655440000"
|
|
3907
|
+
fhir_provider_id: "550e8400-e29b-41d4-a716-446655440000"
|
|
3545
3908
|
});
|
|
3546
|
-
```
|
|
3547
3909
|
|
|
3910
|
+
```
|
|
3548
3911
|
</dd>
|
|
3549
3912
|
</dl>
|
|
3550
3913
|
</dd>
|
|
@@ -3558,21 +3921,22 @@ await client.workflows.create({
|
|
|
3558
3921
|
<dl>
|
|
3559
3922
|
<dd>
|
|
3560
3923
|
|
|
3561
|
-
**request:** `phenoml.workflows.CreateWorkflowRequest`
|
|
3562
|
-
|
|
3924
|
+
**request:** `phenoml.workflows.CreateWorkflowRequest`
|
|
3925
|
+
|
|
3563
3926
|
</dd>
|
|
3564
3927
|
</dl>
|
|
3565
3928
|
|
|
3566
3929
|
<dl>
|
|
3567
3930
|
<dd>
|
|
3568
3931
|
|
|
3569
|
-
**requestOptions:** `Workflows.RequestOptions`
|
|
3570
|
-
|
|
3932
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
3933
|
+
|
|
3571
3934
|
</dd>
|
|
3572
3935
|
</dl>
|
|
3573
3936
|
</dd>
|
|
3574
3937
|
</dl>
|
|
3575
3938
|
|
|
3939
|
+
|
|
3576
3940
|
</dd>
|
|
3577
3941
|
</dl>
|
|
3578
3942
|
</details>
|
|
@@ -3590,7 +3954,6 @@ await client.workflows.create({
|
|
|
3590
3954
|
<dd>
|
|
3591
3955
|
|
|
3592
3956
|
Retrieves a workflow definition by its ID
|
|
3593
|
-
|
|
3594
3957
|
</dd>
|
|
3595
3958
|
</dl>
|
|
3596
3959
|
</dd>
|
|
@@ -3606,10 +3969,10 @@ Retrieves a workflow definition by its ID
|
|
|
3606
3969
|
|
|
3607
3970
|
```typescript
|
|
3608
3971
|
await client.workflows.get("id", {
|
|
3609
|
-
verbose: true
|
|
3972
|
+
verbose: true
|
|
3610
3973
|
});
|
|
3611
|
-
```
|
|
3612
3974
|
|
|
3975
|
+
```
|
|
3613
3976
|
</dd>
|
|
3614
3977
|
</dl>
|
|
3615
3978
|
</dd>
|
|
@@ -3624,28 +3987,29 @@ await client.workflows.get("id", {
|
|
|
3624
3987
|
<dd>
|
|
3625
3988
|
|
|
3626
3989
|
**id:** `string` — ID of the workflow to retrieve
|
|
3627
|
-
|
|
3990
|
+
|
|
3628
3991
|
</dd>
|
|
3629
3992
|
</dl>
|
|
3630
3993
|
|
|
3631
3994
|
<dl>
|
|
3632
3995
|
<dd>
|
|
3633
3996
|
|
|
3634
|
-
**request:** `phenoml.workflows.WorkflowsGetRequest`
|
|
3635
|
-
|
|
3997
|
+
**request:** `phenoml.workflows.WorkflowsGetRequest`
|
|
3998
|
+
|
|
3636
3999
|
</dd>
|
|
3637
4000
|
</dl>
|
|
3638
4001
|
|
|
3639
4002
|
<dl>
|
|
3640
4003
|
<dd>
|
|
3641
4004
|
|
|
3642
|
-
**requestOptions:** `Workflows.RequestOptions`
|
|
3643
|
-
|
|
4005
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
4006
|
+
|
|
3644
4007
|
</dd>
|
|
3645
4008
|
</dl>
|
|
3646
4009
|
</dd>
|
|
3647
4010
|
</dl>
|
|
3648
4011
|
|
|
4012
|
+
|
|
3649
4013
|
</dd>
|
|
3650
4014
|
</dl>
|
|
3651
4015
|
</details>
|
|
@@ -3663,7 +4027,6 @@ await client.workflows.get("id", {
|
|
|
3663
4027
|
<dd>
|
|
3664
4028
|
|
|
3665
4029
|
Updates an existing workflow definition
|
|
3666
|
-
|
|
3667
4030
|
</dd>
|
|
3668
4031
|
</dl>
|
|
3669
4032
|
</dd>
|
|
@@ -3683,14 +4046,14 @@ await client.workflows.update("id", {
|
|
|
3683
4046
|
name: "Updated Patient Data Mapping Workflow",
|
|
3684
4047
|
workflow_instructions: "Given diagnosis data, find the patient and create condition record",
|
|
3685
4048
|
sample_data: {
|
|
3686
|
-
patient_last_name: "Smith",
|
|
3687
|
-
patient_first_name: "John",
|
|
3688
|
-
diagnosis_code: "E11"
|
|
4049
|
+
"patient_last_name": "Smith",
|
|
4050
|
+
"patient_first_name": "John",
|
|
4051
|
+
"diagnosis_code": "E11"
|
|
3689
4052
|
},
|
|
3690
|
-
fhir_provider_id: "550e8400-e29b-41d4-a716-446655440000"
|
|
4053
|
+
fhir_provider_id: "550e8400-e29b-41d4-a716-446655440000"
|
|
3691
4054
|
});
|
|
3692
|
-
```
|
|
3693
4055
|
|
|
4056
|
+
```
|
|
3694
4057
|
</dd>
|
|
3695
4058
|
</dl>
|
|
3696
4059
|
</dd>
|
|
@@ -3705,28 +4068,29 @@ await client.workflows.update("id", {
|
|
|
3705
4068
|
<dd>
|
|
3706
4069
|
|
|
3707
4070
|
**id:** `string` — ID of the workflow to update
|
|
3708
|
-
|
|
4071
|
+
|
|
3709
4072
|
</dd>
|
|
3710
4073
|
</dl>
|
|
3711
4074
|
|
|
3712
4075
|
<dl>
|
|
3713
4076
|
<dd>
|
|
3714
4077
|
|
|
3715
|
-
**request:** `phenoml.workflows.UpdateWorkflowRequest`
|
|
3716
|
-
|
|
4078
|
+
**request:** `phenoml.workflows.UpdateWorkflowRequest`
|
|
4079
|
+
|
|
3717
4080
|
</dd>
|
|
3718
4081
|
</dl>
|
|
3719
4082
|
|
|
3720
4083
|
<dl>
|
|
3721
4084
|
<dd>
|
|
3722
4085
|
|
|
3723
|
-
**requestOptions:** `Workflows.RequestOptions`
|
|
3724
|
-
|
|
4086
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
4087
|
+
|
|
3725
4088
|
</dd>
|
|
3726
4089
|
</dl>
|
|
3727
4090
|
</dd>
|
|
3728
4091
|
</dl>
|
|
3729
4092
|
|
|
4093
|
+
|
|
3730
4094
|
</dd>
|
|
3731
4095
|
</dl>
|
|
3732
4096
|
</details>
|
|
@@ -3744,7 +4108,6 @@ await client.workflows.update("id", {
|
|
|
3744
4108
|
<dd>
|
|
3745
4109
|
|
|
3746
4110
|
Deletes a workflow definition by its ID
|
|
3747
|
-
|
|
3748
4111
|
</dd>
|
|
3749
4112
|
</dl>
|
|
3750
4113
|
</dd>
|
|
@@ -3760,8 +4123,8 @@ Deletes a workflow definition by its ID
|
|
|
3760
4123
|
|
|
3761
4124
|
```typescript
|
|
3762
4125
|
await client.workflows.delete("id");
|
|
3763
|
-
```
|
|
3764
4126
|
|
|
4127
|
+
```
|
|
3765
4128
|
</dd>
|
|
3766
4129
|
</dl>
|
|
3767
4130
|
</dd>
|
|
@@ -3776,20 +4139,21 @@ await client.workflows.delete("id");
|
|
|
3776
4139
|
<dd>
|
|
3777
4140
|
|
|
3778
4141
|
**id:** `string` — ID of the workflow to delete
|
|
3779
|
-
|
|
4142
|
+
|
|
3780
4143
|
</dd>
|
|
3781
4144
|
</dl>
|
|
3782
4145
|
|
|
3783
4146
|
<dl>
|
|
3784
4147
|
<dd>
|
|
3785
4148
|
|
|
3786
|
-
**requestOptions:** `Workflows.RequestOptions`
|
|
3787
|
-
|
|
4149
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
4150
|
+
|
|
3788
4151
|
</dd>
|
|
3789
4152
|
</dl>
|
|
3790
4153
|
</dd>
|
|
3791
4154
|
</dl>
|
|
3792
4155
|
|
|
4156
|
+
|
|
3793
4157
|
</dd>
|
|
3794
4158
|
</dl>
|
|
3795
4159
|
</details>
|
|
@@ -3807,7 +4171,6 @@ await client.workflows.delete("id");
|
|
|
3807
4171
|
<dd>
|
|
3808
4172
|
|
|
3809
4173
|
Executes a workflow with provided input data and returns results
|
|
3810
|
-
|
|
3811
4174
|
</dd>
|
|
3812
4175
|
</dl>
|
|
3813
4176
|
</dd>
|
|
@@ -3824,14 +4187,14 @@ Executes a workflow with provided input data and returns results
|
|
|
3824
4187
|
```typescript
|
|
3825
4188
|
await client.workflows.execute("id", {
|
|
3826
4189
|
input_data: {
|
|
3827
|
-
patient_last_name: "Johnson",
|
|
3828
|
-
patient_first_name: "Mary",
|
|
3829
|
-
diagnosis_code: "M79.3",
|
|
3830
|
-
encounter_date: "2024-01-15"
|
|
3831
|
-
}
|
|
4190
|
+
"patient_last_name": "Johnson",
|
|
4191
|
+
"patient_first_name": "Mary",
|
|
4192
|
+
"diagnosis_code": "M79.3",
|
|
4193
|
+
"encounter_date": "2024-01-15"
|
|
4194
|
+
}
|
|
3832
4195
|
});
|
|
3833
|
-
```
|
|
3834
4196
|
|
|
4197
|
+
```
|
|
3835
4198
|
</dd>
|
|
3836
4199
|
</dl>
|
|
3837
4200
|
</dd>
|
|
@@ -3846,28 +4209,29 @@ await client.workflows.execute("id", {
|
|
|
3846
4209
|
<dd>
|
|
3847
4210
|
|
|
3848
4211
|
**id:** `string` — ID of the workflow to execute
|
|
3849
|
-
|
|
4212
|
+
|
|
3850
4213
|
</dd>
|
|
3851
4214
|
</dl>
|
|
3852
4215
|
|
|
3853
4216
|
<dl>
|
|
3854
4217
|
<dd>
|
|
3855
4218
|
|
|
3856
|
-
**request:** `phenoml.workflows.ExecuteWorkflowRequest`
|
|
3857
|
-
|
|
4219
|
+
**request:** `phenoml.workflows.ExecuteWorkflowRequest`
|
|
4220
|
+
|
|
3858
4221
|
</dd>
|
|
3859
4222
|
</dl>
|
|
3860
4223
|
|
|
3861
4224
|
<dl>
|
|
3862
4225
|
<dd>
|
|
3863
4226
|
|
|
3864
|
-
**requestOptions:** `Workflows.RequestOptions`
|
|
3865
|
-
|
|
4227
|
+
**requestOptions:** `Workflows.RequestOptions`
|
|
4228
|
+
|
|
3866
4229
|
</dd>
|
|
3867
4230
|
</dl>
|
|
3868
4231
|
</dd>
|
|
3869
4232
|
</dl>
|
|
3870
4233
|
|
|
4234
|
+
|
|
3871
4235
|
</dd>
|
|
3872
4236
|
</dl>
|
|
3873
4237
|
</details>
|