方案管理

方案列表: /programs GET

请求参数

参数名	示列值	类型	必须	说明	默认值
page	1	number	否	当前页数	1
pageSize	10	number	否	每页条数	10
submitStatus	1	number	否	提交状态:(0:未提交,1:已提交)
name	方案名称	string	否	方案名称
sort	-submitAt	string	否	排序。多个排序字段用,号隔开。sort=-a,b
expand	'plans'	string	否	获取指定子资源数据: 'plans,dailySignSubject'
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数

参数名	示列值	说明
page	1	当前页数
pageSize	10	每页条数
limit	10	同 pageSize
offset	2	起始条数
total	3231	符合条件的总数量
items	[{},{}]	返回数据项(具体字段看方案信息)

items：方案信息

参数名	示列值	说明
id	1	id
name	demo	方案名称
organizationId	1	机构id(云医为0)
creatorId	1	创建人id
closeDay	3	自动关闭天数
submitStatus	1	提交状态:(0:未提交,1:已提交)
status	1	状态:(0:禁用,1:启用)
submitAt	1650160322	提交时间
createdAt	1650160322	创建时间
updatedAt	1650160322	更新时间
sendCount	4	扩展字段：方案下发次数
creator	{}	扩展字段：创建人信息(具体字段看创建人信息)
plans	[{},{}]	扩展字段：该方案每日计划列表(具体字段看计划信息)
dailySignSubject	{}	扩展字段：日签主题信息(具体字段看日签主题信息)
questionnaireAssessStatus	1	量表评估(0:关闭,1:开启)
questionnaireAssess	[[{},{}],[{},{}]]	量表评估数据(量表评估信息)

creator: 创建人信息

参数名	示列值	说明
id	1	id
name	张三	创建人名称

plan: 计划信息

参数名	示列值	说明
id	1	id
name	计划名称	计划名称
index	1	计划执行顺序
type	1	类型:(1:工作日-有任务,2:休息日-无任务)
lockStatus	1	锁定状态:(0:不锁定,1:锁定)
lockData	[{},{}]	锁定条件数据(锁定条件信息)
lockTaskData	[{},{}]	任务解锁条件(任务解锁条件)
tasks	[{},{}]	该日计划所有任务列表(具体字段看任务信息)

lockData: 锁定条件信息

参数名	示列值	说明
planId	1	计划id
taskIds	[1,2]	任务id数组

lockTaskData: 任务解锁条件

参数名	示列值	说明
keyTaskIndexs	[1,2,3]	解锁任务钥匙(1，2，3为task数据中的index字段)
lockTaskIndexs	[1,2,3]	被锁任务(1，2，3为task数据中的index字段)
keyTaskIds	[1,2,3]	解锁任务钥匙(1，2，3为task数据中的id字段)
lockTaskIds	[1,2,3]	解锁任务钥匙(1，2，3为task数据中的id字段)

task: 任务信息

参数名	示列值	说明
id	1	id
name	任务名称	任务名称
index	1	任务排序
resourceId	1	资源id：量表id/素材id/反馈任务id/功能id(1:填写睡眠记录2:填写服药记录,3:获取睡眠处方,4:心情日记,5:自动思维,6:日常活动记录,7:忧虑时间)
resourceType	media	资源类型: (audio:音频,video:视频,questionnaire:量表,feedback:反馈任务,commitment:承诺书,article:文章,operate:功能)
type	1	任务类型:(1:单日任务,2:必做任务,3:持续任务)
isStronger	1	任务是否加强:(0:否,1:是)
duration	7	持续天数

dailySignSubject: 日签主题信息

参数名	示列值	说明
id	1	id
name	日签主题名称	日签主题名称

questionnaireAssess: 量表评估信息

参数名	示列值	类型	说明
questionnaireId	1	number	量表id(传0代表无)
index	1	number	所属计划索引

返回示列

HTTP/1.1 200 OK
{
    "items": [
        {
            "id": 1,
            "name": "方案名称",
            "closeDay": 1,
            "submitStatus": 1,
            "status": 1,
            "submitAt": 1650160322,
            "createdAt": 1650160322,
            "updatedAt": 1650160322,
            "plans": [
                {
                    "id": 2,
                    "name": "计划名称",
                    "index": 1,
                    "createdAt": 1650160322,
                    "updatedAt": 1650160322,
                    "tasks": [
                        {
                            "id": 3,
                            "name": "任务名称",
                            "resourceId": 1,
                            "resourceType": "audio",
                            "type": 1,
                            "createdAt": 1650160322,
                            "updatedAt": 1650160322,
                        }
                    ],
                }
            ],
        },
    ],
}

所有方案: /listAll/programs GET

请求参数

参数名	示列值	类型	必须	说明
name	方案名称	string	否	方案名称
expand	'plans'	string	否	获取指定子资源数据: 'plans'
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回示列

HTTP/1.1 200 OK
[
  {
      "id": 1,
      "name": "方案1"
  }
]

方案详情: /programs/:id GET

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	id
expand	'plans'	string	否	获取指定子资源数据: 'plans,plans.tasks'
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 方案信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "方案名称",
  "closeDay": 1,
  "submitStatus": 1,
  "status": 1,
  "submitAt": 1650160322,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
  "plans": [
    {
        "id": 2,
        "name": "计划名称",
        "index": 1,
        "createdAt": 1650160322,
        "updatedAt": 1650160322,
        "tasks": [
            {
                "id": 3,
                "name": "任务名称",
                "resourceId": 1,
                "resourceType": "audio",
                "type": 1,
                "createdAt": 1650160322,
                "updatedAt": 1650160322,
        }
        ],
  }
  ],
}

新建方案: /programs POST

请求参数

参数名	示列值	类型	必须	说明	默认值
name	方案名称	string	是	方案名称
closeDay	3	number	是	自动关闭天数
submitStatus	1	number	是	提交状态:(0:未提交,1:已提交)
status	1	number	否	状态:(0:禁用,1:启用)	1
plans	[{},{}]	object[]	是	计划列表(计划信息)
dailySignStatus	1	number	否	关联日签主题(0:不关联,1:关联)	0
dailySignSubjectId	1	number	否	日签主题id
dailySignPictureIds	[1,2,3]	number[]	否	日签图片id(只传启用的图片)	[]
questionnaireAssessStatus	1	number	否	量表评估(0:关闭,1:开启)
questionnaireAssess	[[{},{}],[{},{}]]	array	否	量表评估数据(量表评估信息)

plan: 计划信息

参数名	示列值	类型	必须	说明	默认值
name	计划名称	string	否	计划名称
index	1	number	是	计划执行顺序
type	1	number	否	计划类型:(1:工作日-有任务,2:休息日-无任务)	1
lockStatus	1	number	否	锁定状态:(0:不锁定,1:锁定)	0
lockData	[{},{}]	object	否	锁定条件数据(锁定条件信息)	{}
lockTaskData	[{},{}]	object[]	否	任务解锁条件(任务解锁条件)
tasks	[{},{}]	object[]	是	任务列表(任务信息)

lockData: 锁定条件信息

参数名	示列值	类型	必须	说明	默认值
planindex	1	number	否	计划索引
taskIndexs	[]	number[]	否	任务索引数组

lockTaskData: 任务解锁条件

参数名	示列值	类型	必须	说明	默认值
keyTaskIndexs	[1,2,3]	number[]	否	解锁任务钥匙(1，2，3为task数据中的index字段)
lockTaskIndexs	[1,2,3]	number[]	否	被锁任务(1，2，3为task数据中的index字段)

task: 任务信息

参数名	示列值	类型	必须	说明	默认值
name	任务名称	string	是	任务名称
index	1	number	是	顺序
resourceId	1	number	否	资源 id：量表 id/素材 id/反馈任务 id/功能 id(1:填写睡眠记录 2:填写服药记录,3:获取睡眠处方,4:心情日记,5:自动思维(已废弃),6:日常活动记录,7:忧虑时间,8:abc记录表,9:...后续添加内容按顺序往下排)
resourceType	audio	string	是	资源类型: (audio:音频,video:视频,questionnaire:量表,feedback:反馈任务,commitment:承诺书,article:文章,operate:功能)
type	1	number	是	任务类型:(1:单日任务,2:必做任务,3:持续任务)	1
isStronger	1	number	否	任务类型:(0:否,1:是)	0
duration	7	number	否	持续任务时长	0

questionnaireAssess: 量表评估信息

参数名	示列值	类型	必须	说明	默认值
questionnaireId	1	number	是	量表id(传0代表无)	0
planIndex	1	number	是	所属计划索引

返回结果: 方案信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "方案名称",
  "closeDay": 1,
  "submitStatus": 1,
  "status": 1,
  "submitAt": 1650160322,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

编辑方案: /programs/:id PUT

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	id
name	方案名称	string	是	方案名称
closeDay	3	number	是	自动关闭天数
submitStatus	1	number	是	提交状态:(0:未提交,1:已提交)
status	1	number	否	状态:(0:禁用,1:启用)
plans	[{},{}]	Array	是	计划列表(计划信息)

返回结果: 方案信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "方案名称",
  "closeDay": 1,
  "submitStatus": 1,
  "status": 1,
  "submitAt": 1650160322,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

修改方案状态: /programs/:id/status PUT

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	方案 id
status	1	number	是	状态:(0:禁用,1:启用)

返回结果: 方案信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "方案名称",
  "closeDay": 1,
  "submitStatus": 1,
  "status": 1,
  "submitAt": 1650160322,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

名称是否重复: /isExist/programs GET

请求参数

参数名	示列值	类型	必须	说明
id	1	number	否	方案id
name	方案名称	string	是	方案名称

返回示列

HTTP/1.1 200 OK
{
  "isExist": true,
}

方案入库: librarySetting/programs POST

请求参数

参数名	示列值	类型	必须	说明
ids	[1]	array	Y	方案 id 数组
orgIds	[1,2]	array	Y	组织 id 数组
bulk	true	boolean		是否是批量入库(true:是)

返回示列

HTTP/1.1 200

方案记录列表: /programRecords GET

请求参数

参数名	示列值	类型	必须	说明	默认值
memberId	1	number	是	患者 id
page	1	number	否	当前页数	1
pageSize	10	number	否	每页条数	10
sort	-createdAt	number	否	排序。多个排序字段用,号隔开。sort=-a,b
expand	member	string	否	获取指定子资源数据: 'member,program,plans,planrecords,informedConsentMember,plans.attachTasks'
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数

参数名	示列值	说明
page	1	当前页数
pageSize	10	每页条数
limit	10	同 pageSize
offset	2	起始条数
total	3231	符合条件的总数量
items	[{}]	返回数据项(方案记录信息)
informedConsentMember	{}	患者签署知情同意书信息(患者签署知情同意书信息)

informedConsentMember: 患者签署知情同意书信息

参数名	示列值	说明
id	1	id
status	1	0=未签署，1=已签署
createdAt	1650160322	创建时间

programRecord: 方案记录信息

参数名	示列值	说明
id	1	id
programId	1	方案 id
status	1	状态:(1:进行中,2:已完成,3:已关闭)
startedAt	1650160322	方案开始(下发)时间
endedAt	1650160322	方案结束(完成)时间
member	{}	患者信息(患者信息)
program	1	方案信息(方案信息)
plans	[{},{}]	计划信息(计划信息)
planRecords	[{},{}]	计划记录信息(计划记录信息)

program: 方案信息

参数名	示列值	说明
id	1	id
creatorId	1	创建人 id
name	方案名称	方案名称
closeDay	1	自动关闭天数
submitStatus	1	提交状态:(0:未提交,1:已提交)
status	1	状态:(0:禁用,1:启用)
submitAt	1650160322	提交时间

plan: 计划信息

参数名	示列值	说明
id	1	id
programId	1	方案 id
name	计划名称	计划名称
index	1	计划排序
lockStatus	1	锁定状态:(0:不锁定,1:锁定)
lockData	[{},{}]	锁定条件数据(锁定条件信息)
taskLockData	[{},{}]	任务解锁条件(任务解锁条件)
tasks	[{},{}]	任务记录(任务信息)
taskRecords	[{},{}]	任务记录信息(任务记录信息)
attachTasks	[{},{}]	新增任务记录

lockData: 锁定条件信息

参数名	示列值	说明
planId	1	计划 id
taskIds	[1,2]	任务 id 数组

taskLockData: 任务解锁条件

参数名	示列值	说明
taskIndexKeys	[1,2,3]	解锁任务钥匙(1，2，3为task数据中的index字段)
taskIndexLocks	[1,2,3]	被锁任务(1，2，3为task数据中的index字段)
taskIdKeys	[1,2,3]	解锁任务钥匙(1，2，3为task数据中的id字段)
taskIdLocks	[1,2,3]	解锁任务钥匙(1，2，3为task数据中的id字段)

planRecord: 计划记录信息

参数名	示列值	说明
id	1	id
planId	1	计划 id
status	1	状态:(1:进行中,2:已完成,3:未完成,4:已延期)
lockStatus	1	锁定状态:(0:不锁定,1:锁定)
startedAt	1650160322	计划开始时间
endedAt	1650160322	计划结束时间
tasks	[{},{}]	任务记录(任务信息)
taskRecords	[{},{}]	任务记录信息(任务记录信息)

task: 任务信息

参数名	示列值	说明
id	1	id
planId	1	计划 id
programId	1	方案 id
name	任务名称	任务名称
index	1	任务排序
resourceId	1	资源 id:量表/素材/反馈任务
resourceType	media	资源类型: (audio:音频,video:视频,questionnaire:量表,feedback:反馈任务,commitment:承诺书,article:文章,operate:功能)
type	1	任务类型:(1:单日任务,2:必做任务,3:持续任务)
isStronger	1	任务是否加强:(0:否,1:是)
resource	{}	资源信息(素材或量表的详情信息)
taskRecord	{}	任务记录信息(任务记录信息)

taskRecord: 任务记录信息

参数名	示列值	说明
id	1	id
taskId	1	任务 id
resourceRecordId	1	资源记录 Id(量表测评记录 id/素材播放记录 id/睡眠记录 id/服药记录 id)
status	1	状态:(0:未完成,1:已完成)
startedAt	1650160322	任务开始时间
endedAt	1650160322	任务结束时间

attachTasks: 新增任务记录

参数名	示列值	说明
id	1	任务记录id
task	{"name": "xxx","type": 1, "isStronger": 0, "resourceId": "20", "resourceType": "article"}	任务信息

返回示列

HTTP/1.1 200 OK
{
    "items": [
        {
            "id": 1,
            "programId": 1,
            "status": 1,
            "startedAt": 1650160322,
            "endedAt": 1650160322,
            "planRecords": [
                {
                    "id": 2,
                    "status": 2,
                    "startedAt": 1650160322,
                    "endedAt": 1650160322,
                    "taskRecords": [
                        {
                            "id": 3,
                            "resourceRecordId": 1,
                            "status": 1,
                            "startedAt": 1650160322,
                            "endedAt": 1650160322,
                        }
                    ],
                }
            ],
          "plans": [
            {
              "id": 1,
              "attachTasks": [
                {
                  "id": 1,
                  "task": {
                    "name": "Node.js 多进程",
                    "type": 1,
                    "isStronger": 0,
                    "resourceId": "20",
                    "resourceType": "article"
                  }
                }
              ]
            }
          ]
        },
    ],
}

方案记录详情: /programRecords/:id GET

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	方案记录 id
expand	planRecords	string	否	获取指定子资源数据: 'program,planRecords, planRecords.taskRecords,plans.attachTasks'
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段

返回结果: 方案记录信息

返回示列

HTTP/1.1 200 OK
{
    "id": 1,
    "programId": 1,
    "status": 1,
    "startedAt": 1650160322,
    "endedAt": 1650160322,
    "planRecords": [
        {
            "id": 2,
            "planId": 2,
            "status": 2,
            "startedAt": 1650160322,
            "endedAt": 1650160322,
            "taskRecords": [
                {
                    "id": 3,
                    "taskId": 3,
                    "resourceRecordId": 1,
                    "status": 1,
                    "startedAt": 1650160322,
                    "endedAt": 1650160322,
                }
            ],
        "plans": [
            {
              "id": 1,
              "attachTasks": [
                {
                  "id": 1,
                  "task": {
                    "name": "Node.js 多进程",
                    "type": 1,
                    "isStronger": 0,
                    "resourceId": "20",
                    "resourceType": "article"
                  }
                }
              ]
            }
          ]
        }
    ],
}

所有持续任务: /programRecords/continueTask GET

请求参数

参数名	示列值	类型	必须	说明	默认值
programRecordId	1	number	是	方案记录id
planRecordStartedAt	1688636240	number	是	当天计划的开始时间

返回结果:

参数名	示列值	说明
tasks	[{}]	正常持续任务
attachTaskRecords	[{}]	新增持续任务

task: 任务信息

参数名	示列值	说明
id	1	id
name	任务名称	任务名称
index	1	任务排序
resourceId	1	资源id：量表id/素材id/反馈任务id
resourceType	audio	资源类型: (audio:音频,video:视频,questionnaire:量表,feedback:反馈任务,commitment:承诺书,article:文章,operate:功能)
type	1	任务类型:(1:单日任务,2:必做任务,3:持续任务)
duration	1	持续任务天数
taskRecord	{}	任务记录信息(任务记录信息)

taskRecords: 任务记录信息

参数名	示列值	说明
id	1	任务记录id
memberId	1	患者id
programRecordId	1	方案记录id
programId	1	方案id
planRecordId	1	计划记录id
planId	1	计划id
taskId	1	任务id(新增任务该字段为0)
resourceRecordId	1	资源记录Id(量表测评记录id/素材播放记录id/睡眠记录id/服药记录id/...)
status	1	状态:(0:未完成,1:已完成)
resourceRecordStatus	1	跳过任务的前提下，资源完成状态:(0:未完成,1:已完成)
type	1	任务记录类型:(1:正常任务记录,2:新增的任务记录)
isSkip	1	是否跳过:(0:否,1:是)
startedAt	1650160322	开始时间
endedAt	1650160322	结束时间
task	{}	任务信息(任务信息)

返回示列

HTTP/1.1 200 OK
{
  "tasks": [
    {
            "id": 3,
            "name": "任务名称",
            "resourceId": 1,
            "resourceType": "audio",
            "type": 1,
      "taskRecord": {
        "resourceRecordId": 1,
        "status": 1,
        "startedAt": 1650160322,
        "endedAt": 1650160322,
      }
        }
  ],
  "attachTaskRecords": [
    {
      "resourceRecordId": 1,
      "status": 1,
      "startedAt": 1650160322,
      "endedAt": 1650160322,
      "task": {
              "name": "任务名称",
              "resourceId": 1,
              "resourceType": "audio",
              "type": 1,
      },
    },
  ]
}