@oystehr/sdk 3.0.8 → 3.0.10
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/config.d.ts +1 -0
- package/dist/cjs/index.cjs +79 -5
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/cjs/index.min.cjs +1 -1
- package/dist/cjs/index.min.cjs.map +1 -1
- package/dist/cjs/resources/classes/developer.d.ts +1 -1
- package/dist/cjs/resources/classes/index.d.ts +2 -0
- package/dist/cjs/resources/classes/lab.d.ts +63 -0
- package/dist/cjs/resources/classes/m2m.d.ts +1 -1
- package/dist/cjs/resources/classes/project.d.ts +1 -1
- package/dist/cjs/resources/classes/user.d.ts +1 -1
- package/dist/cjs/resources/classes/z3.d.ts +1 -1
- package/dist/cjs/resources/types/ApplicationCreateParams.d.ts +0 -5
- package/dist/cjs/resources/types/ApplicationUpdateParams.d.ts +0 -4
- package/dist/cjs/resources/types/LabOrderSubmitParams.d.ts +11 -0
- package/dist/cjs/resources/types/LabOrderableItemListParams.d.ts +11 -0
- package/dist/cjs/resources/types/LabOrderableItemListResponse.d.ts +134 -0
- package/dist/cjs/resources/types/LabOrderableItemQuestionnaireGetParams.d.ts +6 -0
- package/dist/cjs/resources/types/LabOrderableItemQuestionnaireGetResponse.d.ts +5 -0
- package/dist/cjs/resources/types/LabRouteCreateParams.d.ts +41 -0
- package/dist/cjs/resources/types/LabRouteDeleteParams.d.ts +4 -0
- package/dist/cjs/resources/types/LabRouteListResponse.d.ts +17 -0
- package/dist/cjs/resources/types/index.d.ts +8 -0
- package/dist/esm/config.d.ts +1 -0
- package/dist/esm/index.min.js +1 -1
- package/dist/esm/index.min.js.map +1 -1
- package/dist/esm/resources/classes/developer.d.ts +1 -1
- package/dist/esm/resources/classes/developer.js +1 -1
- package/dist/esm/resources/classes/developer.js.map +1 -1
- package/dist/esm/resources/classes/index.d.ts +2 -0
- package/dist/esm/resources/classes/index.js +2 -0
- package/dist/esm/resources/classes/index.js.map +1 -1
- package/dist/esm/resources/classes/lab.d.ts +63 -0
- package/dist/esm/resources/classes/lab.js +78 -0
- package/dist/esm/resources/classes/lab.js.map +1 -0
- package/dist/esm/resources/classes/m2m.d.ts +1 -1
- package/dist/esm/resources/classes/m2m.js +1 -1
- package/dist/esm/resources/classes/m2m.js.map +1 -1
- package/dist/esm/resources/classes/project.d.ts +1 -1
- package/dist/esm/resources/classes/project.js +1 -1
- package/dist/esm/resources/classes/project.js.map +1 -1
- package/dist/esm/resources/classes/user.d.ts +1 -1
- package/dist/esm/resources/classes/user.js +1 -1
- package/dist/esm/resources/classes/user.js.map +1 -1
- package/dist/esm/resources/classes/z3.d.ts +1 -1
- package/dist/esm/resources/classes/z3.js +1 -1
- package/dist/esm/resources/classes/z3.js.map +1 -1
- package/dist/esm/resources/types/ApplicationCreateParams.d.ts +0 -5
- package/dist/esm/resources/types/ApplicationUpdateParams.d.ts +0 -4
- package/dist/esm/resources/types/LabOrderSubmitParams.d.ts +11 -0
- package/dist/esm/resources/types/LabOrderableItemListParams.d.ts +11 -0
- package/dist/esm/resources/types/LabOrderableItemListResponse.d.ts +134 -0
- package/dist/esm/resources/types/LabOrderableItemQuestionnaireGetParams.d.ts +6 -0
- package/dist/esm/resources/types/LabOrderableItemQuestionnaireGetResponse.d.ts +5 -0
- package/dist/esm/resources/types/LabRouteCreateParams.d.ts +41 -0
- package/dist/esm/resources/types/LabRouteDeleteParams.d.ts +4 -0
- package/dist/esm/resources/types/LabRouteListResponse.d.ts +17 -0
- package/dist/esm/resources/types/index.d.ts +8 -0
- package/package.json +2 -2
- package/src/config.ts +1 -0
- package/src/resources/classes/developer.ts +2 -2
- package/src/resources/classes/index.ts +3 -0
- package/src/resources/classes/lab.ts +113 -0
- package/src/resources/classes/m2m.ts +2 -2
- package/src/resources/classes/project.ts +2 -2
- package/src/resources/classes/user.ts +2 -2
- package/src/resources/classes/z3.ts +1 -1
- package/src/resources/types/ApplicationCreateParams.ts +0 -5
- package/src/resources/types/ApplicationUpdateParams.ts +0 -4
- package/src/resources/types/LabOrderSubmitParams.ts +13 -0
- package/src/resources/types/LabOrderableItemListParams.ts +13 -0
- package/src/resources/types/LabOrderableItemListResponse.ts +136 -0
- package/src/resources/types/LabOrderableItemQuestionnaireGetParams.ts +8 -0
- package/src/resources/types/LabOrderableItemQuestionnaireGetResponse.ts +7 -0
- package/src/resources/types/LabRouteCreateParams.ts +43 -0
- package/src/resources/types/LabRouteDeleteParams.ts +6 -0
- package/src/resources/types/LabRouteListResponse.ts +19 -0
- package/src/resources/types/index.ts +8 -0
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import { Questionnaire } from 'fhir/r4b';
|
|
2
|
+
/**
|
|
3
|
+
* orderable item results
|
|
4
|
+
*/
|
|
5
|
+
export interface LabOrderableItemListResponse {
|
|
6
|
+
orderableItems?: {
|
|
7
|
+
/**
|
|
8
|
+
* Identifying lab information and compendium version
|
|
9
|
+
*/
|
|
10
|
+
lab?: {
|
|
11
|
+
/**
|
|
12
|
+
* Identifying labGuid pertaining to the specific result
|
|
13
|
+
*/
|
|
14
|
+
labGuid?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Name of lab
|
|
17
|
+
*/
|
|
18
|
+
labName?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Description of lab
|
|
21
|
+
*/
|
|
22
|
+
labType?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Current compendium version for given lab
|
|
25
|
+
*/
|
|
26
|
+
compendiumVersion?: string;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Specific orderable item details
|
|
30
|
+
*/
|
|
31
|
+
item?: {
|
|
32
|
+
/**
|
|
33
|
+
* Code uniquely identifying the orderable item for the given lab and compendium version
|
|
34
|
+
*/
|
|
35
|
+
itemCode?: string;
|
|
36
|
+
/**
|
|
37
|
+
* LOINC code associated with this orderable item.
|
|
38
|
+
*/
|
|
39
|
+
itemLoinc?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Type of orderable item
|
|
42
|
+
*/
|
|
43
|
+
itemType?: string;
|
|
44
|
+
/**
|
|
45
|
+
* Name of the orderable item.
|
|
46
|
+
*/
|
|
47
|
+
itemName?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Unique name of the orderable item. Typically a combination of the itemCode and itemName
|
|
50
|
+
*/
|
|
51
|
+
uniqueName?: string;
|
|
52
|
+
/**
|
|
53
|
+
* List of the sample(s) that must be collected for this orderable item
|
|
54
|
+
*/
|
|
55
|
+
specimens?: {
|
|
56
|
+
/**
|
|
57
|
+
* Description of container necessary to store the sample.
|
|
58
|
+
*/
|
|
59
|
+
container?: string;
|
|
60
|
+
/**
|
|
61
|
+
* Volume of the specimen to be collected
|
|
62
|
+
*/
|
|
63
|
+
volume?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Minimum volume of specimen below which teh test is not performable
|
|
66
|
+
*/
|
|
67
|
+
minimumVolume?: string;
|
|
68
|
+
/**
|
|
69
|
+
* Instructions for storing the specimen after collection
|
|
70
|
+
*/
|
|
71
|
+
storageRequirements?: string;
|
|
72
|
+
/**
|
|
73
|
+
* Instructions for how to collect the sample
|
|
74
|
+
*/
|
|
75
|
+
collectionInstructions?: string;
|
|
76
|
+
}[];
|
|
77
|
+
/**
|
|
78
|
+
* List of the component(s) comprising this orderable item
|
|
79
|
+
*/
|
|
80
|
+
components?: {
|
|
81
|
+
/**
|
|
82
|
+
* Description of container necessary to store the sample.
|
|
83
|
+
*/
|
|
84
|
+
componentItemCode?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Name of component
|
|
87
|
+
*/
|
|
88
|
+
name?: string;
|
|
89
|
+
/**
|
|
90
|
+
* LOINC code identifying the component
|
|
91
|
+
*/
|
|
92
|
+
loinc?: string;
|
|
93
|
+
/**
|
|
94
|
+
* Unit of measurement
|
|
95
|
+
*/
|
|
96
|
+
uom?: string;
|
|
97
|
+
/**
|
|
98
|
+
* Reference range associated with the component
|
|
99
|
+
*/
|
|
100
|
+
range?: string;
|
|
101
|
+
/**
|
|
102
|
+
* Type of the component, such as List, Numeric, Free Text
|
|
103
|
+
*/
|
|
104
|
+
type?: string;
|
|
105
|
+
}[];
|
|
106
|
+
/**
|
|
107
|
+
* Array of CPT codes associated with the orderable item
|
|
108
|
+
*/
|
|
109
|
+
cptCodes?: {
|
|
110
|
+
/**
|
|
111
|
+
* CPT Code used for billing for medical services and procedures
|
|
112
|
+
*/
|
|
113
|
+
cptCode?: string;
|
|
114
|
+
/**
|
|
115
|
+
* Number of billable units
|
|
116
|
+
*/
|
|
117
|
+
serviceUnitsCount?: number;
|
|
118
|
+
}[];
|
|
119
|
+
/**
|
|
120
|
+
* Answer On Entry Questionnaire. See FHIR Questionnaire for schema
|
|
121
|
+
*/
|
|
122
|
+
aoe?: Questionnaire;
|
|
123
|
+
};
|
|
124
|
+
}[];
|
|
125
|
+
/**
|
|
126
|
+
* Pagination details
|
|
127
|
+
*/
|
|
128
|
+
metadata?: {
|
|
129
|
+
/**
|
|
130
|
+
* Cursor to include in subsequent request for next page of results. Will be null if there are no more results.
|
|
131
|
+
*/
|
|
132
|
+
nextCursor?: string;
|
|
133
|
+
};
|
|
134
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
export interface LabRouteCreateParams {
|
|
2
|
+
primaryId?: string;
|
|
3
|
+
/**
|
|
4
|
+
* Provided by the lab, indicates a financial relationship between the lab and the customer.
|
|
5
|
+
*/
|
|
6
|
+
accountNumber: string;
|
|
7
|
+
/**
|
|
8
|
+
* Unique identifier of a lab. Searchable via orderable item Search.
|
|
9
|
+
*/
|
|
10
|
+
labGuid: string;
|
|
11
|
+
/**
|
|
12
|
+
* Name of the Primary (Practice or Provider depending on the Route). Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
|
|
13
|
+
*/
|
|
14
|
+
primaryName?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Address of the Primary. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
|
|
17
|
+
*/
|
|
18
|
+
primaryAddress?: {
|
|
19
|
+
address1: string;
|
|
20
|
+
address2?: string;
|
|
21
|
+
city: string;
|
|
22
|
+
stateProvinceCode: string;
|
|
23
|
+
postalCode: string;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* String representing accepted End User License Agreement Version. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
|
|
27
|
+
*/
|
|
28
|
+
eulaVersion?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Name of individual who accepted the End User License Agreement. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
|
|
31
|
+
*/
|
|
32
|
+
eulaAccepterFullName?: string;
|
|
33
|
+
/**
|
|
34
|
+
* ISO string representing when the End User License Agreement was accepted. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
|
|
35
|
+
*/
|
|
36
|
+
eulaAcceptanceDateTimeUtc?: string;
|
|
37
|
+
/**
|
|
38
|
+
* Site ID for the Primary. ClientSiteID is assigned by the lab. This disambiguates instances where the same Account Number is used across multiple physical locations. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
|
|
39
|
+
*/
|
|
40
|
+
clientSiteId?: string;
|
|
41
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* List of Routes associated with the calling projectId.
|
|
3
|
+
*/
|
|
4
|
+
export type LabRouteListResponse = {
|
|
5
|
+
/**
|
|
6
|
+
* Unique identifier of the created Route.
|
|
7
|
+
*/
|
|
8
|
+
routeGuid?: string;
|
|
9
|
+
/**
|
|
10
|
+
* Unique identifier of a lab. Searchable via orderable item Search
|
|
11
|
+
*/
|
|
12
|
+
labGuid?: string;
|
|
13
|
+
/**
|
|
14
|
+
* Provided by the lab, indicates a financial relationship between the lab and the customer.
|
|
15
|
+
*/
|
|
16
|
+
accountNumber?: string;
|
|
17
|
+
}[];
|
|
@@ -164,3 +164,11 @@ export * from './ZambdaLogStreamGetParams';
|
|
|
164
164
|
export * from './ZambdaLogStreamGetResponse';
|
|
165
165
|
export * from './FaxSendParams';
|
|
166
166
|
export * from './FaxSendResponse';
|
|
167
|
+
export * from './LabRouteListResponse';
|
|
168
|
+
export * from './LabRouteCreateParams';
|
|
169
|
+
export * from './LabRouteDeleteParams';
|
|
170
|
+
export * from './LabOrderableItemListParams';
|
|
171
|
+
export * from './LabOrderableItemListResponse';
|
|
172
|
+
export * from './LabOrderableItemQuestionnaireGetParams';
|
|
173
|
+
export * from './LabOrderableItemQuestionnaireGetResponse';
|
|
174
|
+
export * from './LabOrderSubmitParams';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@oystehr/sdk",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.10",
|
|
4
4
|
"description": "Oystehr SDK",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"lint": "eslint .",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"parser": "ts-node debug-parser.ts",
|
|
15
15
|
"publish-to-npmjs": "npm run build && npm publish",
|
|
16
16
|
"publish-to-npmjs-next": "npm run build && npm publish --tag next",
|
|
17
|
-
"generate": "ts-node scripts/generate-sdk-v3 project,fax src/resources"
|
|
17
|
+
"generate": "ts-node scripts/generate-sdk-v3 project,fax,lab src/resources"
|
|
18
18
|
},
|
|
19
19
|
"engines": {
|
|
20
20
|
"npm": ">=8.0.0",
|
package/src/config.ts
CHANGED
|
@@ -78,14 +78,14 @@ export class Developer extends SDKResource {
|
|
|
78
78
|
*/
|
|
79
79
|
listV2(params: DeveloperListV2Params, request?: OystehrClientRequest): Promise<DeveloperListV2Response>;
|
|
80
80
|
/**
|
|
81
|
-
* Get Developers in the Project with pagination, sort, sort Order and filtering. [Users](https://docs.oystehr.com/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/services/app/applications/) you configure for securing the apps you build on top of Oystehr.
|
|
81
|
+
* Get Developers in the Project with pagination, sort, sort Order and filtering. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr.
|
|
82
82
|
*
|
|
83
83
|
* Access Policy Action: `Project:ListAllUsers`
|
|
84
84
|
* Access Policy Resource: `Project:Settings`
|
|
85
85
|
*/
|
|
86
86
|
listV2(request?: OystehrClientRequest): Promise<DeveloperListV2Response>;
|
|
87
87
|
/**
|
|
88
|
-
* Get Developers in the Project with pagination, sort, sort Order and filtering. [Users](https://docs.oystehr.com/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/services/app/applications/) you configure for securing the apps you build on top of Oystehr.
|
|
88
|
+
* Get Developers in the Project with pagination, sort, sort Order and filtering. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr.
|
|
89
89
|
*
|
|
90
90
|
* Access Policy Action: `Project:ListAllUsers`
|
|
91
91
|
* Access Policy Resource: `Project:Settings`
|
|
@@ -8,6 +8,7 @@ import { Developer } from './developer';
|
|
|
8
8
|
import { Erx } from './erx';
|
|
9
9
|
import { Fax } from './fax';
|
|
10
10
|
import { Fhir } from './fhir';
|
|
11
|
+
import { Lab } from './lab';
|
|
11
12
|
import { M2m } from './m2m';
|
|
12
13
|
import { Messaging } from './messaging';
|
|
13
14
|
import { PaymentMethod } from './paymentMethod';
|
|
@@ -45,6 +46,7 @@ export class Oystehr {
|
|
|
45
46
|
readonly zambda: Zambda;
|
|
46
47
|
readonly zambdaLogStream: ZambdaLogStream;
|
|
47
48
|
readonly fax: Fax;
|
|
49
|
+
readonly lab: Lab;
|
|
48
50
|
readonly fhir: Fhir;
|
|
49
51
|
constructor(config: OystehrConfig) {
|
|
50
52
|
this.config = config;
|
|
@@ -71,6 +73,7 @@ export class Oystehr {
|
|
|
71
73
|
this.zambda = new Zambda(config);
|
|
72
74
|
this.zambdaLogStream = new ZambdaLogStream(config);
|
|
73
75
|
this.fax = new Fax(config);
|
|
76
|
+
this.lab = new Lab(config);
|
|
74
77
|
this.fhir = new Fhir(config);
|
|
75
78
|
}
|
|
76
79
|
}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
// AUTOGENERATED -- DO NOT EDIT
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
LabOrderableItemListParams,
|
|
5
|
+
LabOrderableItemListResponse,
|
|
6
|
+
LabOrderableItemQuestionnaireGetParams,
|
|
7
|
+
LabOrderableItemQuestionnaireGetResponse,
|
|
8
|
+
LabOrderSubmitParams,
|
|
9
|
+
LabRouteCreateParams,
|
|
10
|
+
LabRouteDeleteParams,
|
|
11
|
+
LabRouteListResponse,
|
|
12
|
+
OystehrClientRequest,
|
|
13
|
+
} from '../..';
|
|
14
|
+
import { SDKResource } from '../../client/client';
|
|
15
|
+
import { OystehrConfig } from '../../config';
|
|
16
|
+
|
|
17
|
+
export class Lab extends SDKResource {
|
|
18
|
+
constructor(config: OystehrConfig) {
|
|
19
|
+
super(config);
|
|
20
|
+
}
|
|
21
|
+
#baseUrlThunk(): string {
|
|
22
|
+
return this.config.services?.['labApiUrl'] ?? 'https://labs-api.zapehr.com/v1';
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Gets a list of Routes associated with the project. Returns an empty list if no Routes are found.
|
|
26
|
+
*
|
|
27
|
+
* Access Policy Requirements:
|
|
28
|
+
* Action: `Lab:GetRoutes`
|
|
29
|
+
* Access Policy Resource: `Lab:Route`
|
|
30
|
+
*/
|
|
31
|
+
routeList(request?: OystehrClientRequest): Promise<LabRouteListResponse> {
|
|
32
|
+
return this.request('/route', 'get', this.#baseUrlThunk.bind(this))(request);
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Create a route. A Route represents that a lab and particular customer have a relationship, and a Route is necessary to submit an order to a lab. See [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
|
|
36
|
+
*
|
|
37
|
+
* Access Policy Requirements:
|
|
38
|
+
* Action: `Lab:CreateRoute`
|
|
39
|
+
* Access Policy Resource: `Lab:Route`
|
|
40
|
+
*/
|
|
41
|
+
routeCreate(params: LabRouteCreateParams, request?: OystehrClientRequest): Promise<void> {
|
|
42
|
+
return this.request('/route', 'post', this.#baseUrlThunk.bind(this))(params, request);
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Delete a route. Deleting a Route will permanently remove the `routeGuid`. Orders can no longer be submitted to this lab until a new Route is created. See [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#delete-route) for more details.
|
|
46
|
+
*
|
|
47
|
+
* Access Policy Requirements:
|
|
48
|
+
* Action: `Lab:DeleteRoute`
|
|
49
|
+
* Access Policy Resource: `Lab:Route`
|
|
50
|
+
*/
|
|
51
|
+
routeDelete(params: LabRouteDeleteParams, request?: OystehrClientRequest): Promise<void> {
|
|
52
|
+
return this.request('/route/{routeGuid}', 'delete', this.#baseUrlThunk.bind(this))(params, request);
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Returns list of active orderable items for the latest compendium version. Page size is default 25 and max 100 items. See [orderable item Search](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#orderable-item-search) for more details.
|
|
56
|
+
*
|
|
57
|
+
* Access Policy Requirements:
|
|
58
|
+
* Action: `Lab:SearchOrderableItems`
|
|
59
|
+
* Access Policy Resource: `Lab:OrderableItem`
|
|
60
|
+
*/
|
|
61
|
+
orderableItemList(
|
|
62
|
+
params: LabOrderableItemListParams,
|
|
63
|
+
request?: OystehrClientRequest
|
|
64
|
+
): Promise<LabOrderableItemListResponse>;
|
|
65
|
+
/**
|
|
66
|
+
* Returns list of active orderable items for the latest compendium version. Page size is default 25 and max 100 items. See [orderable item Search](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#orderable-item-search) for more details.
|
|
67
|
+
*
|
|
68
|
+
* Access Policy Requirements:
|
|
69
|
+
* Action: `Lab:SearchOrderableItems`
|
|
70
|
+
* Access Policy Resource: `Lab:OrderableItem`
|
|
71
|
+
*/
|
|
72
|
+
orderableItemList(request?: OystehrClientRequest): Promise<LabOrderableItemListResponse>;
|
|
73
|
+
/**
|
|
74
|
+
* Returns list of active orderable items for the latest compendium version. Page size is default 25 and max 100 items. See [orderable item Search](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#orderable-item-search) for more details.
|
|
75
|
+
*
|
|
76
|
+
* Access Policy Requirements:
|
|
77
|
+
* Action: `Lab:SearchOrderableItems`
|
|
78
|
+
* Access Policy Resource: `Lab:OrderableItem`
|
|
79
|
+
*/
|
|
80
|
+
orderableItemList(
|
|
81
|
+
params?: LabOrderableItemListParams | OystehrClientRequest,
|
|
82
|
+
request?: OystehrClientRequest
|
|
83
|
+
): Promise<LabOrderableItemListResponse> {
|
|
84
|
+
return this.request('/orderableItem', 'get', this.#baseUrlThunk.bind(this))(params, request);
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Retrieve the AOE (Answer on Entry) Questionnaire for the given orderable item. The orderable item is defined by its labGuid, compendiumVersion, and itemCode. See [AOE](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#AOE) for more details.
|
|
88
|
+
*
|
|
89
|
+
* Access Policy Requirements:
|
|
90
|
+
* Action: `Lab:SearchOrderableItems`
|
|
91
|
+
* Access Policy Resource: `Lab:OrderableItem`
|
|
92
|
+
*/
|
|
93
|
+
orderableItemQuestionnaireGet(
|
|
94
|
+
params: LabOrderableItemQuestionnaireGetParams,
|
|
95
|
+
request?: OystehrClientRequest
|
|
96
|
+
): Promise<LabOrderableItemQuestionnaireGetResponse> {
|
|
97
|
+
return this.request(
|
|
98
|
+
'/canonical-questionnaire/lab/{labGuid}/compendium/{compendiumVersion}/item/{itemCode}/questionnaire',
|
|
99
|
+
'get',
|
|
100
|
+
this.#baseUrlThunk.bind(this)
|
|
101
|
+
)(params, request);
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Submit a lab order. Oystehr's [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/) feature allows users to submit a well configured ServiceRequest to an external lab. In order to successfully submit an order, a [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) to and Organization representing that lab must exist.
|
|
105
|
+
*
|
|
106
|
+
* Access Policy Requirements:
|
|
107
|
+
* Action: `Lab:SubmitOrder`
|
|
108
|
+
* Access Policy Resource: `Lab:Order`
|
|
109
|
+
*/
|
|
110
|
+
orderSubmit(params: LabOrderSubmitParams, request?: OystehrClientRequest): Promise<void> {
|
|
111
|
+
return this.request('/submit', 'post', this.#baseUrlThunk.bind(this))(params, request);
|
|
112
|
+
}
|
|
113
|
+
}
|
|
@@ -89,14 +89,14 @@ export class M2m extends SDKResource {
|
|
|
89
89
|
*/
|
|
90
90
|
listV2(params: M2mListV2Params, request?: OystehrClientRequest): Promise<M2mListV2Response>;
|
|
91
91
|
/**
|
|
92
|
-
* Get M2M clients in the Project with pagination, sort, sort Order and filtering. [M2M Clients](https://docs.oystehr.com/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/services/zambda).
|
|
92
|
+
* Get M2M clients in the Project with pagination, sort, sort Order and filtering. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda).
|
|
93
93
|
*
|
|
94
94
|
* Access Policy Action: `App:ListAllM2MClients`
|
|
95
95
|
* Access Policy Resource: `IAM:M2MClient`
|
|
96
96
|
*/
|
|
97
97
|
listV2(request?: OystehrClientRequest): Promise<M2mListV2Response>;
|
|
98
98
|
/**
|
|
99
|
-
* Get M2M clients in the Project with pagination, sort, sort Order and filtering. [M2M Clients](https://docs.oystehr.com/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/services/zambda).
|
|
99
|
+
* Get M2M clients in the Project with pagination, sort, sort Order and filtering. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda).
|
|
100
100
|
*
|
|
101
101
|
* Access Policy Action: `App:ListAllM2MClients`
|
|
102
102
|
* Access Policy Resource: `IAM:M2MClient`
|
|
@@ -28,14 +28,14 @@ export class Project extends SDKResource {
|
|
|
28
28
|
*/
|
|
29
29
|
update(params: ProjectUpdateParams, request?: OystehrClientRequest): Promise<ProjectUpdateResponse>;
|
|
30
30
|
/**
|
|
31
|
-
* Update the Project settings for the Project that corresponds to the project-id in the request header. A [Project](https://docs.oystehr.com/services/project/) is the logically-isolated instance of Oystehr that segments your data from other Projects. Projects are completely independent from each other, having their own separate [FHIR store](https://docs.oystehr.com/services/fhir/basics/), [Applications](https://docs.oystehr.com/services/app/applications/), [Users](https://docs.oystehr.com/services/app/users/), etc .
|
|
31
|
+
* Update the Project settings for the Project that corresponds to the project-id in the request header. A [Project](https://docs.oystehr.com/oystehr/services/project/) is the logically-isolated instance of Oystehr that segments your data from other Projects. Projects are completely independent from each other, having their own separate [FHIR store](https://docs.oystehr.com/oystehr/services/fhir/basics/), [Applications](https://docs.oystehr.com/oystehr/services/app/applications/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), etc .
|
|
32
32
|
*
|
|
33
33
|
* Access Policy Action: `Project:UpdateProjectInfo`
|
|
34
34
|
* Access Policy Resource: `Project:Settings`
|
|
35
35
|
*/
|
|
36
36
|
update(request?: OystehrClientRequest): Promise<ProjectUpdateResponse>;
|
|
37
37
|
/**
|
|
38
|
-
* Update the Project settings for the Project that corresponds to the project-id in the request header. A [Project](https://docs.oystehr.com/services/project/) is the logically-isolated instance of Oystehr that segments your data from other Projects. Projects are completely independent from each other, having their own separate [FHIR store](https://docs.oystehr.com/services/fhir/basics/), [Applications](https://docs.oystehr.com/services/app/applications/), [Users](https://docs.oystehr.com/services/app/users/), etc .
|
|
38
|
+
* Update the Project settings for the Project that corresponds to the project-id in the request header. A [Project](https://docs.oystehr.com/oystehr/services/project/) is the logically-isolated instance of Oystehr that segments your data from other Projects. Projects are completely independent from each other, having their own separate [FHIR store](https://docs.oystehr.com/oystehr/services/fhir/basics/), [Applications](https://docs.oystehr.com/oystehr/services/app/applications/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), etc .
|
|
39
39
|
*
|
|
40
40
|
* Access Policy Action: `Project:UpdateProjectInfo`
|
|
41
41
|
* Access Policy Resource: `Project:Settings`
|
|
@@ -87,14 +87,14 @@ export class User extends SDKResource {
|
|
|
87
87
|
*/
|
|
88
88
|
listV2(params: UserListV2Params, request?: OystehrClientRequest): Promise<UserListV2Response>;
|
|
89
89
|
/**
|
|
90
|
-
* Get Users in the Project with pagination, sort, sort Order and filtering. [Users](https://docs.oystehr.com/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/services/app/applications/) you configure for securing the apps you build on top of Oystehr.
|
|
90
|
+
* Get Users in the Project with pagination, sort, sort Order and filtering. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr.
|
|
91
91
|
*
|
|
92
92
|
* Access Policy Action: `Project:ListAllUsers`
|
|
93
93
|
* Access Policy Resource: `Project:Settings`
|
|
94
94
|
*/
|
|
95
95
|
listV2(request?: OystehrClientRequest): Promise<UserListV2Response>;
|
|
96
96
|
/**
|
|
97
|
-
* Get Users in the Project with pagination, sort, sort Order and filtering. [Users](https://docs.oystehr.com/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/services/app/applications/) you configure for securing the apps you build on top of Oystehr.
|
|
97
|
+
* Get Users in the Project with pagination, sort, sort Order and filtering. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr.
|
|
98
98
|
*
|
|
99
99
|
* Access Policy Action: `Project:ListAllUsers`
|
|
100
100
|
* Access Policy Resource: `Project:Settings`
|
|
@@ -53,7 +53,7 @@ export class Z3 extends SDKResource {
|
|
|
53
53
|
* Create a Z3 Bucket with the provided name. [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.
|
|
54
54
|
*
|
|
55
55
|
* Access Policy Action: `Z3:CreateBucket`
|
|
56
|
-
* Access Policy Resource: `Z3
|
|
56
|
+
* Access Policy Resource: `Z3:*`
|
|
57
57
|
*/
|
|
58
58
|
createBucket(params: Z3CreateBucketParams, request?: OystehrClientRequest): Promise<Z3CreateBucketResponse> {
|
|
59
59
|
return this.request('/z3/{bucketName}', 'put', this.#baseUrlThunk.bind(this))(params, request);
|
|
@@ -1,15 +1,10 @@
|
|
|
1
1
|
// AUTOGENERATED -- DO NOT EDIT
|
|
2
2
|
|
|
3
3
|
export interface ApplicationCreateParams {
|
|
4
|
-
id?: string;
|
|
5
4
|
/**
|
|
6
5
|
* The name of the Application. This value is displayed to end users on the hosted login screen.
|
|
7
6
|
*/
|
|
8
7
|
name: string;
|
|
9
|
-
/**
|
|
10
|
-
* The Application's OAuth 2.0 client identifier.
|
|
11
|
-
*/
|
|
12
|
-
clientId?: string;
|
|
13
8
|
/**
|
|
14
9
|
* A description of the application to help you differentiate it from other applications in the project. This value is not displayed to end users.
|
|
15
10
|
*/
|
|
@@ -5,10 +5,6 @@ export interface ApplicationUpdateParams {
|
|
|
5
5
|
* The name of the Application. This value is displayed to end users on the hosted login screen.
|
|
6
6
|
*/
|
|
7
7
|
name?: string;
|
|
8
|
-
/**
|
|
9
|
-
* The Application's OAuth 2.0 client identifier.
|
|
10
|
-
*/
|
|
11
|
-
clientId?: string;
|
|
12
8
|
/**
|
|
13
9
|
* A description of the application to help you differentiate it from other applications in the project. This value is not displayed to end users.
|
|
14
10
|
*/
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// AUTOGENERATED -- DO NOT EDIT
|
|
2
|
+
|
|
3
|
+
export interface LabOrderSubmitParams {
|
|
4
|
+
primaryId?: string;
|
|
5
|
+
/**
|
|
6
|
+
* Provided by the lab, indicates a financial relationship between the lab and the customer.
|
|
7
|
+
*/
|
|
8
|
+
accountNumber: string;
|
|
9
|
+
/**
|
|
10
|
+
* Valid ServiceRequest FHIR resource representing an order. See [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/) for more details.
|
|
11
|
+
*/
|
|
12
|
+
serviceRequest: string;
|
|
13
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// AUTOGENERATED -- DO NOT EDIT
|
|
2
|
+
|
|
3
|
+
export interface LabOrderableItemListParams {
|
|
4
|
+
cursor?: string;
|
|
5
|
+
itemCodes?: string;
|
|
6
|
+
itemCptCodes?: string;
|
|
7
|
+
itemLoincs?: string;
|
|
8
|
+
itemNames?: string;
|
|
9
|
+
labIds?: string;
|
|
10
|
+
limit?: number;
|
|
11
|
+
sort?: 'itemCodes' | 'itemLoincs' | 'itemNames' | 'labIds';
|
|
12
|
+
sortOrder?: 'asc' | 'desc';
|
|
13
|
+
}
|