QBOS REST API documentation for PYRCLM

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}/...

PYRCLM 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	2593	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.
Enable_Claims_Generation	bit		Yes		Yes	1	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
EDI_Payor_Code	nvarchar	20			Yes	NULL
EDI_Provider_Code	nvarchar	20			Yes	NULL
Hospice_Health_Plan_ID	nvarchar	20			Yes	NULL
Type_of_benefit	integer		Yes		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.
H_Bill_day_of_Revocation	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.
H_Bill_Patient_Visit	integer		Yes		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.
H_Bill_day_of_death	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.
H_Bill_Days_of_service	integer		Yes		Yes	5	This property is populated by a Type 2 Value List. Click here for the appropriate API and sample of value options for this column.
H_Bill_day_of_Decert	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.
H_Bill_day_of_transfer	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.
H_Claims_Document_Format	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.
H_Electronic_file_format	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.
H_List_days_of_service	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.
H_List_patient_visits	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.
R_Bill_day_of_death	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.
R_Pay_day_of_death	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.
R_Bill_day_of_revocation	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.
R_Pay_day_of_revocation	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.
R_Bill_day_of_Decert	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.
R_Pay_day_of_Decert	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.
R_Bill_Day_of_Transfer	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.
R_Pay_Day_of_Transfer	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.
R_Deduct_Patient_liablity_on_bill	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.
R_Deduct_Patient_liability_on_pay	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.
R_List_days_of_service	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.
R_List_patient_visits	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.
R_Claims_document_format	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.
R_Electronic_file_format	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.
R_Benefit_spread_method	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.
Recertification_Periods	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.
Insurer_Type	nvarchar	2			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.
R_Bill_Days_Of_Service	integer		Yes		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.
R_Pay_Days_Of_Service	integer		Yes		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.
EDI_Payor_Name	nvarchar	20			Yes	NULL
R_Bill_Patient_Liability	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.
Total_Bills_Generated	integer		Yes		Yes	NULL
Billing_Frequency	nvarchar	1			Yes	M	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Name	nvarchar	60			Yes	NULL
Recert_freq	integer		Yes		Yes	1	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
FaceToFace_freq	integer		Yes		Yes	1	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Batch_NOE	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.
Hospice_Billing_Addr1	nvarchar	50			Yes	NULL
Hospice_Billing_Addr2	nvarchar	50			Yes	NULL
Hospice_Billing_City	nvarchar	20			Yes	NULL
Hospice_Billing_State	nvarchar	20			Yes	NULL
Hospice_Billing_Zip	nvarchar	20			Yes	NULL
H_Consolidate_Consecutive_Days	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.
H_Pays_Continuous_Care	bit		Yes		Yes	1	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
H_Requires_Preauthorization	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.
NOE_Required	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.
NOTR_Required	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.
Physician_Order_Required	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.
H_Patient_Liability	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.
H_Requires_Recert	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.
H_Requires_Face	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.
H_Imposes_Adult_Limit	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.
H_Imposes_Child_Limmit	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.
H_Adult_Day_Limit	integer		Yes		Yes	NULL
H_Child_Day_Limit	integer		Yes		Yes	NULL
H_Adult_Age	integer		Yes		Yes	18
H_Late_Billing_Limit_in_Months	integer		Yes		Yes	12
Claim_Rate	integer		Yes		Yes	1

PYRCLM Relationships

Parent and Child relations to PYRCLM.

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

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To	Is Unary?^*
REL_1677	1-1	Yes	Contact
REL_2173	1-Many	Yes	Billing_Management_Panel	Yes
Parent Relations ↑ PYRCLM ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To
REL_2674	1-Many	Yes**	Payor_Code_Map
REL_2174	1-Many		Billing_Runs

SHORTCUT TIP! (read Is Unary?...)
* Is Unary? == means that there will only be one record per corporation. When POSTing a PYRCLM record under a unary record, you do not need to retrieve the unary record id, first. Use a -1 to indicate the unary record id as in "REL_2173":"-1" and the POST will determine the appropriate parent record id to link the PYRCLM to.

Read PYRCLM by id:

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

Unauthorized request.

Read PYRCLM by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/PYRCLM[?{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/1677/528208/links/PYRCLM

Unauthorized request.

Read PYRCLM by filter:

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

Unauthorized request.

Create PYRCLM:

POST https:/.../v1/517090/PYRCLM

Request data [See properties]:

Response codes:

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

Update PYRCLM:

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

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

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

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

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

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

Response codes:

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

QBOS REST API documentation (PYRCLM)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

PYRCLM properties

PYRCLM Relationships

Read PYRCLM by id:

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

Read PYRCLM by parent id:

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

Read PYRCLM by filter:

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

Create PYRCLM:

POST https:/.../v1/517090/PYRCLM

Update PYRCLM:

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

Delete PYRCLM:

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

Create Link for PYRCLM:

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

Delete Link for PYRCLM:

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

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