x QBOS REST API documentation for CAASSESSMENT

QBOS REST API documentation (CAASSESSMENT)

(return to Main Document)

Introduction

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

CAASSESSMENT 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 5566 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.
Start_Date datetime Yes NULL
End_Date datetime Yes NULL
Completed 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.
CarePlanCompleted 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.
VisitsCompleted 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.
IDGCompleted 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.
Discipline nvarchar 50 Yes NULL
Activity nvarchar 10 Yes NULL
IsDeleteAllow 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.

CAASSESSMENT Relationships

Parent and Child relations to CAASSESSMENT.

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_2937" : 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_2943 1-Many Patient_Chart
REL_2944 1-Many DAL_Activities
Parent Relations
↑
CAASSESSMENT
↓
Child Relations
Relation Id Cardinality
(Parent-to-Child)		 Required
**on POST of child		 Links Down To  
REL_2937 1-1 Yes** CA_ADL_SpecialNeeds  
REL_2952 1-1 Yes** CA_Bereavement  
REL_2948 1-1 Yes** CA_DMESupplies  
REL_2955 1-1 Yes** CA_Gastrointestinal  
REL_2956 1-1 Yes** CA_Genitourinary  
REL_2949 1-1 Yes** CA_LevelofCare  
REL_2974 1-1 Yes** CA_Neuro  
REL_2957 1-1 Yes** CA_NutritionMetabolic  
REL_2946 1-1 CA_Respiratory  
REL_2950 1-1 Yes** CA_SafetyTeachings  
REL_2958 1-1 Yes** CA_SkinMusculoskeletal  
REL_2953 1-1 Yes** CA_SocialWork  
REL_2951 1-1 Yes** CA_Spiritual  
REL_2954 1-Many CA_Vitals  
REL_2976 1-Many Yes** CP_AUDITLOG  
REL_2978 1-Many Yes** CP_IDG_DISCUSSION  
REL_2979 1-Many Yes** CP_IDG_NARRATIVES  
REL_2975 1-Many Yes** CP_IDGREVIEW  
REL_2977 1-Many Yes** CP_IDGReview_SectionStatus  
REL_2973 1-Many CP_MenuStatus  
REL_2960 1-Many CP_POC_HOMEMAKER_CATEGORIES  
REL_2961 1-Many Yes** CP_POC_HOMEMAKER_NARRATIVE  
REL_2959 1-Many CP_POC_HOSPICIDE  
REL_2982 1-Many CP_POC_HOSPICIDE_CATEGORY  
REL_2962 1-Many CP_POC_HOSPICIDE_NARATIVES  
REL_2983 1-Many CP_POC_HOSPICIDE_NEEDS  
REL_2984 1-Many CP_POC_HOSPICIDE_RN  
REL_2969 1-Many Yes** CP_POC_IDG_APPROVAL  
REL_2987 1-Many Yes** CP_POC_Issue  
REL_2968 1-Many CP_POC_VISITFREQUENCY  
REL_2963 1-Many Yes** CP_POC_VOLUNTEER_CONTACT  
REL_2964 1-Many Yes** CP_POC_VOLUNTEER_INSTRUCTIIONS  
REL_2965 1-Many Yes** CP_POC_VOLUNTEER_NARRATIVES  
REL_2966 1-Many Yes** CP_POC_VOLUNTEER_NPC_ACTIVITIES  
REL_2967 1-Many Yes** CP_POC_VOLUNTEER_PC_ACTIVITIES  
REL_2972 1-Many Yes** CP_VISIT_ISSUES  
REL_2971 1-Many Yes** CP_VISIT_SUMMARY  
REL_2985 1-Many Yes** CP_VISIT_SUMMARY_NARATIVES  
REL_2986 1-Many Yes** CP_VISIT_SUMMARY_SCDETAILS  
REL_2970 1-Many Yes** CP_VISITS  
REL_2989 1-Many Yes** Medication_PU  
REL_2980 1-Many Yes** Medication_PU_History  
REL_2988 1-Many Treatment_PU  
REL_2981 1-Many Yes** Treatment_PU_History  
REL_3159 1-Many Yes** CA_LevelofCare_CATEGORIES  
REL_3195 1-Many Yes** CAAssessment_ACTV2  
REL_3217 1-Many Yes** Discipline_Visits  
REL_3220 1-Many Yes** AssessmentNarratives_Continuous  
REL_3227 1-Many Yes** F2FSummaryLabAndNarr  
REL_3242 1-1 Yes** CA_Volunteer  
REL_3252 1-1 CP_POC_HOMEMAKER  
REL_3266 1-Many POC_Goal  
REL_3268 1-Many POC_Intervention  
REL_3270 1-Many POC_History  
REL_3285 1-1 Yes** CA_Supervisory_Visit  
REL_3276 1-Many Assessment_Issue  
REL_3265 1-Many POC_Issue  
REL_3230 1-Many Yes** F2FAttestation  
REL_3223 1-Many Patient_Symptoms_Reasons  
REL_3237 1-Many Yes** CP_POC_Goals  
REL_2945 1-1 Yes** CA_Pain  
REL_2947 1-1 Yes** CA_Cardiovascular  
REL_3251 1-Many Notes  
 



Read CAASSESSMENT by id:

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

Read CAASSESSMENT by parent id:

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

Read CAASSESSMENT by filter:

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

Create CAASSESSMENT:

POST https:/.../v1/517090/CAASSESSMENT

Request data [See properties]:

Response codes:

Update CAASSESSMENT:

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

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

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

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


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

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

Response codes:

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