Skip to main content

PRV_ORG_001：【取得】文書情報が存在する医療機関リスト

処理概要​

特定患者の文書情報が存在し閲覧許可されている医療機関リストを取得する。

機能 IDAPI 論理名HTTP メソッドURI
PRV_ORG_001【取得】文書情報が存在する医療機関リストGET{applicationPath}/providers/patients/{patientId}/organizations
連携方式データ形式利用可能な接続先
REST APIJSON 形式（エンコーディング：utf-8）ローカル、リモート

リクエスト（認証）​

No.項目名物理名属性Nullable設定要領
1アクセストークンAuthorizationstring-認証処理で取得した Bearer Token を設定

リクエスト（クエリ）​

No.項目名物理名属性Nullable設定要領
1参照先locationstring-"all"もしくは医療機関 ID のカンマ区切りを URL エンコードを行い指定
2検索開始日consultationDayFromstring-診療日の検索開始日　 YYYY-MMM-DD 形式
3検索終了日consultationDayTostring-診療日の検索終了日　 YYYY-MMM-DD 形式

リクエスト（パスパラメータ）​

No.項目名物理名属性Nullable設定要領
1患者 IDpatientIdstring-医師の場合は自病院のスタッフ ID、患者の場合は PLAT 共通 ID を URL エンコードを行い設定

リクエスト(Body)​

No.項目名物理名L1L2L3L4L5L6繰返し属性Nullableリクエスト設定要領
-

サンプル（リクエスト）​

{applicationPath}/providers/patient/11310000001000001/organization?consultationDayFrom=2021-03-01

レスポンス​

No.項目名物理名L1L2L3L4L5L6繰返し属性Nullableレスポンス設定要領
1検索結果searchResults○○object-
2件数count○-integer-検索結果件数
3取得データリストresults○○array-
4医療機関情報contents○-string-OpenFRUCtoS の Organization リソースの仕様に準拠する
5医療機関バージョンversion○-string-Organization リソースのバージョン
エラー条件
システムエラー
・API 共通仕様に準拠
業務エラー
・なし

サンプル（レスポンス）​

正常終了
{
  "searchResults": {
    "count": 1,
    "results": [
      {
        "contents": {
          "fullUrl": "http://localhost:8099/of1/Organization/2",
          "resource": {
            "resourceType": "Organization",
            "id": "2",
            "meta": {
              "versionId": "1",
              "lastUpdated": "2021-10-07T18:30:14.792+09:00"
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>1310000001</li><li>クリニックX</li><li>〒163-0490 東京都新宿区西新宿 2-1-1</li><li>03-0000-0001</li></ul></div>"
            },
            "identifier": [
              {
                "system": "http://hl7.jp/fhir/ePrescription/InsuranceMedicalInstitutionNo",
                "value": "1310000001"
              }
            ],
            "name": "クリニック X",
            "telecom": [
              {
                "system": "phone",
                "value": "03-0000-0001"
              }
            ],
            "address": [
              {
                "text": "163-0490 東京都新宿区西新宿 2-1-1"
              }
            ]
          },
          "search": {
            "mode": "include"
          }
        },
        "version": "1"
      }
    ]
  }
}
異常終了
{
  "errorCode": "PLAT500",
  "errorMessage": "例外内容"
}

備考​

なし