介護記録取得API

CAREKARTEの介護記録を取得することができるAPI

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

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

取得できる介護記録はCAREKARTEの「業務メニュー>日常記録管理>記録一覧」の画面に表示される介護記録となります。

API ID

CR0002

Request URL

care-record/select

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

環境	URL
本番環境	https://api.link.carekarte.jp/care-record/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)の形式で日時データを連携します。

ボディ

パラメータ名	物理パラメータ名	配列内パラメータ	必須	型	文字桁数	文字種/形式	仕様
取得期間開始日時	selectSdateTime		○	String		YYYY-MM-DD HH:mm:ss または ISO8601形式	CAREKARTEでは秒数以下は切り捨ててデータを取得となります。 edateTimeがない、または不正の値の場合には、selectSdateTImeの日づけ「YYYY-MM-DD」の1日分のデータを取得します。
取得期間終了日時	selectEdateTime			String		YYYY-MM-DD HH:mm:ss または ISO8601形式	CAREKARTEでは秒数以下は切り捨ててデータを取得となります。取得の開始～終了日の上限日数は31日となります。
取得対象者	selectUsers			[array]
利用者ID		userId	△	String	10	半角英数字	利用者IDはU0007　事業所所属利用者一覧取得API等から取得してください。取得対象者の配列を使用する際には必須となります。
記録ID		recordId		Number			記録IDは、CR0001　介護記録登録APIで登録した際に返却されます。利用者ID + 記録IDでユニークなため、記録IDのみでリクエストはできません。記録IDをnullとすると記録IDに関わらず利用者の記録を取得します。
ブロックコードのフィルタ	blockCd			String	2	半角英数字	O0002　組織情報取得APIから取得してください。
ユニットコードのフィルタ	unitCd			String	3	半角英数字	O0002　組織情報取得APIから取得してください。
申し送り記録のみ取得フラグ	onlyHandoverFlag			Boolean			申し送り記録を取得するか否かののフラグです。 true：申し送り記録のみを取得する false またはパラメータなし：申し送りを含む記録を取得する申し送り記録は赤く表示されている介護記録で、「業務メニュー>日常記録管理>ホーム」にも表示されています。
削除済み記録を含むフラグ	includeDelFlag			Boolean			CAREKARTE上で削除された記録も取得するか否かのフラグです。 true：削除された介護記録を取得する false またはパラメータなし：削除された介護記録は取得しない

※△は条件付き必須

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

URL：care-record/select/meal　//mealがカテゴリ

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

body：
{
   "selectSdateTime":"2022-08-01T00:00:00.000Z",
   "selectEdateTime":"2022-08-31T23:59:00.000Z",
   "selectUsers":[
 　　{
 　　　　"userId":"0000000001",
 　　　　"recordId":12343
 　　},
  　　{
 　　　　"userId":"0000000002",
 　　　　"recordId":null
 　　}
   ]  
   "blockCd": "01",
    "unitCd": "002",
    "onlyHandoverFlag":true,
    "includeDelFlag":false
 }

レスポンス

ボディ

パラメータ名	物理パラメータ名	配列内パラメータ	型	文字桁数	文字種/形式	備考
記録件数	numberOfRecords		Number			介護記録を取得できる上限件数は100件です。
取得記録	records		[array]
利用者ID		userId	String	10	半角英数字
記録ID		recordId	Number
記録職員ID		staffId	String	10	半角英数字
実施職員ID		workerId	String	10	半角英数字
記録開始日時		sdateTime	String		YYYY-MM-DD HH:mm:ss または ISO8601形式
記録終了日時		edateTime	String		YYYY-MM-DD HH:mm:ss または ISO8601形式
申し送りフラグ		handoverFlag	Boolean
削除フラグ		delFlag	Boolean
LINKパラメータ		（CCJから提示）	（CCJから提示）			取得したい内容を自由にカスタマイズできます。具体的な物理パラメータ名については、登録したい内容をヒアリング後、CCJからお伝えします。

食事の介護記録の取得に成功した際のサンプルデータ

"numberOfRecords"：2,
"records":[
　{
　　"userId":"0000000001",
　　"recordId":12343,
　　"staffId":"0000000002",
　　"workerId":"0000000002",
　　"sdateTime":"2022-08-17T08.00.00.000Z",
　　"edateTime":"2022-08-17T08.30.00.000Z",
　　"handoverFlag":false,
　　"delFlag":false,
　　"mainMl":"10",　//主食
　　"subMl":"9",　//副食
　　"state":"様子"
　},
　{
　　"userId":"0000000002",
　　"recordId":12,
　　"staffId":"0000000002",
　　"workerId":"0000000002",
　　"sdateTime":"2022-08-20T08.00.00.000Z",
　　"edateTime":"2022-08-20T08.30.00.000Z",
　　"handoverFlag":false,
　　"delFlag":false,
　　"mainMl":"8",
　　"subMl":"7",
　　"state":"様子"
　}
]

エラーレスポンス

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

連携イメージ(CAREKARTE)

イメージ画像はCAREKARTEの標準の食事のレイアウトです。

例では取得できる項目が「主食」「副食」「様子」の3つですが、自由にカスタマイズが可能なため、「水分量」の項目を追加などができます。