x QBOS REST API documentation for DRINFO

QBOS REST API documentation (DRINFO)

(return to Main Document)

Introduction

The DRINFO API allows client applications to maintain DRINFO 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

See details in Authentication Documentation.

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

DRINFO 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 2291 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.
Additional_Info nvarchar(MAX) Yes NULL
NPI nvarchar 10 Yes Yes  
Current_Status 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.
Status_Date datetime Yes NULL
FID nvarchar 9 Yes NULL
State_License nvarchar 9 Yes 999999999
Signature_On_File 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.
Accepts_Medicare_Assignment 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.
Taxonomy_Code nvarchar 20 Yes 251G00000X
type 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.
Provider_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.
Specialty nvarchar 50 Yes NULL
License_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.
Other_License_Type nvarchar 50 Yes NULL
License_Expiration_Date datetime Yes NULL
License_State 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.
Primary_Language 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.
Other_Language nvarchar 50 Yes NULL
Website nvarchar 50 Yes NULL
PECOS_Enrolled 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.
PECOS_Enrolled_Date datetime Yes NULL
Active_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.
Contractor 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.
Is_User 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.
Contractor_Status_Date datetime Yes NULL
Practice integer Yes Yes NULL
Contact_Email 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.
Contact_Phone 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.

DRINFO Relationships

Parent and Child relations to DRINFO.

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_2899" : 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_1591 1-1 Yes Contact
Parent Relations
↑
DRINFO
↓
Child Relations
Relation Id Cardinality
(Parent-to-Child)		 Required
**on POST of child		 Links Down To  
REL_2899 1-Many Attending_Physician_Info  
REL_3213 1-Many Yes** Physician_License  
REL_3214 1-Many Yes** Status_History  
REL_3161 1-Many Attending_Physician_Info  
REL_2911 1-Many Patient_Chart  
REL_2903 1-Many Patient_Chart  
 



Read DRINFO by id:

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

Read DRINFO by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/DRINFO[?{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/1591/524821/links/DRINFO
Unauthorized request.

Read DRINFO by filter:

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

Create DRINFO:

POST https:/.../v1/517090/DRINFO

Request data [See properties]:

Response codes:

Update DRINFO:

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

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

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

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


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

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

Response codes:

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