Skip to main content

PTP_ORG_002：【取得】医療機関情報（患者用）

処理概要​

医療機関リストを取得する。

機能 IDAPI 論理名HTTP メソッドURI
PTP_ORG_002【取得】医療機関情報（患者用）GET{applicationPath}/participants/organizations/{organizationId}
連携方式データ形式利用可能な接続先
REST APIJSON 形式（エンコーディング：utf-8）リモート

リクエスト（認証）​

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

リクエスト（クエリ）​

No.項目名物理名属性Nullable設定要領
1名前namestring
2住所addressstring
3電話番号telecomstring

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

No.項目名物理名属性Nullable設定要領
1organizationId組織 IDstring○組織 ID を設定 ※患者用の場合、「0000000000」を設定

リクエスト(Body)​

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

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

＜パスパラメータ指定の場合＞

{applicationPath}/participants/organizations/0000000000

＜クエリパラメータ指定の場合＞

{applicationPath}/participants/organizations?name=クリニック X

レスポンス​

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-0488 東京都新宿区西新宿 2-12-1"
              }
            ]
          },
          "search": {
            "mode": "include"
          }
        },
        "version": "1"
      }
    ]
  }
}
異常終了
{
  "errorCode": "PLAT500",
  "errorMessage": "例外内容"
}

備考​

なし