该文档演示了对数据元素(及其相关数据元素概念、值域)和表单的应用程序访问接口(API)使用示例。查询结果默认以json格式返回，为了更好的浏览查询结果，请您使用Google Chrome浏览器，并安装"JSONView-for-Chrome"插件，访问API接口。插件安装方法如下:
1) 下载插件到本地
2) 打开Chrome->更多工具->扩展程序->加载已解压的扩展程序->选择下载的文件夹

API查询项列表

1. Data Element Concept 查询

1) 请求连接：/data_element_concept_search?name={query string}
2) 可选参数：
  • name={query string} // 数据元素概念名称查询(可以是英文或中文形式)。
  • data_element_concept_id={'DC0009869'} // 数据元素概念ID查询。
  • data_element_concept_version={'1.0'} // 数据元素概念版本查询。
  • require_exact_match={true|false} // 是否精确匹配, default=false。
  • also_definition={true|false} // 是否从数据元素概念定义中查询, default=false。
  • format={json} // 数据返回格式, default=json。
  • page={integer} // 查询起始页, default=1。
  • pagesize={integer} // 每页返回记录数, default=50。

以下示例演示了如何对数据元素概念(Data Element Concept)进行查询。

1.1 Find Data Element Concept using ID

http://cdeapi.bmicc.cn/cdeapi/data_element_concept_search?data_element_concept_id=DC0000001

1.2 Find Data Element Concept using ID and Version

http://cdeapi.bmicc.cn/cdeapi/data_element_concept_search?data_element_concept_id=DC0000001&data_element_concept_version=1.0

1.3 Find Data Element Concept using name

http://cdeapi.bmicc.cn/cdeapi/data_element_concept_search?name=Patient Hospitalization

1.4 Find Data Element Concept using name and definition

http://cdeapi.bmicc.cn/cdeapi/data_element_concept_search?name=Patient Hospitalization&also_definition=true

1.5 Find Data Element Concept using name and require exact match

http://cdeapi.bmicc.cn/cdeapi/data_element_concept_search?name=Patient Hospitalization&require_exact_match=true

2. Value Domain 查询

1) 请求连接：/value_domain_search?name={query string}
2) 可选参数：
  • name={query string} // 值域名称查询(可以是英文或中文形式)。
  • value_domain_id={'VD0004331'} // 值域ID查询。
  • value_domain_version={'1.0'} // 值域版本查询。
  • require_exact_match={true|false} // 是否精确匹配, default=false。
  • also_definition={true|false} // 是否从值域定义中查询, default=false。
  • also_permissible_values={true|false} // 是否从值域许可值中查询, default=false。
  • value_domain_type={Enumerated|Non-Enumerated} // 值域类型, Enumerated:枚举, Non-Enumerated:非枚举。
  • format ={json} // 数据返回格式, default=json。
  • page={integer} // 查询起始页, default=1。
  • pagesize={integer} // 每页返回记录数, default=50。

以下示例演示了如何对值域(Value Domain)进行查询。

2.1 Find Value Domain using ID

http://cdeapi.bmicc.cn/cdeapi/value_domain_search?value_domain_id=VD0000001

2.2 Find Value Domain using ID and Version

http://cdeapi.bmicc.cn/cdeapi/value_domain_search?value_domain_id=VD0000001&value_domain_version=1.0

2.3 Find Value Domain using name

http://cdeapi.bmicc.cn/cdeapi/value_domain_search?name=Patient

2.4 Find Value Domain using name and definition

http://cdeapi.bmicc.cn/cdeapi/value_domain_search?name=Patient&also_definition=true

2.5 Find Value Domain using name、definition and value domain type

http://cdeapi.bmicc.cn/cdeapi/value_domain_search?name=Patient&also_definition=true&value_domain_type=Enumerated

2.6 Find Value Domain using name、definition and PermissibleValue

http://cdeapi.bmicc.cn/cdeapi/value_domain_search?name=Patient&also_definition=true&also_permissible_values=true

注：当指定also_permissible_values=true时，将同时从permissiblevalue、valuemeaning和meaningdescription中查询。

2.7 Find Value Domain using name、definition、PermissibleValue and require exact match

http://cdeapi.bmicc.cn/cdeapi/value_domain_search?name=Patient&also_definition=true&also_permissible_values=true&require_exact_match=true

3. Data Element 查询

1) 请求连接：/data_element_search?name={query string}
2) 可选参数：
  • name={query string} // 数据元素名称查询(可以是英文或中文形式)。
  • data_element_id={'DE0021543'} // 数据元素ID查询。
  • data_element_version={'1.0'} // 数据元素版本查询。
  • projects={peoject_id1,project_id2,project_id3} // 数据元素关联的项目ID查询, 如:PR0000003。
  • require_exact_match={true|false} // 是否精确匹配, default=false。
  • also_short_name={true|false} // 是否从数据元素短名中查询, default=false。
  • also_definition={true|false} // 是否从数据元素定义中查询, default=false。
  • also_questions={true|false} // 是否从数据元素关联的问题中查询, default=false。
  • also_permissible_values={true|false} // 是否从值域许可值中查询, default=false。
  • format={json} // 数据返回格式, default=json。
  • page={integer} // 查询起始页, default=1。
  • pagesize={integer} // 每页返回记录数, default=50。

以下示例演示了如何对数据元素(Data Element)进行查询。

3.1 Find Data Element using ID

http://cdeapi.bmicc.cn/cdeapi/data_element_search?data_element_id=DE0000001

3.2 Find Data Element using ID and Version

http://cdeapi.bmicc.cn/cdeapi/data_element_search?data_element_id=DE0000001&data_element_version=1.0

3.3 Find Data Element using name

http://cdeapi.bmicc.cn/cdeapi/data_element_search?name=Patient

3.4 Find Data Element using name and Projects

http://cdeapi.bmicc.cn/cdeapi/data_element_search?name=Patient&projects=PR0000001,PR0000002,PR0000003

3.5 Find Data Element using name and definition

http://cdeapi.bmicc.cn/cdeapi/data_element_search?name=Patient&also_definition=true

3.6 Find Data Element using name、definition and short name

http://cdeapi.bmicc.cn/cdeapi/data_element_search?name=Patient&also_definition=true&also_short_name=true

3.7 Find Data Element using name、definition and question

http://cdeapi.bmicc.cn/cdeapi/data_element_search?name=Patient&also_definition=true&also_questions=true

3.8 Find Data Element using name、definition、question and PermissibleValue

http://cdeapi.bmicc.cn/cdeapi/data_element_search?name=Patient&also_definition=true&also_questions=true&also_permissible_values=true

3.9 Find Data Element using name、definition、question 、PermissibleValue and require exact match

http://cdeapi.bmicc.cn/cdeapi/data_element_search?name=Patient&also_definition=true&also_questions=true&also_permissible_values=true&require_exact_match=true

注：当指定also_permissible_values=true时，将同时从permissiblevalue、valuemeaning和meaningdescription中查询


4. Form 查询

1) 请求连接：/form_search?name={query string}
2) 可选参数：
  • name={query string} //表单名称查询(可以是英文或中文形式)。
  • form_id={'FM0000002'} // 表单ID查询。
  • form_version={'1.0'} // 表单版本查询。
  • projects={peoject_id1,project_id2,project_id3} // 表单关联的项目ID查询, 如:PR0000003。
  • require_exact_match={true|false} // 是否精确匹配, default=false。
  • also_short_name={true|false} // 是否从表单短名中查询, default=false。
  • also_questions={true|false} // 是否从表单关联的问题中查询, default=false。
  • also_permissible_values={true|false} // 是否从值域许可值中查询, default=false。
  • format={json} // 数据返回格式, default=json。
  • page={integer} // 查询起始页, default=1。
  • pagesize={integer} // 每页返回记录数, default=50。

以下示例演示了如何对表单(Form)进行查询。

4.1 Find Form using ID

http://cdeapi.bmicc.cn/cdeapi/form_search?form_id=FM0000001

4.2 Find Form using ID and Version

http://cdeapi.bmicc.cn/cdeapi/form_search?form_id=FM0000001&form_version=1.0

4.3 Find Form using name

http://cdeapi.bmicc.cn/cdeapi/form_search?name=Patient

4.4 Find Form using name and Projects

http://cdeapi.bmicc.cn/cdeapi/form_search?name=Patient&projects=PR0000001,PR0000002,PR0000003

4.5 Find Form using name and definition

http://cdeapi.bmicc.cn/cdeapi/form_search?name=Patient&also_definition=true

4.6 Find Form using name、definition and short name

http://cdeapi.bmicc.cn/cdeapi/form_search?name=Patient&also_definition=true&also_short_name=true

4.7 Find Form using name、definition and question

http://cdeapi.bmicc.cn/cdeapi/form_search?name=Patient&also_definition=true&also_questions=true

4.8 Find Form using name、definition、question and PermissibleValue

http://cdeapi.bmicc.cn/cdeapi/form_search?name=Patient&also_definition=true&also_questions=true&also_permissible_values=true

注：当指定also_permissible_values=true时，将同时从permissiblevalue、valuemeaning和meaningdescription中查询

4.9 Find Form using name、definition、question、PermissibleValue and require exact match

http://cdeapi.bmicc.cn/cdeapi/form_search?name=Patient&also_definition=true&also_questions=true&also_permissible_values=true&require_exact_match=true