往診情報登録API(デフォルト記録対応版)

往診の情報を登録するAPI

API ID

CS0001

Request URL

consultation/doctorvisit-add-d
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/consultation/doctorvisit-add-d
環境 URL
本番環境 https://api.link.carekarte.jp/consultation/doctorvisit-add-d

HTTPメソッド

POST

リクエスト

header（すべて必須）

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

Body（JSON形式）

パラメータ 型 必須：○
条件付き必須：△		 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
userId String ◯ 10桁 利用者ID    
sdateTime String ◯ YYYY-MM-DD HH:mm:ss
または
YYYY-MM-DDTHH:mm:ss.sssZ		 記録開始日時 YYYY-MM-DD HH:mm:ssで連携した場合、そのままの時間で記録を作成
YYYY-MM-DDTHH:mm:ss.sssZで入力された場合、UTCとみなし、YYYY-MM-DDTHH:mm:ss.sss+09:00の時間で記録を作成		  
edateTime String   YYYY-MM-DD HH:mm:ss
または
YYYY-MM-DDTHH:mm:ss.sssZ		 記録終了日時 連携なし
またはsdateTimeより過去の日時の場合、sdateTimeの時間をセットする
YYYY-MM-DD HH:mm:ssで連携した場合、そのままの時間で記録を作成
YYYY-MM-DDTHH:mm:ss.sssZで入力された場合、UTCとみなし、YYYY-MM-DDTHH:mm:ss.sss+09:00の時間で記録を作成		  
defaultFlag Boolean     デフォルト記録フラグ true：デフォルト記録読み込みあり
falseまたはパラメータなし：デフォルト記録読み込みなし		  
handoverFlag Boolean     申し送りフラグ true：申し送り記録
falseまたはパラメータなし：通常記録		  
doctor String △   医師名   医師
diagnosis String △   指示所見   指示所見
instructions String △   対応   対応
staffId String ○ 10桁 職員ID    

※必須項目欄の入力項目△については、△部分が全て空の値の場合、記録を作成せず400エラーを返却する。空欄部分の入力有無は、記録の作成に影響しない。

サンプルデータ

{ 
    "userId": "0000000060",
    "sdateTime":"2022-03-09T03:01:02.000Z",
    "edateTime":"2022-03-09T03:03:04.000Z",
    "defaultFlag":true,
    "handoverFlag":true,
    "doctor":"",
    "diagnosis":"指示所見内容",
    "instructions":"対応内容",
    "staffId":"0000000004"
}

レスポンス

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様 CAREKARTEタイトル項目
userId String ○ 10桁 利用者ID    
recordId Number[array] ○   記録ID    
message String     メッセージ エラー等、メッセージがあれば返却  

サンプルデータ

記録の登録完了
{
    "userId": "0000000060",
    "recordId": [
        172
    ]
}

エラー発生時（存在しない利用者のIDの場合）
{
    "code": 400,
    "timestamp": "3/10/2022, 7:21:47 AM",
    "path": "/consultation/doctorvisit-add-d",
    "method": "POST",
    "message": "UserId does not exist"
}

連携イメージ(CAREKARTE)