QBOS REST API documentation for PAYSRC

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

PAYSRC 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	2552	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.
Payor_Source_is_Primary	integer		Yes		Yes	1	This property is populated by a Type 2 Value List. Click here for the appropriate API and sample of value options for this column.
Benefit_type	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.
Payor_source_valid	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.
Payor_Source_Effective_date	datetime				Yes	NULL
Payor_source_expiration_date	datetime				Yes	NULL
Reason_for_expiration	nvarchar(MAX)				Yes	NULL
Medicare_Number	nvarchar	30			Yes	NULL
Medicare_Part_A_or_B	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.
Medicare_Benefits_Assigned	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.
Medicare_EOB_Requested	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.
Medicare_State	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.
Medicaid_State	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.
Medicaid_provider	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.
Medicaid_Number	nvarchar	30			Yes	NULL
Medicaid_Type	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.
Medicaid_Rate_level	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.
Medicaid_Authorization_Number	nvarchar	30			Yes	NULL
Medicaid_authorization_expiration_date	datetime				Yes	NULL
Medicaid_Patient_has_liability	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.
PI_Carrier_Name	nvarchar	50			Yes	NULL
PI_Company_address	nvarchar(MAX)				Yes	NULL
PI_Claim_Status_Phone	nvarchar	20			Yes	NULL
PI_Allows_Faxed_Claims	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.
PI_Group_Number	nvarchar	20			Yes	NULL
PI_Claim_Fax_Number	nvarchar	20			Yes	NULL
PI_Name_of_Insured	nvarchar	50			Yes	NULL
PI_Policy_Number	nvarchar	20			Yes	NULL
PI_Relationship_to_Patient	nvarchar	25			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.
PI_Has_Deductible	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.
PI_Deductible_Amount	money		Yes		Yes	NULL
PI_Deductible_met	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.
PI_Deductible_Amount_Met	money		Yes		Yes	NULL
PI_Has_Out_of_Pocket_Expense	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.
PI_Out_of_Pocket_Expense_Amount	money		Yes		Yes	NULL
PI_Stop_Loss_Amount	money		Yes		Yes	NULL
PI_Lifetime_Hospice_Maximum_Amount	money		Yes		Yes	NULL
PI_Case_Manager_Name	nvarchar	40			Yes	NULL
PI_Case_Manager_Phone	nvarchar	20			Yes	NULL
PI_Rate_agreed_upon_per_Day	money		Yes		Yes	NULL
PI_Rate_agreed_upon_per_visit	money		Yes		Yes	NULL
PI_Billing_Form_to_submit	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.
PI_Are_We_a_Participating_Provider	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.
PI_Does_Carrier_send_check_to_provider_or_family	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.
PI_Copied_and_scanned_Patient_Ins_ID_Card	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.
PI_Authorization_Number	nvarchar	30			Yes	NULL
PI_Authorized_Days_Covered	nvarchar	20			Yes	NULL
PI_authorization_expiration_date	datetime				Yes	NULL
PI_SbrFirstName	nvarchar	35			Yes	NULL
PI_SbrLastName	nvarchar	35			Yes	NULL
PI_SbrAddr1	nvarchar	50			Yes	NULL
PI_SbrAddr2	nvarchar	50			Yes	NULL
PI_SbrCity	nvarchar	20			Yes	NULL
PI_SbrState	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.
PI_SbrZip	nvarchar	10			Yes	NULL
PP_Person_responsible_for_payment	nvarchar	30			Yes	NULL
PP_Relationship_to_Patient	nvarchar	20			Yes	NULL
PP_Contact_Address	nvarchar(MAX)				Yes	NULL
PP_Contact_Phone	nvarchar	20			Yes	NULL
Medical_Director_Certified	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.
Physician_Certified	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.
Spoke_with	nvarchar	35			Yes	NULL
Information_collected_by	nvarchar	20			Yes	NULL
Additional_Comments	nvarchar(MAX)				Yes	NULL
Date_collected	datetime				Yes	NULL
Hospice_Billing_info_complete	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.
RNB_Release_for_Billing	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.
C_Has_Patient_previously_used_Hospice_benefits	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_Transferred_from_Hospice	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_Name_of_other_Hospice	nvarchar	80			Yes	NULL	This property is populated by a Type 3 Value List. Click here for the appropriate API and sample of value options for this column.
C_Last_Benefit_Period_Used	integer		Yes		Yes	NULL
C_Last_date_on_Service	datetime				Yes	NULL
C_Initial_Certification_Date	datetime				Yes	NULL
C_current_certification_date	datetime				Yes	NULL
C_Current_certification_Period	nvarchar	10			Yes	NULL
C_calc_Next_Certification_Date	datetime				Yes	NULL
C_Current_F2F_visit_date	datetime				Yes	NULL
C_calc_Next_F2F_visit_date	datetime				Yes	NULL
C_Calc_Last_F2F_prd	nvarchar	10			Yes	NULL
NOE_Status	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.
Generate_Medicare_NOE_81A	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.
Type_of_NOE	nvarchar	20			Yes	81A	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Paper_Format	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.
PI_Carrier_Contact_Name	nvarchar	50			Yes	NULL
PI_Group3_Number	nvarchar	20			Yes	NULL
PI_Part_D_Provider_Name	nvarchar	50			Yes	NULL
PI_Part_D_Converage_Number	nvarchar	50			Yes	NULL
PI_Insured_Phone_Number	nvarchar	20			Yes	NULL
PI_Insured_Fax_Number	nvarchar	20			Yes	NULL
PD_Room_and_Board_coverage	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.
PD_Room_and_Board_Liability_1	decimal(20,2)	20	Yes		Yes	NULL
PI_Case_Manager_Fax	nvarchar	20			Yes	NULL
Provider_Type	nvarchar	50			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.
Total_Claims_Value	money		Yes		Yes	0.0
On_Hold	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.
On_Hold_Reason	nvarchar	100			Yes	NULL

PAYSRC Relationships

Parent and Child relations to PAYSRC.

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

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To
REL_1658	1-Many	Yes	Patient_Chart
REL_1668	1-Many	Yes	Contact
Parent Relations ↑ PAYSRC ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To
REL_1667	1-Many	Yes**	Patient_Liability
REL_2544	1-Many		Billing_Period_Details
REL_2896	1-Many	Yes**	Patient_Hospice_Rates
REL_2897	1-Many	Yes**	Patient_Hospice_Rates
REL_2895	1-Many		Hospice_itemSet_2014
REL_2542	1-Many	Yes**	Notice_of_Election

Read PAYSRC by id:

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

Unauthorized request.

Read PAYSRC by parent id:

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

Unauthorized request.

Read PAYSRC by filter:

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

Unauthorized request.

Create PAYSRC:

POST https:/.../v1/517090/PAYSRC

Request data [See properties]:

Response codes:

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

Update PAYSRC:

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

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

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

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

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

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

Response codes:

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

QBOS REST API documentation (PAYSRC)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

PAYSRC properties

PAYSRC Relationships

Read PAYSRC by id:

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

Read PAYSRC by parent id:

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

Read PAYSRC by filter:

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

Create PAYSRC:

POST https:/.../v1/517090/PAYSRC

Update PAYSRC:

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

Delete PAYSRC:

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

Create Link for PAYSRC:

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

Delete Link for PAYSRC:

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

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