QBOS REST API documentation for MEDICAIDSETTINGS

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

MEDICAIDSETTINGS 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	5785	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.
Authorization_Required	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.
Contract	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.
Face_Interval	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.
Adult_Limit	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.
Adult_Day_Limit	integer		Yes		Yes	NULL
Adult_Money_Limit	money		Yes		Yes	NULL
Child_Limit	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.
Child_Day_Limit	integer		Yes		Yes	NULL
Child_Money_Limit	money		Yes		Yes	NULL
Allow_Split_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.
Split_Auth	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.
Split_Hospital	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.
Split_LOC	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.
Allow_Negotiated_Rates	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.
Service_Days_Rate	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.
Visits_Rate	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.
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.
Subtract_First_Claim	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.
NOE_Required	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.
NOTR_Required	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.
Face_Required	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.
NOE_Claim_Format	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.
NOE_Print_Paper	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.
NOE_Print_Format	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.
Claim_Authorization	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.
Room_and_Board	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.
Authorization_LOC_Change	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.
Authorization_Location_Change	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.
Authorization_Effective_Dates	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.
Authorization_Exceeds_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.
Authorization_Days_Limit	integer		Yes		Yes	NULL
Rate_Options	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.

MEDICAIDSETTINGS Relationships

Parent and Child relations to MEDICAIDSETTINGS.

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

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To
REL_3176	1-1	Yes	Payer_Settings
Parent Relations ↑ MEDICAIDSETTINGS ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To

Read MEDICAIDSETTINGS by id:

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

Unauthorized request.

Read MEDICAIDSETTINGS by parent id:

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

Unauthorized request.

Read MEDICAIDSETTINGS by filter:

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

Unauthorized request.

Create MEDICAIDSETTINGS:

POST https:/.../v1/517090/MEDICAIDSETTINGS

Request data [See properties]:

Response codes:

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

Update MEDICAIDSETTINGS:

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

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

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

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

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

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

Response codes:

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

QBOS REST API documentation (MEDICAIDSETTINGS)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

MEDICAIDSETTINGS properties

MEDICAIDSETTINGS Relationships

Read MEDICAIDSETTINGS by id:

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

Read MEDICAIDSETTINGS by parent id:

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

Read MEDICAIDSETTINGS by filter:

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

Create MEDICAIDSETTINGS:

POST https:/.../v1/517090/MEDICAIDSETTINGS

Update MEDICAIDSETTINGS:

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

Delete MEDICAIDSETTINGS:

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

Create Link for MEDICAIDSETTINGS:

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

Delete Link for MEDICAIDSETTINGS:

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

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