x QBOS REST API documentation for UNMEDS

QBOS REST API documentation (UNMEDS)

(return to Main Document)

Introduction

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

UNMEDS 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 5849 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.
First_Name nvarchar 50 Yes NULL
Last_Name nvarchar 50 Yes NULL
Date_Of_Birth datetime Yes NULL
Patient_SSN nvarchar 11 Yes NULL
Patient_Code nvarchar 20 Yes NULL
Patient_Gender nvarchar 20 Yes NULL
NDC nvarchar 20 Yes NULL
Fill_Date datetime Yes NULL
Error_Message nvarchar 100 Yes NULL
Record_Insert_Date datetime Yes NULL
Prescription_Number nvarchar 20 Yes NULL
Unique_Claim_Identifier nvarchar 20 Yes NULL
Pharmacy_ID nvarchar 20 Yes NULL
Pharmacy_Name nvarchar 50 Yes NULL

Read UNMEDS by id:

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

Read UNMEDS by parent id:

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

Read UNMEDS by filter:

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

Create UNMEDS:

POST https:/.../v1/517090/UNMEDS

Request data [See properties]:

Response codes:

Update UNMEDS:

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

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

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

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


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

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

Response codes:

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