患者建档

POST

/api/anon/openapi/patient

最后修改时间：2022-09-06 13:54:16

责任人：孙工

注意：该接口受了解途径&客户渠道权限控制

请求参数

Header 参数

FRHis-Open-Timestamp

string

必需

示例值:

{% mock 'timestamp' %}

FRHis-Open-App-Id

string

必需

示例值:

FRHis-Open-Token

string

必需

示例值:

Body 参数application/json

telephone

string

手机号

必需

relation

string

联系电话类型

可选

0 = 本人电话
1 = 联系人电话、亲友电话。

name

string

姓名

必需

certificateType

string

证件类型编号

必需

01-居民身份证
02-中国护照
14-港澳护照或通行证
15-台湾居民来往大陆通行证
16-外籍护照
99-其他有效身份证件

certificateNumber

string

证件号码

必需

与证件编号组合验证，不为空则校验证件类型。
二者可都不录入，或者二者都录入。

cardNumber

string

会员卡号

可选

1.不可与系统编码规则相似
2.建档优先判断是否有值，有值则优先使用
3.为空时则依照系统参数，建档时是否生成卡号判断是否自动生成

gender

integer

性别

必需

1：男 2：女

age

integer

年龄

可选

birthday

string

生日

可选

dateOfBirth

string

出生日期公历

可选

格式yyyy-MM-dd

dateOfBirthLunar

string

出生日期农历

可选

格式yyyy-MM-dd

address

string

地址

可选

outptNumber

string

门诊号

可选

请注意：该字段接口不会做重复性校验

createrId

integer

创建人

必需

consultantsId

integer

咨询人员ID

可选

developId

integer

开发人员ID

可选

customerServiceId

integer

客服人员ID

可选

knowWay

string

字典[了解途径]名称

可选

字典编号：ZDLJTJ

channelType

string

字典[渠道类型]编号

可选

字典编号：ZDQDLX
与开发渠道ID关联验证，不可一个传值一个不传值。

developChannel

integer

开发渠道ID

可选

通过【同步开发渠道】接口获取

introduceType

integer

介绍人类型

可选

0：其他，1：内部员工介绍，2：院内客户介绍（客带客）

introducerId

integer

介绍人ID

可选

introduceType=1>>>传员工ID
introduceType=2>>>传客户ID
;不为空则校验介绍人类型和介绍人姓名

introducerName

string

介绍人姓名

可选

remark

string

备注

可选

customFieldsValueList

array[object (自定义字段值) {2}] | null

自定义字段值

可选

患者档案自定义字段值

zdm

string

字段名

必需

自定义字段名

zdz

string

字段值

必需

自定义字段值

示例

{
    "telephone": "string",
    "relation": "string",
    "name": "string",
    "certificateType": "string",
    "certificateNumber": "string",
    "cardNumber": "string",
    "gender": 0,
    "age": 0,
    "birthday": "string",
    "dateOfBirth": "string",
    "dateOfBirthLunar": "string",
    "address": "string",
    "outptNumber": "string",
    "createrId": 0,
    "consultantsId": 0,
    "developId": 0,
    "customerServiceId": 0,
    "knowWay": "string",
    "channelType": "string",
    "developChannel": 0,
    "introduceType": 0,
    "introducerId": 0,
    "introducerName": "string",
    "remark": "string",
    "customFieldsValueList": [
        {
            "zdm": "string",
            "zdz": "string"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/anon/openapi/patient' \
--header 'FRHis-Open-Timestamp: {% mock '\''timestamp'\'' %}' \
--header 'FRHis-Open-App-Id: {{appid}}' \
--header 'FRHis-Open-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "telephone": "string",
    "relation": "string",
    "name": "string",
    "certificateType": "string",
    "certificateNumber": "string",
    "cardNumber": "string",
    "gender": 0,
    "age": 0,
    "birthday": "string",
    "dateOfBirth": "string",
    "dateOfBirthLunar": "string",
    "address": "string",
    "outptNumber": "string",
    "createrId": 0,
    "consultantsId": 0,
    "developId": 0,
    "customerServiceId": 0,
    "knowWay": "string",
    "channelType": "string",
    "developChannel": 0,
    "introduceType": 0,
    "introducerId": 0,
    "introducerName": "string",
    "remark": "string",
    "customFieldsValueList": [
        {
            "zdm": "string",
            "zdz": "string"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

errcode

integer

状态码

必需

0正常 1失败

errmsg

string

信息

必需

data

object

返回结果

必需

直接返回患者ID

示例

{
    "errcode": 0,
    "errmsg": "成功",
    "data": 156315
}

给患者打标签

更新患者信息