帳票取得API

CAREKARTEの帳票の記録を取得することができるAPI

取得できる帳票記録はCAREKARTEの「フェイスシート」「施設サービス計画表第一表」等、帳票の画面に表示される記録となります。具体例はページ下部にあるリクエスト・レスポンスのサンプルデータとCAREKARTE連携イメージを参照してください。

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

※本APIでは「家族構成図」や「施設サービス計画第二表」等、CAREKARTEの仕様により一部取得できない帳票記録が存在します。

API ID

D0001

Request URL

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

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 △(※1) Number userIdに紐づけられたCAREKARTE記録IDです
申し送り記録のみ取得フラグ onlyHandoverFlag (※1) Boolean true:申し送りの記録のみを取得します
false、パラメータなし、boolean型以外:申し送りの記録を含めた記録を取得します
削除済み記録を含むフラグ includeDelFlag (※1) Boolean true:削除済を含む記録を取得します
false、パラメータなし、boolean型以外:削除された記録以外の記録を取得します
最新の記録を取得するフラグ lastUpdateFlag △(※1) String   true:期間を指定せず最新の記録を取得します
false・パラメータなし・boolean型以外:selectSdateTime~selectEdateTimeの期間内の最新の記録を取得します
帳票有効期間開始日 selectSdateTime △(※1) String YYYY-MM-DD HH:mm:ss
または
ISO8601形式
selectSdateTimeとlastUpdateFlag=trueが同時に宣言されている場合、lastUpdateFlagの宣言は無視されます
帳票有効期間終了日 selectEdateTime (※1) String YYYY-MM-DD HH:mm:ss
または
ISO8601形式
selectSdateTimeが宣言されている、かつ、selectEdateTimeが宣言されていない場合、selectEdateTimeにselectSdateTimeを格納します
取得指定項目 selectValue   [array] (CCJから提示) 特定の値のみを出力したい場合宣言します
カンマで複数指定可能です

(※1)条件付き必須項目(△)のいずれかは宣言されている必要があります。
また、パラメータの絞り込みの優先順は次の通りです。
1:recordId
2:onlyHandoverFlag・includeDelFlag
3:selectSdateTime・selectEdateTime
4:lastUpdateFlag

フェイスシートの「緊急連絡先」を記録を取得するサンプルデータ (実際にリクエストしても使用できません)

URL:documents/select/tokuyofacesheet //tokuyofacesheetがカテゴリ

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

body:
{
   "userId": "0000000001",
   "onlyHandoverFlag":true,
   "includeDelFlag": false,
   "lastUpdateTime": false,
   "selectSdateTime":"2022-08-01T00:00:00.000Z",
   "selectEdateTime":"2022-08-31T23:59:00.000Z",
   "selectValue"://以下リンクパラメータ
   ["emergency_contact_name1","emergency_contact_number1"]
 }

レスポンス

ボディ

パラメータ名 物理パラメータ 文字桁数 文字種/形式 仕様
利用者ID userId String 10 半角英数字  
記録ID recordId Number      
記録タイトル名 recordTitle String      
帳票有効期間開始日 sdateTime String   YYYY-MM-DD HH:mm:ss
または
ISO8601形式
ヘッダの「CCJ-Datetime-Format」によってどちらかが選択されます
帳票有効期間終了日 edateTime String   YYYY-MM-DD HH:mm:ss
または
ISO8601形式
ヘッダの「CCJ-Datetime-Format」によってどちらかが選択されます
記録作成職員ID staffId String 10 半角英数字  
帳票更新日 lastUpdateTime String   YYYY-MM-DD HH:mm:ss
または
ISO8601形式
ヘッダの「CCJ-Datetime-Format」によってどちらかが選択されます
記録更新職員ID updateStaffId String 10 半角英数字  
申し送りフラグ handoverFlag Boolean     true:申し送りの記録です
false:申し送りの記録ではありません
削除フラグ delFlag Boolean     true:削除された記録です(論理削除)
false:削除された記録ではありません
LINKパラメータ (CCJから提示) (CCJから提示)     具体的な物理パラメータ名については、取得したい内容をヒアリング後、CCJからお伝えします。

 

帳票(フェイスシート)の記録の取得に成功した際のサンプルデータ
※リクエストで緊急連絡先を抽出する宣言をしているので、その値だけを返却しています。

{ 
   "userId": "0000000001",
   "recordId": 112,
   "recordTitle": "フェイスシート(特養)",
   "sdateTime": "2022-12-08 00:00:00",
   "edateTime": "2022-12-31 00:00:00",
   "staffId": "0000000002",
   "lastUpdateTime": "2022-12-08 11:32:52",
   "updateStaffId": "0000000009",
   "handoverFlag": false,
   "delFlag": false,
   "emergency_contact_name1": "ケアコネ 一郎",
   "emergency_contact_number1": "111-1111-1111"
}

エラーレスポンス

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

連携イメージ(CAREKARTE)

イメージ画像はCAREKARTEの標準の特養フェイスシートのレイアウトです。

リクエスト・レスポンス例では取得をしたい値を指定していたため、「緊急連絡先1氏名」「緊急連絡先1電話番号」のみを返却しています。値を指定せずに返却させることも可能です。
※フェイスシート内の「家族構成図」は通常の画像と仕様が異なるため取得できません
※画像は取得可能ですが、Base64での返却となりますためレスポンス容量が大きくなることが予想されます