就诊人相关接口
此页面包含了就诊人相关的接口,包括就诊人查询,就诊人添加,就诊人详情,就诊人删除,就诊人设置默认
就诊人列表查询
该接口与就诊人管理页面中的就诊人信息相同,但修改了返回参数,取消了无用的参数,新增详情接口,从详情接口中获取更多信息
接口信息
- 接口名称: 就诊人列表查询
- 请求方式:
POST - 请求地址:
/patient-list - 接口描述: 根据当前openid查询用户已创建的就诊人列表
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| openid | string | 当前用户的openid | "1" |
请求示例
json
{ "openid":"1"}返回参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| name | string | 就诊人姓名 | "张三" |
| sex | string | 就诊人性别 | "男" |
| age | string | 就诊人年龄 | "30" |
| cardNumber | string | 就诊人卡号 | "1234567890" |
| default | string | 是否默认就诊人 | "true" |
| patientId | string | 就诊人ID | "1" |
| phone | string | 就诊人手机号 | "13800000000" |
返回示例
json
{
"errcode":0,
"msg":"",
"rcursor":[
{
"name": "张三",
"sex": "男",
"age": "30",
"cardNumber": "1234567890",
"default": "true",
"patientId": "1",
"phone": "13800000000"
},
{
"name": "李四",
"sex": "女",
"age": "25",
"cardNumber": "0987654321",
"default": "false",
"patientId": "2",
"phone": "13900000000"
}
]
}就诊人详情
接口信息
- 接口名称: 就诊人详情
- 请求方式:
POST - 请求地址:
/patient-detail - 接口描述: 根据就诊人ID查询就诊人详情
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| patientId | string | 就诊人ID | "1" |
请求示例
json
{ "patientId":"1"}返回参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| name | string | 就诊人姓名 | "张三" |
| sex | string | 就诊人性别 | "男" |
| age | string | 就诊人年龄 | "30" |
| state | string | 就诊卡状态 | "正常" |
| isDefault | boolean | 是否默认就诊人 | true |
| cardType | string | 证件类型 | "身份证" |
| cardNumber | string | 证件号码 | "123456789012345678" |
| relationship | string | 与患者的关系 | "本人" |
| ethnicity | string | 就诊人民族 | "汉族" |
| address | string | 地址 | "中国 北京市 海淀区" |
| addressDetails | string | 详细地址 | "中国 北京市 海淀区 100000" |
| phone | string | 就诊人手机号 | "13800000000" |
返回示例
json
{
"errcode":0,
"msg":"",
"rcursor":[
{
"name": "张三",
"sex": "男",
"age": "30",
"isDefault": true,
"cardType": "身份证",
"cardNumber": "123456789012345678",
"relationship": "本人",
"ethnicity": "汉族",
"address": "中国 北京市 海淀区",
"addressDetails": "中国 北京市 海淀区 100000",
"phone": "13800000000"
}
]
}就诊人添加
接口信息
- 接口名称: 就诊人添加
- 请求方式:
POST - 请求地址:
/patient-add - 接口描述: 根据当前openid添加就诊人
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| openid | string | 当前用户的openid | "1" |
| name | string | 就诊人姓名 | "张三" |
| sex | string | 就诊人性别 | "男" |
| age | string | 就诊人年龄 | "30" |
| state | string | 就诊卡状态 | "正常" |
| isDefault | boolean | 是否默认就诊人 | true |
| cardType | string | 证件类型 | "身份证" |
| cardNumber | string | 证件号码 | "123456789012345678" |
| relationship | string | 与患者的关系 | "本人" |
| ethnicity | string | 就诊人民族 | "汉族" |
| address | string | 地址 | "中国 北京市 海淀区" |
| addressDetails | string | 详细地址 | "中国 北京市 海淀区 100000" |
| phone | string | 就诊人手机号 | "13800000000" |
请求示例
json
{
"openid":"1",
"name": "张三",
"sex": "男",
"age": "30",
"state": "正常",
"isDefault": true,
"cardType": "身份证",
"cardNumber": "123456789012345678",
"relationship": "本人",
"ethnicity": "汉族",
"address": "中国 北京市 海淀区",
"addressDetails": "中国 北京市 海淀区 100000",
"phone": "13800000000"
}返回参数
标准返回参数
返回示例
json
{
"errcode":0,
"msg":"",
}就诊人信息修改
接口信息
- 接口名称: 就诊人信息修改
- 请求方式:
POST - 请求地址:
/patient-update - 接口描述: 根据就诊人ID修改就诊人信息
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| patientId | string | 就诊人ID | "1" |
| name | string | 就诊人姓名 | "张三" |
| sex | string | 就诊人性别 | "男" |
| age | string | 就诊人年龄 | "30" |
| state | string | 就诊卡状态 | "正常" |
| isDefault | boolean | 是否默认就诊人 | true |
| cardType | string | 证件类型 | "身份证" |
| cardNumber | string | 证件号码 | "123456789012345678" |
| relationship | string | 与患者的关系 | "本人" |
| ethnicity | string | 就诊人民族 | "汉族" |
| address | string | 地址 | "中国 北京市 海淀区" |
| addressDetails | string | 详细地址 | "中国 北京市 海淀区 100000" |
| phone | string | 就诊人手机号 | "13800000000" |
请求示例
json
{
"patientId":"1",
"name": "张三",
"sex": "男",
"age": "30",
"state": "正常",
"isDefault": true,
"cardType": "身份证",
"cardNumber": "123456789012345678",
"relationship": "本人",
"ethnicity": "汉族",
"address": "中国 北京市 海淀区",
"addressDetails": "中国 北京市 海淀区 100000",
"phone": "13800000000"
}返回参数
标准返回参数
返回示例
json
{
"errcode":0,
"msg":"",
}就诊人信息解绑
接口信息
- 接口名称: 就诊人信息解绑
- 请求方式:
POST - 请求地址:
/patient-unbind - 接口描述: 根据就诊人ID删除掉该就诊人信息
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| patientId | string | 就诊人ID | "1" |
请求示例
json
{
"patientId":"1",
}返回参数
标准返回参数
返回示例
json
{
"errcode":0,
"msg":"",
}就诊卡默认设置
接口信息
- 接口名称: 就诊卡默认设置
- 请求方式:
POST - 请求地址:
/patient-default - 接口描述: 根据就诊人ID将该就诊人设置默认就诊人,后续中间页面会默认显示默认就诊人
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| patientId | string | 就诊人ID | "1" |
请求示例
json
{
"patientId":"1",
}返回参数
标准返回参数
返回示例
json
{
"errcode":0,
"msg":"",
}