【公開停止】ナースコール情報登録(ベッド情報)API

ナースコールからの呼び出し情報を、コールの記録タイトルへ連携する登録用API

ベッド情報をキーとして利用者を特定し記録を作成するため、登録時は対象のベッド情報が必要です

API ID

NC0002

Request URL

nsCall/add2

環境	URL
Staging環境	https://stage-api.link.carekarte.jp/nsCall/add2

環境	URL
本番環境	https://api.link.carekarte.jp/nsCall/add2

HTTPメソッド

POST

リクエスト

header（すべて必須）

名前	値
Content-Type	application/json
authorization	tokenサービスで取得した値を設定

Body（JSON形式）

パラメータ	型	必須：○	サイズ・形式	説明	仕様	CAREKARTEタイトル項目
blockCd	String	○	2桁	ブロックコード
unitCd	String	○	3桁	ユニットコード
roomNo	String	○	3桁	部屋コード
bedNo	String	○	3桁	ベッドコード
userId	String		10桁	利用者ID	入力されている場合、特定した利用者とIDを比較記録作成のルールは下部「利用者を特定し、記録を作成する条件」を参照
sdate	String	○	YYYY-MM-DD HH:mm:ss.sss	コールされた日時(JST)
edate	String		YYYY-MM-DD HH:mm:ss.sss	コールを対応完了した日時(JST)
ncPlase	String			ナースコール発生場所	居室名、共用部名等を記載	※場所
ncType	String			呼出種別		※呼出種別
ncReasonClass	String			呼出理由分類		※呼出理由分類
ncReason	String			呼出理由		※呼出理由
ncNoAnswer	String			未対応状況		※未対応状況
ncTime	Number		10桁	通話時間（秒）		※通話時間
ncResponTime	Number		10桁	呼出～応答時間（秒）		※呼出～応答
ncRecoveryTime	Number		10桁	応答～終話時間（秒）		※終話～復旧
ncCare	String			処置入力		※処置入力
ncStaffCd	String		10桁	対応職員ID	入力されている場合その職員をセットする未入力の場合は記録者名は「CKAPI」をセット	※対応者

※カスタマイズでの項目追加ではなく、ナースコール連携用標準タイトルとなります

サンプルデータ

{
    "blockCd": "01",
    "unitCd": "001",
    "roomNo": "003",
    "bedNo": "001",
    "userId": "0000000001",
    "ncStaffCd":"0000000004",
    "sdate":"2021-09-11 01:00:00.000",
    "edate":"2021-09-11 01:05:30.000",
    "ncPlase": "居室：弥生、ベッド番号001",
    "ncType": "呼出種別",
    "ncReasonClass": "呼出理由分類",
    "ncReason": "呼出理由",
    "ncNoAnswer": "未対応状況",
    "ncTime": 123456789,
    "ncResponTime": 300,
    "ncRecoveryTime": 400,
    "ncCare": "処置入力"
}

レスポンス

Body（JSON形式）

パラメータ	型	必須	サイズ・形式	説明	仕様
status	Number	○	1桁		処理結果を返却する
data	[array]
userId	String		10桁	利用者ID
recordId	String			記録ID	利用者ごとのユニークID

サンプルデータ

記録の登録完了

{
    "status": 0,
    "data": [
        {
            "recordId": "16992",
            "userId": "0000000068"
        }
    ]
}

エラー発生時（ベッド番号が正しくない場合）

{
    "code": 400,
    "timestamp": "9/11/2021, 6:54:10 AM",
    "path": "/nsCall/add2",
    "method": "POST",
    "message": "Validation failed: bedNo should not be empty"
}

連携イメージ(CAREKARTE)

その他

利用者を特定し、記録を作成する条件

基本的な入力想定パターンは以下の通り。利用者の個人番号については架空のものである。
共用エリアの使用も想定されるため、1つのベッドに複数人のスケジュールが登録されていた場合、該当ベッドに登録されている全ての利用者に対して下記条件をもとに記録を作成する

該当ベッドに登録されたスケジュールの利用者 (CAREKARTE個人番号)	APIのuserIdにセットされた利用者 (利用者ID)	処理内容
利用者A(0000000001)	利用者A(0000000001)	CAREKARTE個人番号と利用者IDの比較チェック後、合致したため、利用者A(0000000001)に記録作成
利用者A(0000000001)	利用者B(0000000002)	CAREKARTE個人番号と利用者IDの比較チェック後、異なるため、検索したベッドを利用している利用者A(0000000001)に記録作成
利用者A(0000000001)	利用者登録なし(null)	CAREKARTE個人番号と利用者IDの比較チェック後、異なるため、検索したベッドを利用している利用者A(0000000001)に記録作成

スケジュールタイトルが存在しないベッド情報（共用トイレなど）で登録された場合の入力想定パターンは以下の通り。

該当ベッドに登録されたスケジュールの利用者 (CAREKARTE個人番号)	APIのuserIdにセットされた利用者 (利用者ID)	処理内容
利用者登録なし(null)	利用者A(0000000001)	利用者IDの所属チェック。利用者が自事業所に存在し所属が有効である場合、利用者A(0000000001)に記録作成
利用者登録なし(null)	自事業所に所属が存在しない利用者 (XXXXXXXXXX)	利用者IDの所属チェック。利用者が自事業所に存在し所属が無効である場合、氏名不詳(0000000000)に記録作成
利用者登録なし(null)	利用者登録なし(null)	利用者IDの所属チェック。利用者が自事業所に存在せず所属が無効である場合、氏名不詳(0000000000)に記録作成

利用者が特定できなかった場合

氏名不詳(0000000000)として作成された記録は、1回のみ利用者の編集が可能です。
1度、特定の利用者に設定した記録は、以降利用者の編集はできません。