帳票登録API

CAREKARTEへ帳票記録を登録することができるAPI

 

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

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

 

リクエストした内容はCAREKARTEに登録され該当する帳票画面に表示されます。

API ID

D0002

Request URL

documents/add
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/documents/add/{{カテゴリ}}
環境 URL
本番環境 https://api.link.carekarte.jp/documents/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)で日付データをやり取りしたい場合のみ使用

 

ボディ

パラメータ名 物理パラメータ名 必須:○ 条件付き必須:△ 文字数 文字種/形式 仕様
利用者ID userId String 10 半角英数字  
職員ID staffId String 10 半角英数字  
ブロックコード blockCd String 2 半角英数字 ユニットコードを指定する場合は必須
ユニットコード unitCd String 3 半角英数字 ブロックコードを指定する場合は必須
開始日時 sdateTime String YYYY-MM-DDHH:mm:ss または ISO8601形式 CAREKARTEでは秒数以下は切り捨てとなります。
終了日時 edateTime   String YYYY-MM-DDHH:mm:ss または ISO8601形式 CAREKARTEでは秒数以下は切り捨てとなります。 リクエストがない場合終了日は「未定」となります
データリンクフラグ datalinkFlag   Boolean    

データリンク(名前や住所、介護度といったその方の基本的な情報を自動で読み込む機能)を使用するか否かのフラグです。

true:データリンクを読み込む

false/パラメータなし:データリンクを読み込まない

※LINKパラメーター、データリンク、デフォルト記録が同じ項目で重複する場合は以下の優先順位となります LINKパラメーター>データリンク>デフォルト記録

デフォルト記録フラグ defaultFlag   Boolean

デフォルト記録(任意の項目に任意で設定した初期値を読み込む機能)を使用するか否かのフラグです。 true:デフォルト記録を読み込む

false/パラメータなし:デフォルト記録を読み込まない

※LINKパラメーター、データリンク、デフォルト記録が同じ項目で重複する場合は以下の優先順位となります LINKパラメーター>データリンク>デフォルト記録

申し送りフラグ handoverFlag   Boolean true:申し送りの記録とする false/パラメータなし:申し送りの記録にしない
サマリーフラグ summaryFlag   Boolean true:サマリーの記録とする false/パラメータなし:サマリの記録にしない
コメント comment   String    
LINKパラメーター CCJから提示   CCJから提示 登録したい内容を自由にカスタマイズできます。 登録したい内容をヒアリング後、CCJにて設定を行います。 具体的な物理パラメータ名については、設定後パートナーコンソールよりご確認いただけます。 ※LINKパラメーター、データリンク、デフォルト記録が同じ項目で重複する場合は以下の優先順位となります LINKパラメーター>データリンク>デフォルト記録

 

※データリンクについて

データリンクとは、CAREKARTEに搭載されている機能の名称で、様々な情報を帳票に自動転記できる機能です。

ご活用いただくことでリクエストのパラメータ数を減らすことができるためご活用ください。

詳細につきましては、ページ下部の「連携イメージ」を参照ください。

 

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

URL:care-record/add/facesheet //facesheetがカテゴリ
 
header:
Authorization:Bearer eyJhbGc…
Content-Type:application/json
X-CCJ-Datetime-Format:ISO8601/UTC
 
body:
{ 
   "userId": "0000000001",
   "staffId": "0000000002",
   "blockCd": "01",
   "unitCd": "002",
   "sdateTime":"2022-06-01 09:00:00",
   "edateTime":"2022-06-01 09:30:00",
   "datalinkFlag":true,
   "defaultFlag": true,
   "handoverFlag":true,
   "summaryFlag":false,
   "comment":"コメント",
/*以下がLINKパラメータ*/ 
   "personsWishes":"ご本人の希望",
   "familyWishes":"ご家族の希望"
},

レスポンス

ボディ

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

 

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

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

エラーレスポンス

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

連携イメージ(CAREKARTE)

データリンクイメージ

画像の通り、データリンクを使用すると職員氏名や利用者氏名、住所などの情報が自動で入力されるため、

該当項目をリクエストする必要がありません。

データリンクの設定項目は帳票によって異なりますが、代表的な項目は以下のとおりです。

設定名称
システム設定.システム日付(現在日時)
システム設定.ログイン事業所名
システム設定.ログインユーザー名
基本情報.名前
基本情報.名前(フリガナ)
基本情報.姓
基本情報.名
基本情報.姓(フリガナ)
基本情報.名(フリガナ)
基本情報.生年月日
基本情報.年齢
基本情報.月齢
基本情報.性別
基本情報.都道府県名称
基本情報.区市町村名称
基本情報.住所1+住所2
基本情報.住所1
基本情報.住所2
基本情報.郵便番号
基本情報.電話番号
職員情報(ログインユーザー).名前
職員情報(ログインユーザー).職種名
被保険者証.被保険者番号
被保険者証.保険者名称
被保険者証.要介護度
被保険者証.要介護度(略称)
被保険者証.認定期間(開始)
被保険者証.認定期間(終了)
被保険者証.居宅介護支援事業所番号
被保険者証.居宅介護支援事業所名称
被保険者証.障害高齢者の日常生活自立度(寝たきり度)
被保険者証.認知症高齢者の日常生活自立度

 

設定されている項目については、CAREKARTEで該当帳票を開き、左下に配置されている「設定表示」にチェックを入れた際に青く表示される部品が対象です。

※一部項目はAPI経由の登録では非対応となりますため、詳細はお問い合わせください。