QBOS REST API documentation for ELIGREV

The ELIGREV API allows client applications to maintain ELIGREV 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}/...

ELIGREV 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	5624	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.
Patient_ID_listed	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.
Date_to_authorize	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.
Effective_date	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.
Time_of_admission	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.
Patient_hospice_visit	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.
Patient_pg2	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.
Patient_rep	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.
Rep_sign_date_present	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.
Cert_signed	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.
Cert_not_signed	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.
Verbal_cert	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.
Incl_BP_dates	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.
Physician_sign_legible	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.
Cert_physician_signed	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.
Cert_physician_not_signed	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.
Cert_prior_billing	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.
Att_phy_sign_legible	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.
Box_checked	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.
Sufficient_explain	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.
Phy_composed_signed	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.
Narrative_legible	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.
F2F_documented	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.
F2F_attested	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.
Findings_provided	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.
Attest_statement	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.
Sign_legible	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.
FAST_score_beyond	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.
PPS_score_less	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.
Struct_impairments	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.
Activity_limitations	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.
Secondary_cond	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.
Patiend_depends_CG	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.
Increased_TTT	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.
Prognosis_support	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.
Elig_summary	nvarchar	150			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.

ELIGREV Relationships

Parent and Child relations to ELIGREV.

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_3096" : 1832 } Multiple links may be created in the same POST.

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To
n/a	2147482647		Corporate
Parent Relations ↑ ELIGREV ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To
REL_3096	1-1		Notes

Read ELIGREV by id:

GET https:/.../v1/517090/ELIGREV/{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/ELIGREV/1

Unauthorized request.

Read ELIGREV by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/ELIGREV[?{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/0/506764/links/ELIGREV

Unauthorized request.

Read ELIGREV by filter:

GET https:/.../v1/517090/ELIGREV[?{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/ELIGREV?id=1

Unauthorized request.

Create ELIGREV:

POST https:/.../v1/517090/ELIGREV

Request data [See properties]:

Response codes:

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

Update ELIGREV:

PUT https:/.../v1/517090/ELIGREV/{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 ELIGREV:

DELETE https:/.../v1/517090/ELIGREV/{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 ELIGREV:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/ELIGREV/{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 ELIGREV:

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

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

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

Response codes:

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

QBOS REST API documentation (ELIGREV)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

ELIGREV properties

ELIGREV Relationships

Read ELIGREV by id:

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

Read ELIGREV by parent id:

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

Read ELIGREV by filter:

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

Create ELIGREV:

POST https:/.../v1/517090/ELIGREV

Update ELIGREV:

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

Delete ELIGREV:

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

Create Link for ELIGREV:

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

Delete Link for ELIGREV:

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

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