QBOS REST API documentation for HOSPCP

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

HOSPCP 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	2844	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.
NPI	nvarchar	10			Yes	NULL
Taxonomy	nvarchar	10			Yes	NULL
EIN	nvarchar	9			Yes	NULL
FacilityType	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.
Hospice_Name	nvarchar	255			Yes	NULL
EDI_Hospice_Contact_Name	nvarchar	255			Yes	NULL
EDI_Hospice_Contact_Phone	nvarchar	10			Yes	NULL
Billing_Address_1	nvarchar	50			Yes	NULL
Billing_Address_2	nvarchar	50			Yes	NULL
Billing_City	nvarchar	20			Yes	NULL
Billing_State	nvarchar	20			Yes	NULL
Billing_Zip	nvarchar	20			Yes	NULL
Mileage_Reimbursement_Rate	decimal(5,2)	5	Yes		Yes	NULL
Batch_Private_Payer_Bills	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.
Scheduled_Pay_Period_Frequency	integer		Yes		Yes	3	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_Display_Code	nvarchar	10			Yes	NULL
Parent_Hospice_ID	bigint		Yes		Yes	NULL
Hospice_Code	nvarchar	20			Yes	NULL
FacilityId	bigint		Yes		Yes	NULL
CCN	bigint		Yes		Yes	NULL
CAHPSVendorClientID	nvarchar	20			Yes	NULL
CAHPSVendorFileDefinitionID	nvarchar	20			Yes	NULL
STATE_CD	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.
organization_timezone	nvarchar	20			Yes	NULL
IsNewAsmtAllow	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.
NewAsmtStartDate	datetime				Yes	NULL
gapi_EmailAddress	nvarchar	100			Yes	NULL
IsMedMgmtAllowed	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.
CAHPS_Vendor	integer		Yes		Yes	1
IsNewPatient	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.
IsDemo	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.
IsCTIAllow	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.
IsCompPOCAllow	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.
IsHISAllow	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.
IsEligibilityVerification	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.
IsAbilityIntegrationAllow	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.
BillingStartDate	datetime				Yes	NULL
IsFlattenedUI	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.
IsNewCompany	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.
IsNewMeds	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.
IsCTIv2	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.
IsHISv2	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.
IsPatientBenefitv2	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.
IsNewCAHPS	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.

Read HOSPCP by id:

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

Unauthorized request.

Read HOSPCP by parent id:

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

Unauthorized request.

Read HOSPCP by filter:

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

Unauthorized request.

Create HOSPCP:

POST https:/.../v1/517090/HOSPCP

Request data [See properties]:

Response codes:

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

Update HOSPCP:

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

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

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

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

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

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

Response codes:

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

QBOS REST API documentation (HOSPCP)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

HOSPCP properties

Read HOSPCP by id:

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

Read HOSPCP by parent id:

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

Read HOSPCP by filter:

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

Create HOSPCP:

POST https:/.../v1/517090/HOSPCP

Update HOSPCP:

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

Delete HOSPCP:

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

Create Link for HOSPCP:

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

Delete Link for HOSPCP:

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

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