QBOS REST API documentation (datafield)

(return to Main Document)

Introduction

The datafield API allows client applications to maintain datafield data including any part of its demographic 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. We appreciate your help.

Getting Started

To place any request in QBOS API application from third party application you need to authenticate 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.

datafield 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 Description

id

bigint

 

 

 

Required for GET(by id),PUT,DELETE

parent_id

bigint

 

yes

 

parent_type

nvarchar

50

 

yes

 

type

nvarchar

50

 

 

 

Value is "datafield"

href

varchar

34

 

 

 

column_name

nvarchar

200

 

 

 

ord_num

smallint

 

 

 

data_type_id

smallint

 

 

 

char_length

smallint

 

 

 

scale

tinyint

 

 

 

req_sw

char

1

 

 

 

def_col_sw

char

1

 

 

 

filter_on_col_sw

char

1

 

 

 

default_value

nvarchar

1500

 

 

 

_marked_for_deletion_sw

char

1

 

 

 

_is_computed_sw

varchar

1

 

 

 

_published_data_column_id

int

 

 

 

_pub_column_name

nvarchar

200

 

 

 

_pub_filter_on_col_sw

char

1

 

 

 

_pub_default_value

nvarchar

1500

 

 

 

_properties_exist_sw

int

 

 

 

_pub_is_computed_sw

char

1

 

 

 

_old_column_name

nvarchar

200

 

 

 

_org_id

bigint

 

 

 

_resource_name

nvarchar

50

 

 

 

Read datafield by id:

GET https:/.../v1/ads/datafield/{id}

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/ads/datafield/26070
{ "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 26070, "href" : "\/v1\/ads\/datafield\/26070", "column_name" : "New_Patient_Chart_ID", "ord_num" : 128, "data_type_id" : 7, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 1, "filter_on_col_sw" : 1, "default_value" : 0, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 25228, "_pub_column_name" : "New_Patient_Chart_ID", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : 0, "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "New_Patient_Chart_ID", "_org_id" : 517090, "_resource_name" : "Patient Chart" }

Read datafield from parent:

GET https:/.../v1/ads/{parent_type}/{parent_id}/links/datafield[?{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

GET https:/.../v1/ads/resource/10617/links/datafield
Response data:
{ "datafield" : [ { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10758, "href" : "\/v1\/ads\/datafield\/10758", "column_name" : "AD_Related_to_Terminal_Diagnosis", "ord_num" : 54, "data_type_id" : 8, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10235, "_pub_column_name" : "AD_Related_to_Terminal_Diagnosis", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "AD_Related_to_Terminal_Diagnosis", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 22267, "href" : "\/v1\/ads\/datafield\/22267", "column_name" : "CG_Primary_Caregiver_Name", "ord_num" : 83, "data_type_id" : 4, "char_length" : 25, "scale" : 0, "req_sw" : 0, "def_col_sw" : 1, "filter_on_col_sw" : 1, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 21458, "_pub_column_name" : "CG_Primary_Caregiver_Name", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "CG_Primary_Caregiver_Name", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10745, "href" : "\/v1\/ads\/datafield\/10745", "column_name" : "CG_Primary_Caregiver", "ord_num" : 17, "data_type_id" : 4, "char_length" : 60, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 1, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10222, "_pub_column_name" : "CG_Primary_Caregiver", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "CG_Primary_Caregiver", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "_pub_filter_on_col_sw" : 1, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "RF_Date", "_org_id" : 517090, "_resource_name" : "Patient Chart", "def_col_sw" : 1, "filter_on_col_sw" : 1, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 8684, "_pub_column_name" : "RF_Date", "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 9180, "href" : "\/v1\/ads\/datafield\/9180", "column_name" : "RF_Date", "ord_num" : 2, "data_type_id" : 1, "char_length" : 20, "scale" : 0, "req_sw" : 0 }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 9019, "href" : "\/v1\/ads\/datafield\/9019", "column_name" : "RR_Provider_Relations", "ord_num" : 13, "data_type_id" : 4, "char_length" : 50, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 8523, "_pub_column_name" : "RR_Provider_Relations", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "RR_Provider_Relations", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10634, "href" : "\/v1\/ads\/datafield\/10634", "column_name" : "SF_Social_Worker", "ord_num" : 40, "data_type_id" : 4, "char_length" : 50, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10103, "_pub_column_name" : "SF_Social_Worker", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "SF_Social_Worker", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10500, "href" : "\/v1\/ads\/datafield\/10500", "column_name" : "SF_Attending_Physician", "ord_num" : 35, "data_type_id" : 4, "char_length" : 50, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 9968, "_pub_column_name" : "SF_Attending_Physician", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "SF_Attending_Physician", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 9017, "href" : "\/v1\/ads\/datafield\/9017", "column_name" : "RR_Followup_visit", "ord_num" : 9, "data_type_id" : 8, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : 0, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 8521, "_pub_column_name" : "RR_Followup_visit", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : 0, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "RR_Followup_visit", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 9016, "href" : "\/v1\/ads\/datafield\/9016", "column_name" : "RF_Caller_is_a_professional", "ord_num" : 3, "data_type_id" : 8, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : 0, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 8520, "_pub_column_name" : "RF_Caller_is_a_professional", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : 0, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "RF_Caller_is_a_professional", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "_pub_filter_on_col_sw" : 0, "_pub_default_value" : 0, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "PD_Is_A_Veteran", "_org_id" : 517090, "_resource_name" : "Patient Chart", "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7941, "href" : "\/v1\/ads\/datafield\/7941", "column_name" : "PD_Is_A_Veteran", "ord_num" : 24, "data_type_id" : 8, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : 0, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 7458, "_pub_column_name" : "PD_Is_A_Veteran" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7938, "href" : "\/v1\/ads\/datafield\/7938", "column_name" : "RF_Aware_of_Referral", "ord_num" : 6, "data_type_id" : 4, "char_length" : 1, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 7455, "_pub_column_name" : "RF_Aware_of_Referral", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "RF_Aware_of_Referral", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7343, "href" : "\/v1\/ads\/datafield\/7343", "column_name" : "RF_How_did_you_hear_about_us", "ord_num" : 7, "data_type_id" : 4, "char_length" : 80, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 1, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 6829, "_pub_column_name" : "RF_How_did_you_hear_about_us", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "RF_How_did_you_hear_about_us", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 21925, "href" : "\/v1\/ads\/datafield\/21925", "column_name" : "On_Hold_F2F", "ord_num" : 82, "data_type_id" : 8, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 1, "filter_on_col_sw" : 1, "default_value" : 0, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 21115, "_pub_column_name" : "On_Hold_F2F", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : 0, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "On_Hold_F2F", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7335, "href" : "\/v1\/ads\/datafield\/7335", "column_name" : "RF_Situation_Notes", "ord_num" : 8, "data_type_id" : 3, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 6821, "_pub_column_name" : "RF_Situation_Notes", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "RF_Situation_Notes", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7328, "href" : "\/v1\/ads\/datafield\/7328", "column_name" : "PD_Sex", "ord_num" : 20, "data_type_id" : 8, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : 1, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 6814, "_pub_column_name" : "PD_Sex", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : 1, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "PD_Sex", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "_pub_column_name" : "RR_Name_of_Other_Hospice", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "RR_Name_of_Other_Hospice", "_org_id" : 517090, "_resource_name" : "Patient Chart", "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 8710, "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 9206, "href" : "\/v1\/ads\/datafield\/9206", "column_name" : "RR_Name_of_Other_Hospice", "ord_num" : 16, "data_type_id" : 4, "char_length" : 80, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0 }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 9045, "href" : "\/v1\/ads\/datafield\/9045", "column_name" : "Show", "ord_num" : 27, "data_type_id" : 6, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : 1, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 8549, "_pub_column_name" : "Show", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : 1, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "Show", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "_published_data_column_id" : 10445, "_pub_column_name" : "CG_Primary_Caregiver_Relation", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "CG_Primary_Caregiver_Relation", "_org_id" : 517090, "_resource_name" : "Patient Chart", "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10969, "href" : "\/v1\/ads\/datafield\/10969", "column_name" : "CG_Primary_Caregiver_Relation", "ord_num" : 73, "data_type_id" : 4, "char_length" : 40, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0 }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 9018, "href" : "\/v1\/ads\/datafield\/9018", "column_name" : "RR_Visit_Location_Notes", "ord_num" : 12, "data_type_id" : 3, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 8522, "_pub_column_name" : "RR_Visit_Location_Notes", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "RR_Visit_Location_Notes", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10630, "href" : "\/v1\/ads\/datafield\/10630", "column_name" : "SF_Team", "ord_num" : 36, "data_type_id" : 4, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10099, "_pub_column_name" : "SF_Team", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "SF_Team", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 12021, "href" : "\/v1\/ads\/datafield\/12021", "column_name" : "Patient_Age_Alpha", "ord_num" : 76, "data_type_id" : 4, "char_length" : 3, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 11452, "_pub_column_name" : "Patient_Age_Alpha", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "Patient_Age_Alpha", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7341, "href" : "\/v1\/ads\/datafield\/7341", "column_name" : "RR_Registration_Rep_Date", "ord_num" : 11, "data_type_id" : 1, "_pub_column_name" : "RR_Registration_Rep_Date", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "RR_Registration_Rep_Date", "_org_id" : 517090, "_resource_name" : "Patient Chart", "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 6827, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0 }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 13344, "href" : "\/v1\/ads\/datafield\/13344", "column_name" : "AD_Admit_Date", "ord_num" : 30, "data_type_id" : 1, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 1, "filter_on_col_sw" : 1, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 12766, "_pub_column_name" : "AD_Admit_Date", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "AD_Admit_Date", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "_is_computed_sw" : 0, "_published_data_column_id" : 18511, "_pub_column_name" : "Chart_Billing_Status", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : 1, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "Chart_Billing_Status", "_org_id" : 517090, "_resource_name" : "Patient Chart", "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 19245, "href" : "\/v1\/ads\/datafield\/19245", "column_name" : "Chart_Billing_Status", "ord_num" : 78, "data_type_id" : 6, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 1, "filter_on_col_sw" : 1, "default_value" : 1, "_marked_for_deletion_sw" : 0 }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7319, "href" : "\/v1\/ads\/datafield\/7319", "column_name" : "RF_Assoc_to_Patient", "ord_num" : 4, "data_type_id" : 4, "char_length" : 40, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 6805, "_pub_column_name" : "RF_Assoc_to_Patient", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "RF_Assoc_to_Patient", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 19593, "href" : "\/v1\/ads\/datafield\/19593", "column_name" : "Send_Referral_Email", "ord_num" : 79, "data_type_id" : 8, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 1, "default_value" : 0, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 18846, "_pub_column_name" : "Send_Referral_Email", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : 0, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "Send_Referral_Email", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7826, "href" : "\/v1\/ads\/datafield\/7826", "column_name" : "RR_Registration_Rep_Id", "ord_num" : 10, "data_type_id" : 6, "char_length" : 50, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 7343, "_pub_column_name" : "RR_Registration_Rep_Id", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "RR_Registration_Rep_Id", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 11759, "href" : "\/v1\/ads\/datafield\/11759", "column_name" : "RR_Benefits_Assigned", "ord_num" : 75, "data_type_id" : 8, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : 1, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 11234, "_pub_column_name" : "RR_Benefits_Assigned", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : 1, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "RR_Benefits_Assigned", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 21924, "href" : "\/v1\/ads\/datafield\/21924", "column_name" : "On_Hold_Recert", "ord_num" : 81, "data_type_id" : 8, "char_length" : 50, "scale" : 0, "req_sw" : 0, "def_col_sw" : 1, "filter_on_col_sw" : 1, "default_value" : 0, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 21114, "_pub_column_name" : "On_Hold_Recert", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : 0, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "On_Hold_Recert", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "href" : "\/v1\/ads\/datafield\/10906", "column_name" : "Patient_DOB", "ord_num" : 68, "data_type_id" : 1, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 1, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10382, "_pub_column_name" : "Patient_DOB", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "Patient_DOB", "_org_id" : 517090, "_resource_name" : "Patient Chart", "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10906 }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10905, "href" : "\/v1\/ads\/datafield\/10905", "column_name" : "Patient_SSN", "ord_num" : 67, "data_type_id" : 4, "char_length" : 9, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 1, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10381, "_pub_column_name" : "Patient_SSN", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "Patient_SSN", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10770, "href" : "\/v1\/ads\/datafield\/10770", "column_name" : "GN_Followup_Notes", "ord_num" : 66, "data_type_id" : 3, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10247, "_pub_column_name" : "GN_Followup_Notes", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "GN_Followup_Notes", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 11509, "href" : "\/v1\/ads\/datafield\/11509", "column_name" : "Billing_Hold_and_Release", "ord_num" : 33, "data_type_id" : 6, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 1, "default_value" : 1, "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10985, "_pub_column_name" : "Billing_Hold_and_Release", "_pub_filter_on_col_sw" : 1, "_pub_default_value" : 1, "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "Billing_Hold_and_Release", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10647, "href" : "\/v1\/ads\/datafield\/10647", "column_name" : "Name", "ord_num" : 1, "data_type_id" : 4, "char_length" : 60, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10116, "_pub_column_name" : "Name", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "Name", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10768, "href" : "\/v1\/ads\/datafield\/10768", "column_name" : "AD_Pharmacy_fax", "ord_num" : 64, "data_type_id" : 4, "char_length" : 10, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10245, "_pub_column_name" : "AD_Pharmacy_fax", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "AD_Pharmacy_fax", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "_pub_is_computed_sw" : 0, "_old_column_name" : "AD_Pharmacy_phone", "_org_id" : 517090, "_resource_name" : "Patient Chart", "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10767, "href" : "\/v1\/ads\/datafield\/10767", "column_name" : "AD_Pharmacy_phone", "ord_num" : 63, "data_type_id" : 4, "char_length" : 10, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10244, "_pub_column_name" : "AD_Pharmacy_phone", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 0 }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10949, "href" : "\/v1\/ads\/datafield\/10949", "column_name" : "CG_Secondary_Caregiver_Address", "ord_num" : 72, "data_type_id" : 3, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 10424, "_pub_column_name" : "CG_Secondary_Caregiver_Address", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 0, "_pub_is_computed_sw" : 0, "_old_column_name" : "CG_Secondary_Caregiver_Address", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7267, "href" : "\/v1\/ads\/datafield\/7267", "column_name" : "PD_Marital_Status", "ord_num" : 21, "data_type_id" : 6, "char_length" : 20, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 6753, "_pub_column_name" : "PD_Marital_Status", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "PD_Marital_Status", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7270, "href" : "\/v1\/ads\/datafield\/7270", "column_name" : "PD_Religion", "ord_num" : 23, "data_type_id" : 4, "char_length" : 30, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 6756, "_pub_column_name" : "PD_Religion", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "PD_Religion", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 7269, "href" : "\/v1\/ads\/datafield\/7269", "column_name" : "PD_Ethnicity", "ord_num" : 22, "data_type_id" : 4, "char_length" : 25, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_deletion_sw" : 0, "_is_computed_sw" : 0, "_published_data_column_id" : 6755, "_pub_column_name" : "PD_Ethnicity", "_pub_filter_on_col_sw" : 0, "_pub_default_value" : "", "_properties_exist_sw" : 1, "_pub_is_computed_sw" : 0, "_old_column_name" : "PD_Ethnicity", "_org_id" : 517090, "_resource_name" : "Patient Chart" }, { "parent_type" : "resource", "parent_id" : 10617, "type" : "datafield", "id" : 10948, "href" : "\/v1\/ads\/datafield\/10948", "column_name" : "CG_Secondary_Caregiver_Phone", "ord_num" : 71, "data_type_id" : 4, "char_length" : 10, "scale" : 0, "req_sw" : 0, "def_col_sw" : 0, "filter_on_col_sw" : 0, "default_value" : "", "_marked_for_delet

Create datafield:

POST https:/.../v1/ads/resource/10617/datafield

Request data [See properties]:

{"datafield": [ { "parent_type" : "resource", "parent_id" : 10617, "property_a" : "value-a", "property" : "See datafield properties", "property_z" : "value-z" } ] }

Response codes:

Update datafield:

PUT https:/.../v1/ads/datafield/{id}

Request data [See properties]:

{"datafield": [ { "id" : 26070, "property_a" : "value-a", "property" : "See datafield properties", "property_z" : "value-z" } ] }

Response codes:

  • 400 - Client error
  • 500 - Server error
  • 200 - OK Content returned [See response data]
  • 204 - OK No content
  • 404 - Not found

Delete datafield:

DELETE https:/.../v1/ads/datafield/{id}

The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe

{"datafield": [{"id":26070}]}

Response codes:

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

Response data:
{}