医院接入文档 - Powered by MinDoc

平台推送信息给内网

需要天瑞提供接口给前置机调用

线上新增或修改订单同步内网

正确请求天瑞数据:


        {
            "onlinePayMoney":0,
            "dynamicAttributes":{
                "birthDay":"1990-12-11",
                "gender":0,
                "hasInvoice":"0",
                "marriageStatus":"",
                "batchId":"4150660",
                "operatorName":"运维测试",
                "examPeriod":"7:00-8:00",
                "retireStatus":"",
                "healthLevel":"",
                "hospitalId":197,
                "position":"",
                "myMealId":447168,
                "age":28
            },
            "needPaperReport":true,
            "orderMoney":39,
            "examDate":1530547200000,
            "hisCompId":"000374",
            "orderId":4402379,
            "examItemExportDto":[
                {
                    "originalPrice":300,
                    "hisId":"000007",
                    "price":100,
                    "typeToMeal":1
                },
                {
                    "originalPrice":700,
                    "hisId":"000012",
                    "price":100,
                    "typeToMeal":1
                }
            ],
            "orderNum":"20180703141944364002053",
            "remark":"{"remarks":"","timeRemarks":""}",
            "examCompany":"个人改",
            "accountCompanyExportDto":{
                "owner":"运维测试2",
                "name":"个人改"
            },
            "examinerExportDto":{
                "addAccountType":"idCard",
                "idCard":"360681199012115715",
                "name":"黄伟",
                "department":"",
                "group":"分组1"
            },
            "companyId":1585,
            "offlinePayMoney":39,
            "exportDiscount":"0.3",
            "payType":"现金",
            "retire":"",
            "hisCompName":"个人",
            "mealName":"基础套餐",
            "vip":"否",
            "operator": "qatest",
            "operatorId": 206499,
            "hisExamineeNum": "Csa-num" ,
            "hisGroupCode":"2323",
            "examStartPeriod":"7:00",
            "examEndPeriod":"9:00",
            "examItemPayInfoSnapshotDtoList":[
            {
            "examItemId":,
            "payInfoSnapshotDtoList":[
            {
            "payType":,
            "payAmount":,
            "payTypeName":
            }
            ]
            }
            ]//如果医院开了线上拆单的配置,   订单中每个项目就会有examItemPayInfoSnapshotDtoList 这个信息. 
        }

返回参数说明:

参数名	类型	说明
	OrderExportDto

OrderExportDto返回参数说明:

参数名	类型	说明
orderId	int	订单id
orderNum	String	订单号
examDate	Date	体检日期
examStartPeriod	string	时段开始时间
examEndPeriod	string	时段结束时间
payType	String	支付类型
mealName	String	套餐名称
orderMoney	double	订单金额
vip	String	VIP
onlinePayMoney	double	线上支付金额
offlinePayMoney	double	线下支付金额
companyId	int	每天健康库单位id
examCompany	int	每天健康库单位名称
hisCompId	String	his系统单位编码
hisCompName	String	his系统单位名称
needPaperReport	boolean	是否需要纸质报告
exportDiscount	String	导出折扣
remark	String	备注信息
retire	String	在职状态
operator	String	下单人名称
operatorId	Integer	下单人id
hisExamineeNum	String	体检号,内网备单的才会有订单号
hisGroupCode	String	内网分组号,内网备单的才会有分组号
examinerExportDto	ExaminerExportDto	体检人信息
accountCompanyExportDto	AccountCompanyExportDto	挂账单位信息
examItemExportDto	List(ExamItemExportDto)	添加项集合
dynamicAttributes	Map（String, Object）	动态属性
examItemPayInfoSnapshotDtoList	List	如果医院开了线上拆单的配置, 订单中每个项目就会有examItemPayInfoSnapshotDtoList 这个信息.

ExaminerExportDto对象说明:

参数名	类型	说明
name	String	体检人姓名
addAccountType	String	添加账户类型（idCard:按身份证导入,employeeNo:按员工号导入,passport:按护照添加,officeCert:按军官证添加,hmCard:按港澳身份证添加,other:其他方式导入）
idCard	String	体检人身份证号
mobile	String	体检人手机号码
department	String	体检人所属部门
healthNum	String	保健号
healthLevel	String	保健级别
employeeId	String	员工号
group	String	所在组
marriageStatus	int	婚姻状况(0:未婚，1：已婚)
address	String	体检人住址

AccountCompanyExportDto对象说明:

参数名	类型	说明
name	String	挂账单位
owner	String	介绍人

ExamItemExportDto对象说明:

参数名	类型	说明
hisId	String	医院项目ID
originalPrice	int	项目原价
price	int	项目折后价
typeToMeal	int	该项目针对套餐的关系 1：套餐内项目 2：套餐内删除项 3：新增项
multiChooseId	String	多选一组id 只有是多选一单项，才会有这个值
mergeItemParentId	int	合并项父id 只有是多选一单项，并且是合并项还有这个值
payInfoSnapshotDtoList	List	单项支付信息快照

dynamicAttributes动态属性说明:

参数名	类型	说明
myMealId	String	mytijian套餐id
examPeriod	String	体检时间段
batchId	String	订单批次
hasInvoice	String	是否需要发票
hospitalId	String	体检中心id
operatorName	String	预约人姓名
gender	String	性别
age	String	年龄
birthDay	String	出生日期
position	String	职级
retireStatus	String	退休状态
healthLevel	String	保健级别
marriageStatus	String	婚姻状态
adjustPrice	String	调整价格
idcardImage	String	身份证照片
address	String	体检人地址
managerLoginId	String	客户经理登陆ID
tradePayRecord	String	交易支付记录
tradeMethod	String	交易方式
outOrderId	String	三方交易单号
payAmount	String	支付金额
mealClassify	String	套餐分类
socialSecurity	String	社保号
cardHolderInfo	String	卡持有人信息前缀
customerRank	String	vip客户级别
nationality	String	民族信息
cardSupportMulti	String	是否是多次卡
cardBalance	String	卡余额
cardInitialAmount	String	卡初始金额
orderCreateTime	String	订单创建时间
busiType	String	单位业务类型
examCode	String
isMotherCard	String	该卡类型是否为母卡
postCode	String	邮编
addPackageNames	String	加项包名称集合

PayInfoSnapshotDto & ExamItemPayInfoSnapshotDto 对象属性说明:

参数名	类型	说明
payType	Integer	支付类型
payAmount	long	支付金额
payTypeName	String	支付方式名称

ExamItemPayInfoSnapshotDto多一个examItemId—->平台单项id

返回参数


{
            "operator":"auto",
            "hospitalId":197,
            "orderNum":"20180703141944364002053",
            "errorCode":1,
            "errorText":"导入成功",
            "hisExamineeNum":"体检号"
        }

返回参数字段说明

参数名	是否必须	类型	说明
operator	是	String	操作员，默认使用 “auto”
hospitalId	否	Integer	医院ID, 找每天的人要hospitalId
orderNum	是	String	订单号
errorCode	是	Integer	结果码，1 表示成功
errorText	是	String	结果说明
hisExamineeNum	否	string	内网体检号

线上订单撤销同步内网

请求天瑞数据

{"orderNums":['12222','3344556']}

通知参数说明:

参数名	类型	说明
orderNums	array	需要撤销的订单号集合

返回参数


[{
            "operator":"auto",
            "orderNum":"20180703141944364002053",
            "hospitalId":197,
            "errorCode":1,
            "errorText":"撤销成功"
        },{
            "operator":"auto",
            "orderNum":"20180703141944364002053",
                "hospitalId":197,
            "errorCode":20,
            "errorText":"内网xx原因导致撤销失败"
        }]

返回参数字段说明

参数名	是否必须	类型	说明
operator	是	String	操作员，默认使用 “auto”
hospitalId	否	Integer	医院ID, 找每天的人要hospitalId
orderNum	是	String	订单号
errorCode	是	Integer	结果码，1 表示成功，其他code表示导出失败
errorText	是	String	结果说明

内网同步信息到线上

同步分组

https://api.mytijian.com/open-api/V2/ws/group/syncCreateOrUpdateGroupV2?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN

该接口同上，只是返回结果增加了参数
https://api.mytijian.com/open-api/V2/ws/group/syncCreateOrUpdateGroupV4?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN
请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken
nonce	是	string	当前有效的nonce
sign	是	string	数据sign值

POST参数示例

{
    "hisGroupCode": 10625777,
    "hisGroupName": "adddffffff-FM",
    "hisCompanyCode": "2323",
    "capacity": 10000,
    "expiredDate": "2022-03-02 23:59:59",
    "hisMealParam": {
        "ageLevelId": 0,
        "ageLevelValue": "全年龄段（不限年龄）",
        "allowChangeItem": true,
        "classify": 1,
        "discount": 1,
        "gender": 0,
        "lockPrice": true,
        "marriageId": 0,
        "marriageValue": "通用",
        "mealItemList": [
            {
                "hisItemId": "000012",
                "basic":true
            }
        ],
        "price": 700,
        "type": 3,
        "vip_level": "vip",
        "vip_strategy": "order_price"
    }
}

请求参数说明：

参数名	是否必须	类型	说明
hisGroupCode	是	string	内网分组编码
hisGroupName	是	string	内网分组名称
hisCompanyCode	是	string	内网单位批次编码
capacity	是	int	分组限额
expiredDate	是	string	过期时间
hisMealParam	是	object	套餐信息

hisMealParam 对象说明

参数名	是否必须	类型	说明
price	是	int	套餐价格
gender	是	int	性别，套餐在平台的性别0-男，1-女，2-不详
disable	否	int	套餐状态,0:正常,1，不可用，2:删除默认是0
type	是	int	套餐类型，1:单位套餐
allowChangeItem	是	boolean	允许改项
marriageId	是	int	婚姻状态id 0 通用 1 已婚
marriageValue	是	string	婚姻状态值
ageLevelId	是	int	0, “全年龄段（不限年龄）”, 1, “少年儿童（12岁及以下）”, 2, “青少年（12岁-20岁）”3,”青年（21岁-30岁）”4,”中青年（21岁-40岁）”5,”中年（31岁-50岁）”6,”中老年（41岁-60岁）”7,”老年（61岁及以上）”
ageLevelValue	是	string	年龄段值
classify	是	int	套餐分类套餐分类 1：健康体检、2：入职体检、3：公务员体检、4：驾驶员体检、5：专项体检、6：教师资格证体检、7：入学体检、8：贵宾体检、9：齿科体检
lockPrice	是	boolean	锁定价格
modifyTip	否	string	修改提示
mealWarnText	否	string	套餐警告文本
vip_strategy	是	string	vip策略 “order_price”,” meal”
vip_level	是	string	vip级别当策略为“order_price” vip级别只有vip。当策略级别为” meal” 级别参数如下“vip”,” honor_vip”,
enableSiteShow	否	boolean	站点能否展示
onlyShowMealItem	否	boolean	是否只显示套餐内项目
mealItemList	是	List(HisExamItemParam)	套餐内项目

mealItemList 对象说明

参数名	是否必须	类型	说明
hisItemId	是	string	单项his编码
basic	否	boolean	单项是否必选：true必选、false 非比选

syncCreateOrUpdateGroupV4接口返回对象说明

参数名	是否必须	类型	说明
mealId	是	Integer	套餐id
invalidMaterials	否	List(Material)	无效的耗材，传参的套餐项为耗材
countMaterials	否	List(Material)	套餐内单项关联的耗材

Material对象说明

参数名	是否必须	类型	说明
hisItemId	是	string	耗材编码
name	是	string	耗材名称
count	否	Integer	耗材的数量

同步团检订单

https://api.mytijian.com/open-api/V2/ws/order/hisCreateOrderV2?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN
请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken
nonce	是	string	当前有效的nonce
sign	是	string	数据sign值

POST参数示例

{
    "changeDate": true,
    "examDate": "2022-05-20",
    "hidePrice": false,
    "idCard": "350724199012190551",
    "mobile": "18675256375",
    "name": "fdd",
    "hisItemIds": [
        "rctj034",
        "0009"
    ],
    "orderPrice": 8000,
    "reduceItem": true,
    "hisExamineeNum": "122233",
    "sendMessageAfterPay": false,
    "companyExamParam": {
        "hisGroupCode": "10623333qa7",
        "beginDate": "2022-5-1",
        "endDate": "2023-5-1",
        "capacity": 1000,
        "hisCompanyCode": "001491"
    }
}

请求参数说明：

参数名	是否必须	类型	说明
examDate	否	String	体检日期，格式：yyyy-MM-dd
examTimeIntervalId	否	Int	体检时间段id
orderPrice	是	Int	订单价格，用于校验内网订单价格与平台计算的价格是否一致，单位：分
hisItemIds	否	list	单项id集合，传递该参数时，为下单选中的所有的单项id集合
reduceItem	否	boolean	允许减项
changeDate	否	boolean	可改期
hidePrice	否	boolean	隐藏价格
name	是	string	姓名
idCard	是	string	身份证
mobile	是	string	手机号
department	否	string	部门
employeeId	否	string	员工号
position	否	string	职级
isRetire	否	int	退休， 0:未退休 1:退休
sequence	否	int	排序
operator	否	string	操作员
addAccountType	否	string	添加账户类型
gender	是	int	性别，0：男 1：女 2：未知
initialMobile	否	string	原始手机号
isStandardMobile	否	boolean	是否是标准手机号
email	否	string	邮箱
address	否	string	地址
age	是	int	年龄
birthYear	否	int	出生年，例子：1987
marriageStatus	否	int	婚姻状态，0:未婚，1：已婚
healthNum	否	string	保健号
healthLevel	否	string	保健级别
socialSecurity	否	string	社保号
nationality	否	string	民族
sendMessageAfterPay	否	boolean	发送短信（默认不发),true：发送，false：不发送
hisExamineeNum	是	string	内网体检号
companyExamParam	是	object	团检信息

companyExamParam 对象说明

参数名	是否必须	类型	说明
hisGroupCode	是	string	内网套分组编码
beginDate	是	string	团检开始时间
endDate	是	string	团检结束时间
capacity	是	int	个人限额单位：分
hisCompanyCode	是	string	单位内网编码

正确返回示例:

{
    "data": {
        "orderNum": "20200303115514629000290",
        "examinerId": 541899
    },
    "msg": "success",
    "success": "T"
}

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息
data	OrderCreateResponseDto	创建订单返回对象

OrderCreateResponseDto对象说明

参数名	是否必须	类型	说明
accountId	是	int	平台主账户id
orderNum	是	string	平台订单号
examinerId	是	int	平台体检人id

修改个人限额

请求URL
https://api.mytijian.com/open-api/V2/ws/card/modify?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN

请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken
nonce	是	string	当前有效的nonce
sign	是	string	数据sign值

POST参数示例

{
    "hisExamineeNum": "adddffffff-FM",
    "cardCapacity": 1000
}

参数名	是否必须	类型	说明
hisExamineeNum	是	string	内网体检号
cardCapacity	否	int	新的余额

正确返回示例:

{
    "data": {
    },
    "msg": "success",
    "success": "T"
}

文档更新时间: 2023-09-13 16:44

接口文档

平台推送信息给内网

线上新增或修改订单同步内网

返回参数说明:

OrderExportDto返回参数说明:

ExaminerExportDto对象说明:

AccountCompanyExportDto对象说明:

ExamItemExportDto对象说明:

dynamicAttributes动态属性说明:

PayInfoSnapshotDto & ExamItemPayInfoSnapshotDto 对象属性说明:

返回参数字段说明

线上订单撤销同步内网

通知参数说明:

返回参数字段说明

内网同步信息到线上

同步分组

POST参数示例

请求参数说明：

hisMealParam 对象说明

mealItemList 对象说明

syncCreateOrUpdateGroupV4接口 返回对象说明

Material对象说明

同步团检订单

POST参数示例

请求参数说明：

companyExamParam 对象说明

返回参数说明:

OrderCreateResponseDto对象说明

修改个人限额

POST参数示例

syncCreateOrUpdateGroupV4接口返回对象说明