4.1 ⽂件异步签署

请求参数

Authorization

Query 参数

access_token

string

应用token

必需

示例值:

4f538337-5088-4c30-8bac-bd2a0f56c4fc

Header 参数

X-Signit-App-Id

string

必需

应用分配的应用ID，需要联系签名系统厂商获取该ID

示例值:

1730975c5e7a62a2d7d93b07ae1

Body 参数application/json

bedNumber

string

床位号

必需

门诊患者传null 住院患者传具体的床位号

document

object

文档

必需

base64

string

文档Base64编码

必需

patientID

string

患者就诊卡号

必需

patientName

string

患者名称

必需

patientAge

string

患者年龄

必需

患者年龄:没有值传null

patientSex

integer

患者性别

必需

患者性别：没有值传null（0表示男， 1表示⼥ 2 表示不确定）

admissionNumber

string

住院号

必需

患者住院号：门诊患者或者没有住院号就传null

idCard

string

患者身份证号码

必需

template

object

模板信息

必需

name

string

模板名称

必需

联系签名系统实施索取

wsid

string

模板ID

必需

联系签名系统实施索取

hospitalDepartment

object

科室信息

必需

departmentName

string

科室名称

必需

departmentID

string

科室ID

必需

doctorName

string

医生姓名

必需

医生姓名

doctorID

string

医生工号

必需

可以传医生身份证号值

customTagID

string

业务自定义ID

必需

业务自定义ID，业务方可通过本ID区分数据

inHospitalUserSignerInfomation

array [object {5}]

院内用户签名

可选

医技护人员签名

signerKeyName

string

签名处名称

必需

签名处名称，传签名元素名称

signerUserJobId

string

签名医生ID

必需

支持多人签名，可以使用分隔符；将多人工号传递比如：0078;0079
注：可以传医生身份证号值

signerUserSequence

string

签名医生顺序

必需

支持多人签名，可以使用分隔符；将多人工号传递比如：1;1

appendContent

string

附加内容

可选

支持在签名图片后追加指定的内容

disableAutoSign

boolean

禁用自动签名

可选

禁用当前用户执行自动签名，签署人类型 = DOCTOR 医护签名时有效
默认：false

outHospitalUserSignerInfomation

array [object {3}]

院外用户签名

可选

患者、家属签名

signerKeyName

string

签名处名称

必需

签名处名称，传签名元素名称

signerUserPhone

string

签名人手机号

必需

支持多人签名，可以使用分隔符；将多人工号传递比如：15881684559;15881684558

signerUserSequence

string

签名人顺序

必需

支持多人签名，可以使用分隔符；将多人工号传递比如：1;1

extraParam

string

扩展参数

可选

调用方可在此属性中传递自定义的扩展参数。在签署完成后的回调中会原样返回

示例

{
  "bedNumber": "A12",
  "document": {
    "base64": "此处省略，请替换为PDF文件的base64编码"
  },
  "patientID": "A01229668",
  "patientName": "吴涛",
  "patientAge": 45,
  "patientSex": 0,
  "admissionNumber": "8669202103059699",
  "idCard": "510922197505107954",
  "template": {
    "name": "pet-ct",
    "wsid": "WSID_TEMP_00000182f7c73045eef0436393b80001"
  },
  "hospitalDepartment": {
    "departmentName": "骨科",
    "departmentID": "0095"
  },
  "doctorName": "吴涛",
  "doctorID": "job_wutao",
  "customTagID": "PET-CT-20240122-02",
  "inHospitalUserSignerInfomation": [
    {
      "signerKeyName": "报告医生",
      "signerUserJobId": "job_wutao",
      "signerUserSequence": "1"
    },
    {
      "signerKeyName": "审核医生",
      "signerUserJobId": "job_wutao",
      "signerUserSequence": "1"
    }
  ],
  "outHospitalUserSignerInfomation": []
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://m1.apifoxmock.com/m1/4604434-0-default/v1/open/hospital/hospitals/templates/apply?access_token=4f538337-5088-4c30-8bac-bd2a0f56c4fc&access_token=' \
--header 'X-Signit-App-Id: 1730975c5e7a62a2d7d93b07ae1' \
--header 'X-Signit-App-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bedNumber": "A12", 
    "document": {
        "base64": "此处省略，请替换为PDF文件的base64编码"
    }, 
    "patientID": "A01229668", 
    "patientName": "吴涛", 
    "patientAge": 45, 
    "patientSex": 0, 
    "admissionNumber": "8669202103059699", 
    "idCard": "510922197505107954", 
    "template": {
        "name": "pet-ct",
        "wsid": "WSID_TEMP_00000182f7c73045eef0436393b80001"
    }, 
    "hospitalDepartment": {
        "departmentName": "骨科", 
        "departmentID": "0095"
    }, 
    "doctorName": "吴涛", 
    "doctorID": "job_wutao", 
    "customTagID": "PET-CT-20240122-02", 
    "inHospitalUserSignerInfomation": [
        {
            "signerKeyName": "报告医生", 
            "signerUserJobId": "job_wutao", 
            "signerUserSequence": "1"
        },
         {
            "signerKeyName": "审核医生", 
            "signerUserJobId": "job_wutao", 
            "signerUserSequence": "1"
        }
    ],
     "outHospitalUserSignerInfomation": [
       
    ]
}'

返回响应

🟢200成功

application/json

Body

code

string

必需

接⼝响应状态码；100870000=成功，其他=失败

message

string

接⼝响应消息

必需

invokeNumber

string

本次请求唯⼀标识

必需

envelopeWsid

string

必需

本次发起的签署流程唯⼀标识

customTag

string

必需

调⽤⽅⾃定义唯⼀编号

userMessage

string

错误消息

可选

developerMessage

string

错误消息

可选

signatureQrCodeInfos

array [object {5}]

签署二维码信息

可选

需要医生或患者手动扫码签署时，才会返回签署二维码
eg：如果医生都开启了静默签署，则不会返回医生的签署二维码

id

string

签署任务id

必需

此id需要保存，并且使用id调用接口查询签名结果

type

string

签署类型

必需

hospital_user_signature = 院内（医护）签署二维码
patient_signature = 患者签署二维码

from

string

签署任务来源

必需

envelope = 文件签
data = 数据签

qrCodeRaw

string

二维码原始内容

必需

qrCodeImage

string

base64编码格式的二维码图片

必需

示例

成功示例异常示例成功示例（带签署链接）

{
  "code": "100870000",
  "message": "操作成功",
  "invokeNumber": "202406031700412485001672407001",
  "envelopeWsid": "WSID_ENVE_0000018fdd5450a00242b3e463710001",
  "customTag": "EMRL20240603170039"
}

🟠400参数不正确