API 一覧
1. 共通
1.1. 認証
| 機能 ID | 論理名 |
|---|---|
| COM_ATH_001 | 【認証】認証エンドポイント |
| COM_ATH_002 | 【認証】認証完了後リダイレクト |
| COM_ATH_003 | 【認証】トークン取得 |
| COM_ATH_004 | 【認証】トークン更新 |
2. 医療機関向け
2.1. 認証
| 機能 ID | 論理名 |
|---|---|
| PRV_ATH_001 | 【更新】認証情報管理（医療機関用） |
2.2.権限管理
| 機能 ID | 論理名 |
|---|---|
| PRV_ROL_001 | 【取得】権限情報 |
| PRV_ROL_002 | 【登録】権限の要求（承認要求）（医療機関用） |
| PRV_ROL_003 | 【登録】権限の要求（承認済み）（医療機関用） |
| PRV_ROL_004 | 【取得】権限の要求状態（医療機関用） |
| PRV_ROL_005 | 【更新】権限の要求取消（医療機関用） |
| PRV_ROL_006 | 【取得】権限の被要求状態（医療機関用） |
| PRV_ROL_007 | 【更新】権限の被要求状態の承認・拒否（医療機関用） |
| PRV_ROL_008 | 【更新】権限の部分承認（医療機関用） |
| PRV_ROL_009 | 検討記録・伝達記録を共有 |
| PRV_ROL_010 | 【削除】付与済みの権限（医療機関用） |
2.3. 組織管理
| 機能 ID | 論理名 |
|---|---|
| PRV_ORG_001 | 【取得】文書情報が存在する医療機関リスト |
| PRV_ORG_002 | 【取得】医療機関情報（医療機関用） |
2.4. 文書管理
| 機能 ID | 論理名 |
|---|---|
| PRV_DOC_001 | 【取得】患者全文書（見出し）情報（医療機関用） |
| PRV_DOC_002 | 【取得】患者文書情報 ※１文書（医療機関用） |
| PRV_DOC_003 | 【取得】患者文書情報 ※リスト、文書タイプ、カテゴリ絞り込み（医療機関用） |
| PRV_DOC_004 | 【取得】患者文書情報 ※１文書中の指定 1 リソース（医療機関用） |
| PRV_DOC_005 | 【取得】患者文書情報 ※リスト、特定条件、特定リソース（医療機関用） |
| PRV_DOC_006 | 【登録】特定文書 （※一括登録含む）（医療機関用） |
| PRV_DOC_007 | 【更新】特定文書 （※一括更新含む）（医療機関用） |
| PRV_DOC_008 | 【削除】特定文書 （※一括削除含む）（医療機関用） |
| PRV_DOC_009 | 【明示的承認】文書の承認 （※一括承認含む） |
2.5. ユーザ管理
| 機能 ID | 論理名 |
|---|---|
| PRV_USR_001 | 【登録】ユーザ情報（医療機関用） |
| PRV_USR_002 | 【取得】ユーザ情報（医療機関用） |
2.6. 患者管理
| 機能 ID | 論理名 |
|---|---|
| PRV_PAT_001 | 【登録】PLAT患者情報（医療機関用） |
| PRV_PAT_002 | 【取得】PLAT患者情報（医療機関用） |
| PRV_PAT_003 | 【データコピー】複数文書ローカル取得 |
| PRV_PAT_004 | 【取得】特定文書を持つ患者情報 |
2.7. スタッフ管理
| 機能 ID | 論理名 |
|---|---|
| PRV_STF_001 | 【登録】スタッフ情報 |
| PRV_STF_002 | 【取得】スタッフ情報 |
| PRV_STF_003 | 【登録】スタッフ情報（認証情報まで一括登録） |
3. 患者向け
3.1. 認証
| 機能 ID | 論理名 |
|---|---|
| PTP_ATH_001 | 【更新】認証情報管理（患者用） |
3.2. 権限管理
| 機能 ID | 論理名 |
|---|---|
| PTP_ROL_002 | 【登録】権限の要求（承認要求）（患者用） |
| PTP_ROL_003 | 【登録】権限の要求（承認済み）（患者用） |
| PTP_ROL_004 | 【取得】権限の要求状態（患者用） |
| PTP_ROL_005 | 【更新】権限の要求取消（患者用） |
| PTP_ROL_006 | 【取得】権限の被要求状態（患者用） |
| PTP_ROL_007 | 【更新】権限の被要求状態の承認・拒否（患者用） |
| PTP_ROL_008 | 【更新】権限の部分承認（患者用） |
| PTP_ROL_010 | 【削除】付与済みの権限（患者用） |
3.3. 文書管理
| 機能 ID | 論理名 |
|---|---|
| PTP_DOC_001 | 【取得】患者全文書（見出し）情報（患者用） |
| PTP_DOC_002 | 【取得】患者文書情報 ※１文書（患者用） |
| PTP_DOC_003 | 【取得】患者文書情報 ※リスト、文書タイプ、カテゴリ絞り込み（患者用） |
| PTP_DOC_004 | 【取得】患者文書情報 ※１文書中の指定 1 リソース（患者用） |
| PTP_DOC_005 | 【取得】患者文書情報 ※リスト、特定条件、特定リソース（患者用） |
| PTP_DOC_006 | 【登録】特定文書 （※一括登録含む）（患者用） |
| PTP_DOC_007 | 【更新】特定文書 （※一括更新含む）（患者用） |
| PTP_DOC_008 | 【削除】特定文書 （※一括削除含む）（患者用） |
3.4. 組織管理
| 機能 ID | 論理名 |
|---|---|
| PTP_ORG_002 | 【取得】医療機関情報（患者用） |
3.5. ユーザ管理
| 機能 ID | 論理名 |
|---|---|
| PTP_USR_001 | 【登録】ユーザ情報（患者用） |
| PTP_USR_002 | 【取得】ユーザ情報（患者用） |
| PTP_USR_003 | 【更新】自身のユーザ情報（患者用） |