x QBOS REST API documentation for PHARM

QBOS REST API documentation (PHARM)

(return to Main Document)

Introduction

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

PHARM 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 5407 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.
Patient_First_Name nvarchar 24 Yes NULL
Patient_Last_Name nvarchar 24 Yes NULL
Reversal_Flag nvarchar 1 Yes NULL
Revenue_Code nvarchar 4 Yes NULL
HCPS_Code nvarchar 5 Yes NULL
NDC_Code nvarchar 13 Yes NULL
Medication_Name nvarchar 120 Yes NULL
Vendor_ID nvarchar 20 Yes NULL
Message_Timestamp datetime Yes NULL
Pharmacy_ID nvarchar 10 Yes NULL
Pharmacy_Name nvarchar 50 Yes NULL
Z_Unique_Claim_Identifier bigint Yes Yes NULL
Fill_Date datetime Yes NULL
Patient_Chart_ID nvarchar 20 Yes NULL
Patient_SSN nvarchar 11 Yes NULL
Medication_Route_Type nvarchar(MAX) Yes NULL
Medication_Dosage nvarchar(MAX) Yes NULL
Quantity decimal(10,3) 10 Yes Yes NULL
Unit_Of_Measure nvarchar 2 Yes NULL
HCPCS_Unit_Dose decimal(9,2) 9 Yes Yes NULL
Total_Cost decimal(13,2) 13 Yes Yes NULL
Unit_AWP decimal(10,2) 10 Yes Yes NULL
Overhead_Cost decimal(13,2) 13 Yes Yes NULL
Compound nvarchar 1 Yes NULL
Prescription_ID nvarchar 50 Yes NULL
Patient_Gender nvarchar 1 Yes NULL
Patient_DOB datetime Yes NULL
Unique_Claim_ID nvarchar 20 Yes NULL

PHARM Relationships

Parent and Child relations to PHARM.

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_2846" : 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_2846 1-Many Patient_Chart
Parent Relations
↑
PHARM
↓
Child Relations
Relation Id Cardinality
(Parent-to-Child)		 Required
**on POST of child		 Links Down To  
 



Read PHARM by id:

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

Read PHARM by parent id:

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

Read PHARM by filter:

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

Create PHARM:

POST https:/.../v1/517090/PHARM

Request data [See properties]:

Response codes:

Update PHARM:

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

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

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

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


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

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

Response codes:

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