QBOS REST API documentation for SRVPRD

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

SRVPRD 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	2581	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.
Admit_Date	datetime				Yes	NULL
Discharge_Date	datetime				Yes	NULL
Discharge_Reason	nvarchar	3			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.
Last_Billed_Date	datetime				Yes	NULL
Staff_Presence	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.
Transferring_to_Hospice	bigint		Yes		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.
NOE_Submitted	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_Submitted	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.
PhysiciansOrder	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.
Revocation_Reason	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.
Death_Attended	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.
Death_Date	datetime				Yes	NULL
Discharge_Cause	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.
PhysicianNotified	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.
PharmacyNotified	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.
DMESupplierNotified	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.
MedicationsDestroyed	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.
LocationOfDeath	nvarchar	20			Yes	NULL
DeathNotAttended_Reason	nvarchar	50			Yes	NULL
FamilyPCG_Death_Attended	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.
FamilyPCG_DeathNotAttended_Reason	nvarchar	50			Yes	NULL
Coroner_TimeReceived	datetime				Yes	NULL
FuneralHome_TimeReceived	datetime				Yes	NULL
PersonalItems	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.
Notes	nvarchar	100			Yes	NULL
PhysicianName	nvarchar	50			Yes	NULL
PharmacyName	nvarchar	50			Yes	NULL
DMESupplierName	nvarchar	50			Yes	NULL
CoronerName	nvarchar	50			Yes	NULL
FuneralHomeName	nvarchar	50			Yes	NULL
BodyReceivedByName	nvarchar	50			Yes	NULL
NameOfFacility	nvarchar	50			Yes	NULL
FacilityType	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.
FacilityLocation	nvarchar	200			Yes	NULL
Seeking_Aggressive_Treatment	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.

SRVPRD Relationships

Parent and Child relations to SRVPRD.

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

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To
REL_1666	1-Many	Yes	Patient_Chart
Parent Relations ↑ SRVPRD ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To
REL_1895	1-Many	Yes**	Room_and_Board_Service_Period
REL_2541	1-Many	Yes**	Notice_of_Election

Read SRVPRD by id:

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

Unauthorized request.

Read SRVPRD by parent id:

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

Unauthorized request.

Read SRVPRD by filter:

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

Unauthorized request.

Create SRVPRD:

POST https:/.../v1/517090/SRVPRD

Request data [See properties]:

Response codes:

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

Update SRVPRD:

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

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

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

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

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

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

Response codes:

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

QBOS REST API documentation (SRVPRD)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

SRVPRD properties

SRVPRD Relationships

Read SRVPRD by id:

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

Read SRVPRD by parent id:

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

Read SRVPRD by filter:

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

Create SRVPRD:

POST https:/.../v1/517090/SRVPRD

Update SRVPRD:

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

Delete SRVPRD:

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

Create Link for SRVPRD:

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

Delete Link for SRVPRD:

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

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