接口文档 / 患者接口

创建患者

该接口实际为创建或更新患者。

在同一连锁（chainId）内，CRM 按以下顺序匹配已有患者：
1. 姓名 + 手机号：mobile 非空。
2. 姓名 + 身份证号：idCard 非空，不区分 idCardType。

命中任一唯一键时更新已有患者，全部未命中时才新建。重复提交相同唯一键不会重复创建，而是更新并返回已有患者。

POST/api/v2/open-agency/patient在线调试

请求参数

名称	说明	类型
Body 参数
`name`必填	姓名	`string`
`mobile`可选	手机号	`string`
`sex`必填	性别[男,女] 示例：`男`	`string`
`birthday`必填	生日示例：`2010-01-15`	`string`
`sourceId`可选	患者来源分类id 示例：`医生推荐分类id, 导医推荐分类id, 顾客推荐分类id`	`string`
`sourceFromId`可选	患者来源分类下某个具体来源id。比如：当就诊来源分类为【医生推荐】时，根据api【5.2.2. 获取医生分页列表信息】获取到医生，此时字段取值为医生id；当就诊来源分类为【导医推荐】时, 根据api【5.1.3. 获取门店成员列表】获取到成员，此时字段取值为成员id；当就诊来源分类为【顾客推荐】时, 根据api【5.4.3. 获取患者列表】获取到患者，此时字段取值为患者id；	`string`
`idCard`可选	身份证	`string`
`pastHistory`可选	既往史	`string`
`address`可选	家庭住址	`object`
`sn`可选	档案号	`string`
`remark`可选	备注	`string`
`profession`可选	职业	`string`
`company`可选	公司单位	`string`
`marital`可选	婚姻状态	`string`
`weight`可选	体重	`string`

请求示例

json

{
  "name": "string",
  "mobile": "string",
  "sex": "男",
  "birthday": "2010-01-15",
  "sourceId": "医生推荐分类id, 导医推荐分类id, 顾客推荐分类id",
  "sourceFromId": "string",
  "idCard": "string",
  "pastHistory": "string",
  "address": {
    "addressProvinceId": 510000,
    "addressProvinceName": "四川",
    "addressCityId": 510100,
    "addressCityName": "成都市",
    "addressDistrictId": 510109,
    "addressDistrictName": "高新区",
    "addressDetail": "交子大道180号"
  },
  "sn": "string",
  "remark": "string",
  "profession": "string",
  "company": "string",
  "marital": "string",
  "weight": "string"
}

响应参数

名称	说明	类型
Body 参数
`data`可选	数据	`object`
`id`必填	患者ID:唯一标识示例：`000000fc446f4dbd989857e305b00d6s`	`string`
`name`必填	姓名示例：`张三`	`string`
`mobile`可选	手机号示例：`18080000000`	`string`
`sex`可选	性别示例：`男`	`string`
`birthday`可选	出生日期示例：`1970-08-14`	`string`
`age`可选	患者年龄大小示例：`60岁2月1天`	`object`
`idCard`可选	证件号示例：`630101200010075800`	`string`
`idCardType`可选	证件类型示例：`身份证`	`string`
`visitReason`可选	到店原因	`string`
`error`可选可为空	通用业务错误包装	`object`

响应示例

json

{
  "data": {
    "id": "000000fc446f4dbd989857e305b00d6s",
    "name": "张三",
    "mobile": 18080000000,
    "sex": "男",
    "birthday": "1970-08-14",
    "age": "60岁2月1天",
    "idCard": 630101200010075800,
    "idCardType": "身份证",
    "visitReason": "string"
  },
  "error": null
}

业务失败包装示意

json

{
  "data": null,
  "error": {
    "code": 11003,
    "message": "不支持的授权类型{grantType}"
  }
}

查看 HTTP 状态与业务码排查