信达小程序
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

13 KiB

V2.6.0 接口文档 - 甲状腺眼病患者注册字段新增

1. 注册接口 account/reg

路由: ?r=zd/account/reg 方法: POST 需要登录: 是(systemUserId)

请求参数

参数名 类型 必填(version>=2.6.0) 说明
registrationSource int 注册来源
registChannel int 注册渠道
regBusinessId string 注册业务Id
inviteDoctorId int 邀约医生Id
inviteChannel int 邀约渠道
name string 姓名
relationType int 关系类型 1-本人 2-亲友
gender int 性别 1-男 2-女
ageRange int 年龄段 1-18以下 2-18-29 3-30-40 4-41-50 5-51-65 6-65以上
birth string 出生年月 YYYY-mm
diagnosisTime string 确诊时间 YYYY-mm
diagnoseType int 诊断类型
IsAliQiWei int 是否阿里企微 1-是 2-否
IsGraves int 是否Graves 1-是 2-否 3-不确定
HasTedSurgery int 是否TED手术 1-是 2-否 3-不确定
promotionMethodId int 推广方式Id
isKnowTituyo int 是否知道替妥尤
isUseTituyo int 是否使用替妥尤
diseaseStage int 是(version) 疾病分级 1-轻度 2-中重度 3-极重度
diseasePeriod int 是(version) 疾病分期 1-活动期 2-非活动期
tituyo array 替妥尤使用情况
prescriptionImg string 处方图片
FirstDiagnosisDate string 是(version>=2.6.0) 首次确诊甲状腺眼病的日期,格式 YYYY-MM-DD
IsRelapse int 是(version>=2.6.0) 当前是否为复发 1-复发 2-新发
CurrentTreatmentPlan int 是(version>=2.6.0) 正在进行的治疗方案 1-激素治疗(口服、冲击治疗、局部注射) 2-激素+替妥尤序贯治疗(不同时使用) 3-激素+替妥尤联合治疗(同时使用) 4-单用替妥尤(无激素/无免疫抑制剂) 5-托珠单抗 6-其他生物制剂 7-其他
PastTreatmentPlan string 是(version>=2.6.0) 既往治疗方案,逗号分隔多选 1-口服激素 2-静脉激素冲击 3-局部注射激素 4-放疗 5-替妥尤单抗 6-托珠单抗 7-其他生物制剂 8-眶减压术 9-无
TeprotumumabFirstInfusionDate string 替妥尤首次输注时间,格式 YYYY-MM-DD。仅在有新数据时更新,不会因治疗方案变化而清空
TeprotumumabInfusionCount int 替妥尤已输注次数(入组时) 1-8具体次数 9表示>8。仅在有新数据时更新,不会因治疗方案变化而清空

响应

{
  "code": 0,
  "message": "操作成功",
  "data": "操作成功"
}

业务规则

  • TeprotumumabFirstInfusionDate 和 TeprotumumabInfusionCount 如果有数据,仅通过接口更新数据,不会因为治疗方案选择了其他选项而删除
  • 当 CurrentTreatmentPlan 为2/3/4 或 PastTreatmentPlan 包含5时,应展开替妥尤输注相关问题(前端逻辑)
  • version>=2.6.0 时,FirstDiagnosisDate、IsRelapse、CurrentTreatmentPlan、PastTreatmentPlan 为必填

2. 常量定义接口 account/dict

路由: ?r=zd/account/dict 方法: GET 需要登录: 否

返回V2.6.0新增字段的枚举选项列表,供前端渲染下拉/多选控件使用。

请求参数

响应

{
  "code": 0,
  "message": "success",
  "data": {
    "IsRelapseList": [
      { "1": "复发", "2": "新发" }
    ],
    "CurrentTreatmentPlanList": [
      { "1": "激素治疗(口服、冲击治疗、局部注射)", "2": "激素+替妥尤序贯治疗(不同时使用)", "3": "激素+替妥尤联合治疗(同时使用)", "4": "单用替妥尤(无激素/无免疫抑制剂)", "5": "托珠单抗", "6": "其他生物制剂", "7": "其他" }
    ],
    "PastTreatmentPlanList": [
      { "1": "口服激素", "2": "静脉激素冲击", "3": "局部注射激素", "4": "放疗", "5": "替妥尤单抗", "6": "托珠单抗", "7": "其他生物制剂", "8": "眶减压术", "9": "无" }
    ],
    "TeprotumumabInfusionCountList": [
      { "1": "1", "2": "2", "3": "3", "4": "4", "5": "5", "6": "6", "7": "7", "8": "8", "9": ">8" }
    ]
  }
}

返回字段说明

字段名 类型 说明
IsRelapseList object 当前是否为复发选项,key为值,value为含义
CurrentTreatmentPlanList object 正在进行的治疗方案选项,key为值,value为含义
PastTreatmentPlanList object 既往治疗方案选项(多选),key为值,value为含义,传入时以逗号分隔的key值组合
TeprotumumabInfusionCountList object 替妥尤已输注次数选项,key为值,value为含义,9表示>8

3. 获取个人信息接口 account/info

路由: ?r=zd/account/info 方法: GET 需要登录: 是(systemUserId)

请求参数

无额外参数,通过登录态获取用户信息。

响应

{
  "code": 0,
  "message": "success",
  "data": {
    "UserId": "xxx",
    "PatientId": "xxx",
    "PatientName": "xxx",
    "AuditStatus": 3,
    "UserType": 3,
    "RelationType": 1,
    "UserImg": "xxx",
    "Telephone": "xxx",
    "EntryThreePeriod": 0,
    "MedicineAuditSwitch": "0",
    "has7DayAdl": 1,
    "isFollow": 1,
    "isShowFollowGuide": 2,
    "UserRegTime": "xxx",
    "AdlNotifySwitch": 1,
    "OpenTraining": 1,
    "IsRootUser": 1,
    "AgeYear": 30,
    "AgeMonth": 5,
    "Birth": "1995-05",
    "Gender": 1,
    "AgeRange": 3,
    "AntibodyType": 1,
    "ThyroidAbnormal": 1,
    "PreviousConvulsion": 2,
    "TraditionalImmunosuppressant": 1,
    "MedicalInsuranceType": 1,
    "DiagnosisTime": "2024-01",
    "DiagnoseType": 1,
    "DiagnoseImg": "xxx",
    "CommitTime": "xxx",
    "AuditStatus": 3,
    "RejectReason": "",
    "IsSick": 1,
    "PatientCanFollowUp": 1,
    "IsUseDrugs": 1,
    "IsKnowTituyo": 1,
    "IsUseTituyo": 2,
    "PrescriptionImg": "xxx",
    "DrugsAuditStatus": 3,
    "UseDrugsAuditStatus": 3,
    "UseDrugsAuditTime": "xxx",
    "UseDrugsRejectReason": "",
    "UseDrugsImg": "xxx",
    "UseDrugsCommitTime": "xxx",
    "JoinDays": 100,
    "IsGraves": 1,
    "HasTedSurgery": 2,
    "HasSelf": 1,
    "DiagnosisCertificate": "xxx",
    "InviteDoctorId": 1,
    "ExclusiveDoctorId": 1,
    "ExclusiveDoctorImg": "xxx",
    "ExclusiveDoctorName": "xxx",
    "ExclusiveDoctorHospitalId": 1,
    "ExclusiveDoctorHospitalName": "xxx",
    "ExclusiveDoctorHospitalClassification": 1,
    "ExclusiveDoctorHospitalClassificationName": "xxx",
    "ExclusiveDoctorHospitalLevel": 1,
    "ExclusiveDoctorHospitalLevelName": "xxx",
    "EntryTwoPeriod": 0,
    "EntryThreePeriod": 0,
    "DiseaseStage": 2,
    "DiseasePeriod": 1,
    "FirstDiagnosisDate": "2024-06-15",
    "IsRelapse": 1,
    "CurrentTreatmentPlan": 2,
    "PastTreatmentPlan": "1,2,5",
    "TeprotumumabFirstInfusionDate": "2025-03-20",
    "TeprotumumabInfusionCount": 4,
    "tituyo": [],
    "tituyoList": []
  }
}

V2.6.0 新增返回字段说明

字段名 类型 说明
FirstDiagnosisDate string 首次确诊甲状腺眼病的日期,格式 YYYY-MM-DD
IsRelapse int 当前是否为复发 1-复发 2-新发
CurrentTreatmentPlan int 正在进行的治疗方案 1-7
PastTreatmentPlan string 既往治疗方案,逗号分隔多选 1-9
TeprotumumabFirstInfusionDate string 替妥尤首次输注时间,格式 YYYY-MM-DD
TeprotumumabInfusionCount int 替妥尤已输注次数(入组时) 1-8具体次数 9表示>8

4. 患者列表接口 patient/list(后台)

路由: ?r=family/patient/list 方法: GET 需要登录: 是(后台管理端登录)

请求参数

参数名 类型 必填 说明
Search string 搜索关键词(患者姓名、医生姓名、PatientId、手机号)
UserType int 用户类型 1-空白 2-注册 3-疾病 4-用药
DiagnoseType int 诊断类型
BecomePatientTimeBegin string 成为患者时间开始
BecomePatientTimeEnd string 成为患者时间结束
UseDrugsJoinTimeBegin string 用药时间开始
UseDrugsJoinTimeEnd string 用药时间结束
LastUseDrugsTimeBegin string 最近一次用药时间开始
LastUseDrugsTimeEnd string 最近一次用药时间结束
RegistChannel int 注册渠道
RegionLTwoId int 大分区筛选
TelephoneRegionId int 电话大区筛选
HospitalRegionLTwoId int 邀约大区筛选
HospitalRegionLThreeId int 邀约地区筛选
Sort string 排序字段
SamePatient int 相同患者筛选
InsuranceSuccessTimeBegin string 商保审核成功时间开始
InsuranceSuccessTimeEnd string 商保审核成功时间结束
InviteChannel int 邀约渠道 1-医生码 2-QOL
InviteDoctorId int 邀约医生Id
IsOpenNrdlActivity int 是否打开NRDL活动
count int 每页条数,默认10
UseDrugsDate string 用药日期
beijingFlag int 北京标识
shanghaiFlag int 上海标识
guangzhouFlag int 广州标识
guangdongFlag int 广东标识
IsAliQiWei int 是否阿里企微 1-是 2-否
promotionMethodId int 推广方式Id
IsKnowTituyo int 是否知道替妥尤
IsUseTituyo int 是否使用替妥尤
IsRelapse int 当前是否为复发 1-复发 2-新发
CurrentTreatmentPlan int 正在进行的治疗方案 1-7

响应

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "PatientId": 1,
        "Name": "xxx",
        "UserId": "xxx",
        "Telephone": "xxx",
        "RelationType": 1,
        "PromotionMethodId": 1,
        "AgeYear": 30,
        "AgeMonth": 5,
        "Gender": 1,
        "Avatar": "xxx",
        "DiagnoseType": 1,
        "BecomePatientTime": "xxx",
        "DiagnoseImg": "xxx",
        "UseDrugsJoinTime": "xxx",
        "ConversionDays": 10,
        "AdlNums": 5,
        "IsSick": 1,
        "IsUseDrugs": 1,
        "IsAliQiWei": 2,
        "LastAdlId": 1,
        "UseDrugsNum": 3,
        "LastUseDrugsTime": "xxx",
        "IsGraves": 1,
        "HasTedSurgery": 2,
        "IsKnowTituyo": 1,
        "IsUseTituyo": 2,
        "DiseaseStage": 2,
        "DiseasePeriod": 1,
        "FirstDiagnosisDate": "2024-06-15",
        "IsRelapse": 1,
        "CurrentTreatmentPlan": 2,
        "PastTreatmentPlan": "1,2,5",
        "TeprotumumabFirstInfusionDate": "2025-03-20",
        "TeprotumumabInfusionCount": 4,
        "IsRelapseName": "复发",
        "CurrentTreatmentPlanName": "激素+替妥尤序贯治疗(不同时使用)",
        "PastTreatmentPlanName": "口服激素,静脉激素冲击,替妥尤单抗",
        "TeprotumumabInfusionCountName": "4",
        "...": "其他字段"
      }
    ],
    "pages": { "totalCount": 100, "pageCount": 10, "currentPage": 1, "perPage": 10 },
    "count": 100,
    "page": 1,
    "AllPatient": 100,
    "NanPatient": 50,
    "NvPatient": 50,
    "SickPatient": 80,
    "UseDrugsPatient": 20
  }
}

V2.6.0 新增筛选条件说明

参数名 类型 说明
IsRelapse int 筛选当前是否为复发 1-复发 2-新发
CurrentTreatmentPlan int 簿选正在进行的治疗方案 1-7

V2.6.0 新增返回字段说明

字段名 类型 说明
FirstDiagnosisDate string 首次确诊甲状腺眼病的日期 YYYY-MM-DD
IsRelapse int 当前是否为复发 1-复发 2-新发
IsRelapseName string 当前是否为复发的文本,如"复发"/"新发"
CurrentTreatmentPlan int 正在进行的治疗方案 1-7
CurrentTreatmentPlanName string 正在进行的治疗方案的文本
PastTreatmentPlan string 既往治疗方案,逗号分隔多选 1-9
PastTreatmentPlanName string 既往治疗方案的文本,逗号分隔,如"口服激素,静脉激素冲击,替妥尤单抗"
TeprotumumabFirstInfusionDate string 替妥尤首次输注时间 YYYY-MM-DD
TeprotumumabInfusionCount int 替妥尤已输注次数(入组时) 1-8具体次数 9表示>8
TeprotumumabInfusionCountName string 替妥尤已输注次数的文本,9时显示">8"

附录:常量值域对照表

IsRelapse - 当前是否为复发

含义
1 复发
2 新发

CurrentTreatmentPlan - 正在进行的治疗方案

含义
1 激素治疗(口服、冲击治疗、局部注射)
2 激素+替妥尤序贯治疗(不同时使用)
3 激素+替妥尤联合治疗(同时使用)
4 单用替妥尤(无激素/无免疫抑制剂)
5 托珠单抗
6 其他生物制剂
7 其他

PastTreatmentPlan - 既往治疗方案(多选,逗号分隔存储)

含义
1 口服激素
2 静脉激素冲击
3 局部注射激素
4 放疗
5 替妥尤单抗
6 托珠单抗
7 其他生物制剂
8 眶减压术
9

TeprotumumabInfusionCount - 替妥尤已输注次数(入组时)

含义
1-8 具体输注次数
9 >8次