帳票更新API

CAREKARTEへ登録した帳票の記録を更新することができるAPI

リクエストの「LINKパラメータ」では、更新したい帳票の記録のデータを自由にカスタマイズすることができます。具体例はページ下部にあるリクエスト・レスポンスのサンプルデータとCAREKARTE連携イメージを参照してください。

このAPIを使用するにはCCJ側の設定が必須となります。どんな記録をCAREKARTEに登録・更新したいかを確認の上で、お問い合わせよりご相談ください。

 

API ID

D0003

Request URL

documents/update
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/documents/update/{{カテゴリ}}
環境 URL
本番環境 https://api.link.carekarte.jp/documents/update/{{カテゴリ}}

HTTPメソッド

POST

リクエスト

パスパラメータ

パスパラメータ名 仕様
カテゴリ (CCJから提示) URLのパスパラメータ。
具体的な値については更新したい内容をヒアリング後、CCJからお伝えします。

ヘッダー

名前 必須 仕様
Content-Type application/json  
authorization tokenサービスで取得した値を設定  
X-CCJ-Datetime-Format   ISO8601/UTC

ISO8601の拡張形式(YYYY-MM-DDThh:mm:ss.sssZ)で日時データを連携したい場合のみ使用します。

指定しない場合はYYYY-MM-DD HH:mm:ss(JST)の形式で日時データを連携します。

 

ボディ

パラメータ名 物理パラメータ 必須 文字桁数 文字種/形式 仕様
利用者ID userId String 10 半角英数字 CAREKARTEに登録されている利用者番号です
記録ID recordId Number     userIdに紐づけられたCAREKARTE記録IDです
更新職員ID staffId String 10 半角英数字 ST0003 事業所所属職員一覧取得API等から取得してください。
ブロックコード blockCd △(※1) String 2 半角英数字 O0002 組織情報取得APIから取得してください。
ユニットコード unitCd   String 3 半角英数字 O0002 組織情報取得APIから取得してください。
記録開始日時 sdateTime   String   YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
CAREKARTEでは秒数以下は切り捨てとなります。
記録終了日時 edateTime   String   YYYY-MM-DD HH:mm:ss(JST)
または
ISO8602形式
CAREKARTEでは秒数以下は切り捨てとなります。
申し送りフラグ handoverFlag   Boolean     申し送り記録とするか否かのフラグです。
true:申し送りの記録とする
false:申し送りの記録としない
サマリーフラグ summaryFlag   Boolean     サマリーフラグ記録とするか否かのフラグです。
true:サマリーフラグの記録とする
false:サマリーフラグの記録としない
コメント comment   String     CAREKARTEにコメントとして更新されます。
削除済み記録フラグ delFlag   Boolean                      削除済み(論理削除)記録とするか否かのフラグです。
true:削除済みの記録とする
false:削除済みの記録としない
LINKパラメータ (CCJから指定)   (CCJから指定)     具体的な物理パラメータ名については、記録更新したい内容をヒアリング後、CCJからお伝えします。

(※1)unitCdが宣言されている場合、blockCdの宣言が必須になります。

宣言されないパラメータは記録更新されません。

 

フェイスシートを更新するサンプルデータ(実際にリクエストしても使用できません)

URL:document/update/tokuyofacesheet //tokuyofacesheetがカテゴリ

header:
Authorization:Bearer eyJhbGc…
Content-Type:application/json
X-CCJ-Datetime-Format:ISO8601/UTC

body:
{ 
   "userId": "0000000001",
   "recordId": 112,
   "staffId": "0000000002",
   "blockCd": "01",
   "unitCd": "001",
   "sdateTime":"2022-06-01 09:00:00",
   "edateTime":"2022-06-01 09:30:00",
   "handoverFlag":true,
   "summaryFlag": true,
   "comment": "あいうえお" 
   "delFlg":false
}

レスポンス

ボディ

パラメータ名 物理パラメータ名 必須 文字桁数 文字種/形式 備考
利用者ID userId String 10 半角英数字 リクエストのuserIdと同値です。
記録ID recordId Number     リクエストのrecordIdと同値です。

 

帳票(フェイスシート)の更新に成功した際のサンプルデータ

{ 
  "userId":"0000000001",
  "recordId":1124
}

エラーレスポンス

エラーレスポンスを参照してください。

連携イメージ(CAREKARTE)

更新前の帳票(イメージ)

更新後の記録(イメージ)

例では更新されている項目が赤枠で囲っている部分のみですが、それ以外の項目についても更新可能です。
登録時に値が入っていない項目に対して更新することも可能です。(退所理由、緊急連絡先等)

イメージ画像はCAREKARTEの標準のフェイスシートのレイアウトですが、このAPIを使用する際には、基本的にD0002:帳票記録登録APIと同じパートナー様専用のレイアウトを作成いたします。こちらもヒアリングの後にCCJから提案させていただきます。