服薬情報取得API

利用者の服薬情報を連携する取得用API

利用者IDの指定では、最新の記録を1件取得
利用者IDに記録IDを加えて指定すると、対象の記録IDの記録情報を取得
また、利用者IDに日付を加えて指定すると、対象日の記録情報をすべて取得

API ID

M0011

Request URL

medicine/select
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/medicine/select
環境 URL
本番環境 https://api.link.carekarte.jp/medicine/select

HTTPメソッド

POST

リクエスト

header(すべて必須)

名前
Content-Type application/json
authorization tokenサービスで取得した値を設定

Body(JSON形式)

パラメータ 必須 サイズ・形式 説明 仕様
userId String 10桁 利用者ID  
recordId Number     記録ID  
selectDate String   YYYY-MM-DD 記録取得日

指定した日付の記録の一覧を取得

JST時刻

recordType Number   1桁 記録タイプ

0:定期与薬の記録のみ取得
1:臨時与薬の記録のみ取得
nullまたはパラメータがない場合:両方の記録を取得

サンプルデータ

{ 
    "userId": "0000000001",
 "recordId":1234,
 "selectDate":"2022-01-13",
 "recordType":1
}

レスポンス

Body(JSON形式)

パラメータ 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
userId String 10 利用者ID    
selectDate String   YYYY-MM-DD 記録取得日 JST時刻  
records [array]     取得情報 対象記録がない場合は省略  
 recordId String     記録ID    
 recordType String     記録タイプ 0:定期与薬の記録
1:臨時与薬の記録
 
 handoverFlag Boolean     申し送りフラグ true:申し送りの記録
false:通常記録
 
 dateTime String   YYYY-MM-DD HH:mm:ss 記録開始日時 JST時刻  
 edateTime String   YYYY-MM-DD HH:mm:ss 記録終了日時 JST時刻  
 section String     実施区分 標準の場合「実施」または「中止」と返却 【定期与薬】与薬
 content String     内容   【定期与薬】内容
 type String     薬の種類   【臨時与薬】種類
 name String     薬名   【臨時与薬】薬名
 amt String     用量   【臨時与薬】用量
 state String     様子   【定期与薬】様子
【臨時与薬】様子
 support String     対応   【定期与薬】対応
【臨時与薬】対応

サンプルデータ

記録の取得完了
{
    "userId": "0000000022",
    "selectDate": "2022-01-19",
    "records": [
        {
            "recordId": 1,
            "recordType": 0,
            "handoverFlag": false,
            "dateTime": "2022-01-19 11:40:00",
            "edateTime": "2022-01-19 11:40:00",
            "section": "実施",
            "content": "抗生剤",
            "type": "",
            "name": "",
            "amt": "",
            "state": "昼食後に薬を渡した際、「飲みたくない」とおっしゃって服用しなかった。",
            "support": "1時間後、再度声かけを行ったところ、すぐに飲んで下さった。"
        },
        {
            "recordId": 2,
            "recordType": 1,
            "handoverFlag": false,
            "dateTime": "2022-01-19 11:48:00",
            "edateTime": "2022-01-19 11:48:00",
            "section": "",
            "content": "",
            "type": "鎮痛剤",
            "name": "カロナール錠",
            "amt": "2錠",
            "state": "頭痛がするとおっしゃられたため、処方されている頓服を服用された。",
            "support": "2時間後にお伺いしたところ、痛くなくなったとのこと。"
        }
    ]
}

エラー発生時(指定の記録が存在しない場合)
{
    "code": 400,
    "timestamp": "9/18/2021, 5:46:43 AM",
    "path": "/medicine/select",
    "method": "POST",
    "message":"UserId does not exist"
}

連携イメージ(CAREKARTE)