医院接入文档 - Powered by MinDoc

1、his创建订单接口

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

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

POST参数示例

{
    "changeDate": true,
    "companyId": 4400508,
    "examDate": "2020-03-17",
    "hidePrice": false,
    "idCard": "350724199012190551",
    "mealId": 484758,
    "mobile": "18675256375",
    "name": "fdd",
    "orderPrice": 700,
    "reduceItem": true,
    "hospitalAreaId":123
}

请求参数说明：

参数名	是否必须	类型	说明
accountId	否	int	Mt用户id
examinerId	否	int	体检人id
examDate	是	String	体检日期，格式：yyyy-MM-dd
examTimeIntervalId	否	Int	体检时间段id
mealId	是	int	平台套餐id
orderPrice	是	Int	订单价格，分
hisItemIds	否	list	单项id集合，传递该参数时，为下单选中的所有的单项id集合
companyId	是	Int	单位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	添加账户类型
managerId	否	int	客户经理id
customerId	否	int	用户id
gender	否	int	性别，0：男 1：女 2：未知
initialMobile	否	string	原始手机号
isStandardMobile	否	boolean	是否是标准手机号
email	否	string	邮箱
address	否	string	地址
age	否	int	年龄
birthYear	否	int	出生年，例子：1987
marriageStatus	否	int	婚姻状态，0:未婚，1：已婚
newCompanyId	否	int	体检单位id
companyName	否	string	体检单位名称
organizationId	否	int	机构id
organizationType	否	int	结构类型
healthNum	否	string	保健号
healthLevel	否	string	保健级别
socialSecurity	否	string	社保号
nationality	否	string	民族
needExamTime	否	boolean	是否需要体检时间
sendMessageAfterPay	否	boolean	发送短信（默认不发),true：发送，false：不发送
sendMessageAfterPay	否	boolean	发送短信（默认不发),true：发送，false：不发送
hisExamineeNum	否	string	内网体检号
cardNum	否	string	体检卡号
examing	否	bolean	是否到检
totalWorkingYear	否	int	总工龄-年 0开始
totalWorkingMonth	否	int	总工龄-月 0-11
touchYear	否	int	接毒接害工龄 -年 0开始
touchMonth	否	int	接毒接害工龄-月 0-11
hazardFactors	否	string	职业病危害因素-职检
examType	否	int	职检类别-职检 1 上岗 2 在岗 3 离岗
touchBeginTime	否	string	开始接触时间 eg : 2023-05-06
hospitalAreaId	否	int	线上院区id

正确返回示例:

{
    "data": {
        "accountId": 570654,
        "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

2、his撤销订单接口

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

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

POST参数示例

{"orderNum":"20200304164129044000208"}

请求参数说明：

参数名	是否必须	类型	说明
orderNum	是	string	平台订单号
needDeleteOrder	否	Boolean	是否需要删除平台订单：false 不删除 true 删除

正确返回示例:

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

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

3、his订单改期接口

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

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

POST参数示例

{
    "examTimeIntervalId": 1244,
    "newExamDate": "2020-03-22",
    "orderNum": "20200304163249285000190",
    "sendMessage":false,
    "hospitalAreaId":123
}

请求参数说明：

参数名	是否必须	类型	说明
orderNum	是	string	平台订单号
examTimeIntervalId	否	int	体检时段id(如果不传,取体检中心时段设置第一条)
newExamDate	是	String	新体检日期，格式：yyyy-MM-dd
sendMessage	否	boolean	是否发送改期成功短信: 默认true
hospitalAreaId	否	int	线上院区id

正确返回示例:

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

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

4、his订单改项接口

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

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

POST参数示例

{
    "hisItemIds": [
        "000009",
        "000012"
    ],
    "orderNum": "20200304121347892000190"
}

请求参数说明：

参数名	是否必须	类型	说明
orderNum	是	string	平台订单号
hisItemIds	是	List(String)	订单所有单项的内网编码集合

正确返回示例:

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

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

5、订单锁接口

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

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

POST参数示例

{
    "lockTime": 60,
    "orderNums": [
        "20200416162457101000480"
    ]
}

请求参数说明：

参数名	是否必须	类型	说明
lockTime	是	int	锁定时间，单位为：秒
orderNums	是	List(String)	需要锁定的订单集合

正确返回示例:

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

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

6、释放订单锁接口

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

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

POST参数示例

{
    "orderNums": [
        "20200416162457101000480"
    ]
}

请求参数说明：

参数名	是否必须	类型	说明
orderNums	是	List(String)	需要释放锁的订单集合

正确返回示例:

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

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

7、同步体检号

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

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

POST参数示例

{
    "orderNum": "20210219193922698000108",
    "examNum": "8000100"
}

请求参数说明：

参数名	是否必须	类型	说明
orderNum	是	string	订单号
examNum	是	string	体检编号

正确返回示例:

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

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

8、his订单算价接口

https://api.mytijian.com/open-api/V2/ws/order/hisOrderCalculatePrice?accessToken=ACCESS_TOKEN
请求协议：HTTPS
请求方式：POST
需要签名: 否
URL参数:

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

POST参数示例

{
  "mealId": 527428,
  "hisItemIds": [
    "000004","000098","000117"
  ],
  "orderNum": "20210813100010528000409"
}

请求参数说明：

参数名	是否必须	类型	说明
mealId	是	int	套餐id
hisItemIds	是	List(string)	套餐内，外项目的hisbm
orderNum	否	string	订单号

正确返回示例:

{
    "data": {
        "exportExamItemList": [
            {
                "salePrice": 1000,
                "hisId": "000004",
                "materialItem": false
            }
        ],
        "needToPayPrice": 1000
    },
    "msg": "success",
    "success": "T"
}

返回参数说明:

参数名	类型	说明
success	string	T成功，F失败
errCode	string	错误码，只有失败的时候才有
msg	string	描述消息

data数据结构

参数名	类型	说明
exportExamItemList	List(OrderExamItemSnapshotDto)	订单所有单项的集合
needToPayPrice	int	客户需要支付的价格，分

OrderExamItemSnapshotDto对象说明:

参数名	类型	说明
salePrice	int	销售价格，分
hisId	string	套餐内，外项目的hisbm
materialItem	boolean	是否为耗材:true 是耗材，false不是耗材

9.体检完成

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

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

POST参数示例

{"orderNum":"20200304164129044000208"}

请求参数说明：

参数名	是否必须	类型	说明
orderNum	是	string	平台订单号

正确返回示例:

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

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

文档更新时间: 2024-01-29 16:18

医院订单服务

1、his创建订单接口

POST参数示例

请求参数说明：

返回参数说明:

OrderCreateResponseDto对象说明

2、his撤销订单接口

POST参数示例

请求参数说明：

返回参数说明:

3、his订单改期接口

POST参数示例

请求参数说明：

返回参数说明:

4、his订单改项接口

POST参数示例

请求参数说明：

返回参数说明:

5、订单锁接口

POST参数示例

请求参数说明：

返回参数说明:

6、释放订单锁接口

POST参数示例

请求参数说明：

返回参数说明:

7、同步体检号

POST参数示例

请求参数说明：

返回参数说明:

8、his订单算价接口

POST参数示例

请求参数说明：

返回参数说明:

data数据结构

OrderExamItemSnapshotDto对象说明:

9.体检完成

POST参数示例

请求参数说明：

返回参数说明: