健康档案报告管理模块 - Apifox 接口文档

📋 接口概览

模块名称： 健康档案报告管理
基础路径： /health-archive-report
描述： 提供健康档案报告的生成、查询、下载、管理等功能
版本： v1.0.0

🔗 接口列表

1. 分页查询健康档案报告

接口信息

接口名称： 分页查询健康档案报告

接口路径： POST /health-archive-report/page

请求方式： POST

接口描述： 根据条件分页查询健康档案报告列表

请求参数

Headers:

Content-Type: application/json

Body (application/json):

{
  "pageNumber": 0,
  "pageSize": 10,
  "searchCondition": {
    "elderId": 1001,
    "elderNameLike": "张",
    "reportStartTime": "2025-01-01",
    "reportEndTime": "2025-01-07",
    "status": 1,
    "createAtStart": "2025-01-01T00:00:00",
    "createAtEnd": "2025-01-31T23:59:59"
  }
}

请求参数说明

参数名	类型	必填	描述	示例值
pageNumber	Integer	是	页码，从0开始	0
pageSize	Integer	是	每页大小	10
searchCondition	Object	否	查询条件	-
└─ elderId	Long	否	长者ID	1001
└─ elderNameLike	String	否	长者姓名模糊查询	"张"
└─ reportStartTime	String	否	报告开始时间	"2025-01-01"
└─ reportEndTime	String	否	报告结束时间	"2025-01-07"
└─ status	Integer	否	状态：0-生成中，1-已生成，2-生成失败	1
└─ createAtStart	String	否	创建时间开始	"2025-01-01T00:00:00"
└─ createAtEnd	String	否	创建时间结束	"2025-01-31T23:59:59"

响应示例

{
  "records": [
    {
      "id": 1001,
      "elderId": 1001,
      "elderName": "张三",
      "reportStartTime": "2025-01-01",
      "reportEndTime": "2025-01-07",
      "status": 1,
      "statusDesc": "已生成",
      "reportFilePath": "/reports/zhang_san_20250101_20250107.pdf",
      "reportFileName": "张三_2025-01-01至2025-01-07.pdf",
      "errorMessage": null,
      "createAt": "2025-01-15T10:30:00",
      "reportTimeDesc": "2025-01-01至2025-01-07"
    }
  ],
  "total": 1
}

2. 获取健康档案报告详情

接口信息

接口名称： 获取健康档案报告详情

接口路径： GET /health-archive-report/{id}

请求方式： GET

接口描述： 根据ID获取健康档案报告详细信息

请求参数

参数名	类型	位置	必填	描述	示例值
id	Long	path	是	报告ID	1001

响应示例

{
  "code": "200",
  "message": "操作成功",
  "data": {
    "id": 1001,
    "elderId": 1001,
    "elderName": "张三",
    "reportStartTime": "2025-01-01",
    "reportEndTime": "2025-01-07",
    "status": 1,
    "statusDesc": "已生成",
    "reportFilePath": "/reports/zhang_san_20250101_20250107.pdf",
    "reportFileName": "张三_2025-01-01至2025-01-07.pdf",
    "errorMessage": null,
    "createAt": "2025-01-15T10:30:00",
    "reportTimeDesc": "2025-01-01至2025-01-07"
  }
}

3. 生成健康档案报告

接口信息

接口名称： 生成健康档案报告

接口路径： POST /health-archive-report/generate

请求方式： POST

接口描述： 为指定长者生成健康档案报告

请求参数

Headers:

Content-Type: application/json

Body (application/json):

{
  "elderIds": [1001, 1002, 1003],
  "reportStartTime": "2025-01-01",
  "reportEndTime": "2025-01-07"
}

请求参数说明

参数名	类型	必填	描述	示例值
elderIds	Array[Long]	是	长者ID列表	[1001, 1002, 1003]
reportStartTime	String	是	报告开始时间	"2025-01-01"
reportEndTime	String	是	报告结束时间	"2025-01-07"

响应示例

成功：

{
  "code": "200",
  "message": "报告生成任务已提交，请稍后查看结果",
  "data": null
}

失败（重复生成）：

{
  "code": "400",
  "message": "张三 该时间阶段长者报告生成中，请勿重复操作",
  "data": null
}

4. 重新生成报告

接口信息

接口名称： 重新生成报告

接口路径： POST /health-archive-report/regenerate/{id}

请求方式： POST

接口描述： 重新生成生成失败的报告

请求参数

参数名	类型	位置	必填	描述	示例值
id	Long	path	是	报告ID	1001

响应示例

成功：

{
  "code": "200",
  "message": "报告重新生成任务已提交",
  "data": null
}

失败（状态不符）：

{
  "code": "400",
  "message": "只能重新生成失败的报告",
  "data": null
}

5. 删除失败的报告

接口信息

接口名称： 删除失败的报告

接口路径： DELETE /health-archive-report/delete-failed

请求方式： DELETE

接口描述： 删除生成失败的报告记录

请求参数

Headers:

Content-Type: application/json

Body (application/json):

{
  "ids": [1001, 1002, 1003]
}

请求参数说明

参数名	类型	必填	描述	示例值
ids	Array[Long]	是	要删除的报告ID列表	[1001, 1002, 1003]

响应示例

{
  "code": "200",
  "message": "删除成功",
  "data": null
}

6. 下载单个报告

接口信息

接口名称： 下载单个报告

接口路径： GET /health-archive-report/download/{id}

请求方式： GET

接口描述： 下载指定ID的健康档案报告文件

请求参数

参数名	类型	位置	必填	描述	示例值
id	Long	path	是	报告ID	1001

响应说明

成功时： 返回文件流，浏览器会提示下载文件

Content-Type： application/octet-stream

Content-Disposition： attachment; filename="张三_2025-01-01至2025-01-07.pdf"

错误响应

{
  "code": "400",
  "message": "报告未生成完成",
  "data": null
}

7. 批量下载报告

接口信息

接口名称： 批量下载报告

接口路径： POST /health-archive-report/batch-download

请求方式： POST

接口描述： 批量下载多个健康档案报告，打包成ZIP文件

请求参数

Headers:

Content-Type: application/json

Body (application/json):

{
  "reportIds": [1001, 1002, 1003]
}

请求参数说明

参数名	类型	必填	描述	示例值
reportIds	Array[Long]	是	要下载的报告ID列表	[1001, 1002, 1003]

响应说明

成功时： 返回ZIP文件流

Content-Type： application/zip

Content-Disposition： attachment; filename="健康档案报告_2025-01-15.zip"

说明： 只会打包状态为"已生成"的报告，自动过滤其他状态

8. 查看报告

接口信息

接口名称： 查看报告

接口路径： GET /health-archive-report/view/{id}

请求方式： GET

接口描述： 查看报告内容或状态信息

请求参数

参数名	类型	位置	必填	描述	示例值
id	Long	path	是	报告ID	1001

响应示例

生成中：

{
  "code": "200",
  "message": "报告正在生成中，请稍后...",
  "data": "generating"
}

已生成：

{
  "code": "200",
  "message": "报告已生成",
  "data": "/reports/zhang_san_20250101_20250107.pdf"
}

生成失败：

{
  "code": "400",
  "message": "报告生成失败：文件生成过程中发生错误",
  "data": null
}

📊 数据模型

HealthArchiveReportVo（健康档案报告VO）

字段名	类型	描述	示例值
id	Long	主键ID	1001
elderId	Long	长者ID	1001
elderName	String	长者姓名	"张三"
reportStartTime	String	报告开始时间	"2025-01-01"
reportEndTime	String	报告结束时间	"2025-01-07"
status	Integer	状态：0-生成中，1-已生成，2-生成失败	1
statusDesc	String	状态描述	"已生成"
reportFilePath	String	报告文件路径	"/reports/zhang_san_20250101_20250107.pdf"
reportFileName	String	报告文件名称	"张三_2025-01-01至2025-01-07.pdf"
errorMessage	String	生成失败错误信息	null
createAt	String	创建时间	"2025-01-15T10:30:00"
reportTimeDesc	String	报告时间范围描述	"2025-01-01至2025-01-07"

PageContent（分页内容）

字段名	类型	描述	示例值
records	Array	数据列表	[...]
total	Long	总记录数	100

StandardR（统一返回格式）

字段名	类型	描述	示例值
code	String	结果码，200表示成功	"200"
message	String	返回信息	"操作成功"
data	Object	返回数据	{...}

🔄 状态说明

报告状态枚举

状态值	状态名称	说明	可执行操作
0	生成中	报告正在异步生成中	查看报告
1	已生成	报告生成成功，可下载	下载报告、查看报告
2	生成失败	报告生成过程中发生错误	重新生成报告、删除

⚠️ 业务规则

生成报告规则

时间验证： 报告结束时间不能早于当前日期

时间逻辑： 开始时间不能晚于结束时间

重复检查： 同一长者同一时间段只能有一个生成中的报告

批量支持： 支持批量选择多个长者生成报告

操作权限规则

重新生成： 只有状态为"生成失败"的报告才能重新生成

删除： 只有状态为"生成失败"的报告才能被删除

下载： 只有状态为"已生成"的报告才能下载

文件命名规则

单个报告： 长者姓名_时间范围.pdf

批量下载： 健康档案报告_当前日期.zip

🚨 错误码说明

错误码	错误信息	说明
400	请选择长者	elderIds为空
400	请选择报告开始时间	reportStartTime为空
400	请选择报告结束时间	reportEndTime为空
400	报告结束时间不能早于当天	时间验证失败
400	开始时间不能晚于结束时间	时间逻辑错误
400	该时间阶段长者报告生成中，请勿重复操作	重复生成检查
400	只能重新生成失败的报告	状态验证失败
400	只能删除生成失败的报告	状态验证失败
400	报告未生成完成	下载时状态检查
404	报告不存在	报告ID不存在

📝 使用示例

1. 查询报告列表

2. 生成报告

3. 下载报告

📞 技术支持

如有接口使用问题，请联系开发团队或查看详细的技术文档。

版本历史：

v1.0.0：初始版本，包含基础的CRUD和文件管理功能

健康档案报告管理模块 - Apifox 接口文档

📋 接口概览#

🔗 接口列表#

1. 分页查询健康档案报告#

2. 获取健康档案报告详情#

3. 生成健康档案报告#

4. 重新生成报告#

5. 删除失败的报告#

6. 下载单个报告#

7. 批量下载报告#

8. 查看报告#

📊 数据模型#

HealthArchiveReportVo（健康档案报告VO）#

PageContent（分页内容）#

StandardR（统一返回格式）#

🔄 状态说明#

报告状态枚举#

⚠️ 业务规则#

生成报告规则#

操作权限规则#

文件命名规则#

🚨 错误码说明#

📝 使用示例#

1. 查询报告列表#

2. 生成报告#

3. 下载报告#

📞 技术支持#

📋 接口概览

🔗 接口列表

1. 分页查询健康档案报告

2. 获取健康档案报告详情

3. 生成健康档案报告

4. 重新生成报告

5. 删除失败的报告

6. 下载单个报告

7. 批量下载报告

8. 查看报告

📊 数据模型

HealthArchiveReportVo（健康档案报告VO）

PageContent（分页内容）

StandardR（统一返回格式）

🔄 状态说明

报告状态枚举

⚠️ 业务规则

生成报告规则

操作权限规则

文件命名规则

🚨 错误码说明

📝 使用示例

1. 查询报告列表

2. 生成报告

3. 下载报告

📞 技术支持