介護記録登録API

CAREKARTEへ介護記録を登録することができるAPI

 

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

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

 

リクエストした内容はCAREKARTEに登録され「業務メニュー>日常記録管理>記録一覧」の画面に表示されます。

API ID

CR0001

Request URL

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

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 半角英数字 U0007 事業所所属利用者一覧取得API等から取得してください。
登録職員ID staffId String 10 半角英数字 ST0003 事業所所属職員一覧取得API等から取得してください。
実施職員ID workerId   String 10 半角英数字 機能訓練などで記録を登録した職員と実施した職員が異なった場合に
使用するパラメータです。

指定しない場合は、登録職員ID(staffId)の職員が登録されます。

記録開始日時 sdateTime String   YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
CAREKARTEでは秒数以下は切り捨てとなります。
記録終了日時 edateTime   String   YYYY-MM-DD HH:mm:ss(JST)
または
ISO8601形式
CAREKARTEでは秒数以下は切り捨てとなります。
指定しない場合は、記録開始日時(stdateTime)の時間を終了日時とします。
デフォルト記録フラグ defaultFlag   Boolean     CAREKARTEでは記録に対してあらかじめデフォルトの値を設定でき、そのデフォルト値を使用するか否かのフラグです。

true:デフォルト記録を使用する

false または パラメータなし:デフォルト記録を使用しない

 ex)食事記録で、食事する場所は居室と決まっているので、あらかじめ設定しておく等。

申し送りフラグ handoverFlag   Boolean     申し送り記録とするか否かのフラグです。

true:申し送りの記録とする

false または パラメータなし:申し送りの記録としない

申し送り記録とすると、記録内容が赤く表示され「業務メニュー>日常記録管理>ホーム」にも表示されます。

ブロックコード blockCd   String 2 半角英数字 通常は、記録を登録する利用者のスケジュールが登録されているブロック・ユニットに属する介護記録が作成します。スケジュールが複数ある場合は、自動で開始日が最新のスケジュールのブロック・ユニットの記録として、記録を作成します。
このパラメータは、運用上、スケジュールが複数あった場合に、どのスケジュールかを選択したい場合にのみ使用します。そのため入力したblockCd,unitCdが有効である、かつ、そのblockCd,unitCdのスケジュールが存在している場合に、入力したブロック・ユニットの記録として作成します。
ユニットコード unitCd   String 3 半角英数字 ブロックコードの仕様と同じになります。
LINKパラメータ (CCJから提示)  ◯ (CCJから提示)     登録したい内容を自由にカスタマイズできます。
具体的な物理パラメータ名については、登録したい内容をヒアリング後、CCJからお伝えします。

食事の記録を登録するサンプルデータ (実際にリクエストしても使用できません)

URL:care-record/add/meal //mealがカテゴリ
 
header:
Authorization:Bearer eyJhbGc…
Content-Type:application/json
X-CCJ-Datetime-Format:ISO8601/UTC
 
body:
{
 "userId": "0000000001",
 "sdateTime":"2022-06-01T09:00:00.000Z",
 "edateTime":"2022-06-01T09:30:00.000Z",
 "staffId": "0000000002",
 "workerId": "0000000002",
 "defaultFlag":true,
 "handoverFlag":true,
 "blockCd":"01",
 "unitCd":"001",
/*以下がLINKパラメータ*/
 "mainMl":"10", //主食
 "subMl":"9", //副食
 "state":"様子",
 "support":"対応",
}

レスポンス

ボディ

パラメータ名 物理パラメータ名 必須 文字桁数 文字種/形式 備考
利用者ID userId String 10 半角英数字  
記録ID recordId Number     利用者IDと記録IDの組み合わせでユニークとなります。

 

データの登録成功のサンプルデータ

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

エラーレスポンス

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

連携イメージ(CAREKARTE)

例では登録した項目が「主食」「副食」「様子」「対応」の4つですが、例えば「水分量」の項目を追加したり、イメージの画像にない項目も追加することが可能です。

またイメージ画像はCAREKARTEの標準の食事のレイアウトですが、このAPIを使用する際には、基本的にパートナー様専用のレイアウトを作成いたします。こちらもヒアリングの後にCCJから提案させていただきます。