QBOS REST API documentation for ITMSET14

The ITMSET14 API allows client applications to maintain ITMSET14 data record sets.

Audience

This developer's guide is intended for software developers needing a technical reference for using the QBOS REST API. The information you find in this guide is written by software engineering, and is authoritative on how the API behaves.

Additional resources, information about this guide

Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on. If this has happened to you, we apologize! You can help us fix the issue by contacting us at: pkajaani@qbos.com. We appreciate your help.

Getting Started

To place any request in a QBOS API application from a third party application you need to first authenticate your user account and set/calculate values for the following request headers: x-qbos-id, x-qbos-nonce, x-qbos-date-utc, x-qbos-hash-version, x-qbos-auth

Custom resource vs. standard resource URI format

Custom resource (a.k.a applet) URI contains the resource vendor id in place of "/o/" in the standard object URI. Compare: .../v1/o/...with .../v1/{vendor_id}/...

ITMSET14 properties

Properties prefixed with '_' (underscore) are read-only properties. i.e. POST and PUT processing will ignore these properties.

Name	Type	Max Length	Numeric	Required For POST	Filterable	Default	Description
_client_Id	bigint		Yes			NULL	This is the Data Org Id.
_owner_Id	bigint		Yes		Yes	NULL	This is the user id of the record owner. Defaults to the creatorOpid.
_creator_Opid	bigint		Yes		Yes	NULL	This is the user id of the original record submitter.
_create_Date	datetime		No	{timestamp}			Not enterable upon Insert. System sets this date upon record creation.
status_id	int		Yes		Yes	5532	The status id of the record. Taken from the Life Cycle statuses in ADS.
_status_Change_Date	datetime		No			NULL	Not enterable. System sets this date whenever the statusid is changed.
admitDischarge	nvarchar	1			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
ITM_SET_SYS_CD	nvarchar	20			Yes	HOSPICE
ITM_SBST_CD	nvarchar	2			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
ITM_SET_VRSN_CD	nvarchar	20			Yes	NULL
SPEC_VRSN_CD	nvarchar	20			Yes	NULL
STATE_CD	nvarchar	20			Yes	NULL	This property is populated by a Type 2 Value List. Click here for the appropriate API and sample of value options for this column.
FAC_ID	nvarchar	20			Yes	NULL
SFTWR_VNDR_ID	nvarchar	20			Yes	NULL
SFTWR_VNDR_EMAIL_ADR	nvarchar	30			Yes	NULL
SFTWR_PROD_NAME	nvarchar	20			Yes	NULL
SFTWR_PROD_VRSN_CD	nvarchar	20			Yes	NULL
A0100A	nvarchar	20			Yes	NULL
A0100B	nvarchar	20			Yes	NULL
A0500A	nvarchar	50			Yes	NULL
A0500B	nvarchar	20			Yes	NULL
A0500C	nvarchar	50			Yes	NULL
A0500D	nvarchar	20			Yes	NULL
A0600A	nvarchar	20			Yes	NULL
A0600B	nvarchar	20			Yes	NULL
A0700	nvarchar	20			Yes	NULL
A0800	nvarchar	1			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A0900	datetime				Yes	NULL
SFTWR_VNDR_NAME	nvarchar	20			Yes	NULL
A0050	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
TARGET_DATE	datetime				Yes	NULL
RESIDENT_AGE	integer		Yes		Yes	NULL
ASSESSMENT_ID	nvarchar	20			Yes	NULL
RESIDENT_INTERNAL_ID	nvarchar	20			Yes	NULL
ORIGINAL_ASSESSMENT_ID	nvarchar	20			Yes	NULL
SUMITTING_USER_ID	nvarchar	20			Yes	NULL
SUMISSION_ID	nvarchar	20			Yes	NULL
SUMISSION_DATE	datetime				Yes	NULL
SUBMISSION_COMPLETE_DATE	datetime				Yes	NULL
RESIDENT_MATCH_CRITERIA	nvarchar	20			Yes	NULL
ASMT_iTEMS_FILLER	nvarchar	20			Yes	NULL
PROVIDER_INTERNAL_ID	nvarchar	20			Yes	NULL
CALCULATED_ITEMS_FILLER	nvarchar	20			Yes	NULL
BIRTHDATE_SUBMIT_CODE	nvarchar	20			Yes	NULL
BIRTHDATE_SUBMIT_CODE_1	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A0205	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A0220	datetime				Yes	NULL
A0245	datetime				Yes	NULL
A1802	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
F2000A	nvarchar	1			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
I0010	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0900A	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0900C	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0900D	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0910A	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0910B	datetime				Yes	NULL
J2030A	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J2030C	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J2040A	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J2040C1	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J2040C2	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J2040C3	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J2040C4	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
N0500A	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
N0510A	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
N0520A	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Z0500B	datetime				Yes	NULL
A0270	datetime				Yes	NULL
A2115	integer		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
CONTROL_ITEMS_FILLER_1	nvarchar	20			Yes	NULL
CONTROL_ITEMS_FILLER_2	nvarchar	20			Yes	NULL
A0250	integer		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
CRCTN_NUM	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
F2200B_active	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
F2200B	datetime				Yes	NULL
F3000B_active	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
F3000B	datetime				Yes	NULL
J0900B_active	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0900B	datetime				Yes	NULL
J0910B_active	nvarchar	20			Yes	NULL
J2030B_active	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J2030B	datetime				Yes	NULL
J2040B_active	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J2040B	datetime				Yes	NULL
N0500B_active	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
N0500B	datetime				Yes	NULL
N0520B_active	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
C_CCN_NUM	datetime				Yes	NULL
F2000B	datetime				Yes	NULL
F2100A	nvarchar	1			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
F2100B	datetime				Yes	NULL
F2200A	nvarchar	1			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
F3000A	nvarchar	1			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1000A	nvarchar	20			Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
N0510B	datetime				Yes	NULL
N0520B	datetime				Yes	NULL
J0910C1	bit		Yes		Yes	0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0910C2	bit		Yes		Yes	0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0910C3	bit		Yes		Yes	0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0910C4	bit		Yes		Yes	0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0910C5	bit		Yes		Yes	0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0910C6	bit		Yes		Yes	0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0910C7	bit		Yes		Yes	0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
J0910C9	bit		Yes		Yes	0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
var_chart_gender	nvarchar	20			Yes	NULL
var_char_ethnicity	nvarchar	20			Yes	NULL
Z0400	datetime				Yes	NULL
A1000B	nvarchar	20			Yes	NULL
A1000C	nvarchar	20			Yes	NULL
A1000D	nvarchar	20			Yes	NULL
A1000E	nvarchar	20			Yes	NULL
A1000F	nvarchar	20			Yes	NULL
A1400A	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400B	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400C	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400D	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400G	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400H	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400I	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400J	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400K	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400X	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A1400Y	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
O5000	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
O5010A1	integer		Yes		Yes	NULL
O5010A2	integer		Yes		Yes	NULL
O5010A3	integer		Yes		Yes	NULL
O5010B1	integer		Yes		Yes	NULL
O5010B2	integer		Yes		Yes	NULL
O5010B3	integer		Yes		Yes	NULL
O5010C1	integer		Yes		Yes	NULL
O5010C2	integer		Yes		Yes	NULL
O5010C3	integer		Yes		Yes	NULL
O5010D1	integer		Yes		Yes	NULL
O5010D2	integer		Yes		Yes	NULL
O5010D3	integer		Yes		Yes	NULL
O5010E1	integer		Yes		Yes	NULL
O5010E2	integer		Yes		Yes	NULL
O5010E3	integer		Yes		Yes	NULL
O5010F1	integer		Yes		Yes	NULL
O5010F2	integer		Yes		Yes	NULL
O5010F3	integer		Yes		Yes	NULL
O5020	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
O5030A1	integer		Yes		Yes	NULL
O5030A2	integer		Yes		Yes	NULL
O5030A3	integer		Yes		Yes	NULL
O5030A4	integer		Yes		Yes	NULL
O5030B1	integer		Yes		Yes	NULL
O5030B2	integer		Yes		Yes	NULL
O5030B3	integer		Yes		Yes	NULL
O5030B4	integer		Yes		Yes	NULL
O5030C1	integer		Yes		Yes	NULL
O5030C2	integer		Yes		Yes	NULL
O5030C3	integer		Yes		Yes	NULL
O5030C4	integer		Yes		Yes	NULL
O5030D1	integer		Yes		Yes	NULL
O5030D2	integer		Yes		Yes	NULL
O5030D3	integer		Yes		Yes	NULL
O5030D4	integer		Yes		Yes	NULL
O5030E1	integer		Yes		Yes	NULL
O5030E2	integer		Yes		Yes	NULL
O5030E3	integer		Yes		Yes	NULL
O5030E4	integer		Yes		Yes	NULL
O5030F1	integer		Yes		Yes	NULL
O5030F2	integer		Yes		Yes	NULL
O5030F3	integer		Yes		Yes	NULL
O5030F4	integer		Yes		Yes	NULL
J0905	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
A0550	nvarchar	20			Yes	NULL
Z0400A	nvarchar	20			Yes	NULL
Z0400B	datetime				Yes	NULL
Z0500A	nvarchar	20			Yes	NULL

ITMSET14 Relationships

Parent and Child relations to ITMSET14.

Note that the only Required status on relationships that affect a POST of an object are on the parent relations. A Required status on a child relation is only meaningful when POSTing the child object.

Linking during POST: a custom object record can be linked to a parent or child record (custom or standard) during POST by including (in the payload) the realtion id paired with the parent or child object record being linked to. For example: { "REl_2894" : 1832 } Multiple links may be created in the same POST.

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To
REL_2894	1-Many	Yes	Patient_Chart
REL_2895	1-Many		Payor_Information
Parent Relations ↑ ITMSET14 ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To

Read ITMSET14 by id:

GET https:/.../v1/517090/ITMSET14/{id}

Response codes:

200 - OK
404 - Not found or user does not have permission to access resources of this type.
400 - Client error
500 - Server error

Response data: GET https:/.../v1/517090/ITMSET14/1

Unauthorized request.

Read ITMSET14 by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/ITMSET14[?{filter}]

Response codes:

400 - Client error
500 - Server error
404 - Not found or user does not have permission to access resources of this type.
200 - OK

Response data: GET https:/.../v1/517090/2895/5/links/ITMSET14

Unauthorized request.

Read ITMSET14 by filter:

GET https:/.../v1/517090/ITMSET14[?{filter}]

Response codes:

200 - OK
400 - Client error
404 - Not found or user does not have permission to access resources of this type.
500 - Server error

Response data: GET https:/.../v1/517090/ITMSET14?id=1

Unauthorized request.

Create ITMSET14:

POST https:/.../v1/517090/ITMSET14

Request data [See properties]:

Response codes:

201 - OK [See response data]
400 - Client error
500 - Server error

Update ITMSET14:

PUT https:/.../v1/517090/ITMSET14/{id}

Request data [See properties]:

Response codes:

200 - OK Content returned [See response data]
204 - OK No content
400 - Client error
404 - Not found
500 - Server error

Delete ITMSET14:

DELETE https:/.../v1/517090/ITMSET14/{id}

The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe

Response codes:

204 - OK
400 - Client error
404 - Not found
500 - Server error

Create Link for ITMSET14:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/ITMSET14/{id}

{relation_id} can indicate either a parent or a child relation.

Response codes:

204 - OK
400 - Client error
404 - Not found
500 - Server error

Delete Link for ITMSET14:

DELETE https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/ITMSET14/{id}

Deleting a link from ITMSET14 down to a child object must be explicitly indicated by negating the relation id:

DELETE https:/.../v1/517090/{-child_relation_id}/{child_id}/links/ITMSET14/{id}

Response codes:

204 - OK
400 - Client error
404 - Not found
500 - Server error

QBOS REST API documentation (ITMSET14)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

ITMSET14 properties

ITMSET14 Relationships

Read ITMSET14 by id:

GET https:/.../v1/517090/ITMSET14/{id}

Read ITMSET14 by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/ITMSET14[?{filter}]

Read ITMSET14 by filter:

GET https:/.../v1/517090/ITMSET14[?{filter}]

Create ITMSET14:

POST https:/.../v1/517090/ITMSET14

Update ITMSET14:

PUT https:/.../v1/517090/ITMSET14/{id}

Delete ITMSET14:

DELETE https:/.../v1/517090/ITMSET14/{id}

Create Link for ITMSET14:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/ITMSET14/{id}

Delete Link for ITMSET14:

DELETE https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/ITMSET14/{id}

DELETE https:/.../v1/517090/{-child_relation_id}/{child_id}/links/ITMSET14/{id}