Skip to main content

PTP_DOC_001:【取得】患者全文書(見出し)情報(患者用)

処理概要

特定患者の文書の見出し情報を取得する。

機能 IDAPI 論理名HTTP メソッドURI
PTP_DOC_001【取得】患者全文書(見出し)情報(患者用)GET{applicationPath}/participants/patients/{patientId}/compositions
連携方式データ形式利用可能な接続先
REST APIJSON 形式(エンコーディング:utf-8)リモート

リクエスト(認証)

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

リクエスト(クエリ)

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

リクエスト(パスパラメータ)

No.項目名物理名属性Nullable設定要領
1患者 IDpatientIdstring-PLAT 共通 ID を URL エンコードを行い設定

リクエスト(Body)

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

サンプル(リクエスト)

{applicationPath}/participants/patients/11310000001000001/compositions

レスポンス

No.項目名物理名L1L2L3L4L5L6繰返し属性Nullableレスポンス設定要領
1検索結果searchResults-object-
2件数count-integer-検索結果件数
3リモート存在フラグremoteDataExists-boolean-ローカルにないデータがリモートに存在する場合、true
4取得データリストresultsarray-
5医療機関情報organization-string-OpenFRUCtoS の Oganization リソースの仕様に準拠する
6Composition 情報contents-string-OpenFRUCtoS の Oganization リソースの仕様に準拠する
エラー条件
システムエラー
・API 共通仕様に準拠
業務エラー
・なし

サンプル(レスポンス)

正常終了
{
  "searchResults": {
  "count": 1,
  "remoteDataExists": true,
  "results": [
    {
      "organization": {
        "fullUrl": "urn:uuid:4081daf3-d25d-42ce-9ff9-815d749b0e19",
        "resource": {
          "resourceType": "Organization",
          "id": "urn:uuid:4081daf3-d25d-42ce-9ff9-815d749b0e19",
          "text": {
            "status": "generated",
            "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>1310000001</li><li>クリニックX</li></ul></div>"
          },
          "identifier": [
            {
              "system": "http://hl7.jp/fhir/ePrescription/InsuranceMedicalInstitutionNo",
              "value": "1310000001"
            }
          ],
・・・省略・・・
        },
        "contents": {
          "fullUrl": "urn:uuid:24ada691-1828-4ff9-9694-9705e0ffbbe7",
          "resource": {
            "resourceType": "Composition",
            "id": "urn:uuid:24ada691-1828-4ff9-9694-9705e0ffbbe7",
            "text": {
              "status": "generated",
              "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">処方箋サンプル_患者1_クリニックX_医師A1</div>"
            },
            "identifier": {
              "system": "urn:oid:1.2.392.100495.20.3.11",
              "value": "11310000001000001000001"
            },
            "status": "final",
            "type": {
              "coding": [
                {
                  "system": "urn:oid:1.2.392.100495.20.2.11",
                  "code": "01",
                  "display": "処方箋"
                }
              ]
            },
            "subject": {
              "reference": "urn:uuid:75563685-6d0b-4c88-a735-50ff64507414",
              "display": "サンプル患者 1"
            },
            "date": "2021-03-01T09:00:00+09:00",
            "author": [
              {
                "reference": "urn:uuid:738ba3db-e282-4fce-b66d-9e054c7a1987",
                "display": "サンプル医師 A1"
              },
              {
                "reference": "urn:uuid:4081daf3-d25d-42ce-9ff9-815d749b0e19",
                "display": "クリニック X"
              }
            ],
            "title": "処方箋サンプル*患者 1*クリニック X\_医師 A1",
            "event": [
              {
                "code": [
                  {
                    "text": "処方箋交付"
                  }
                ],
                "period": {
                  "start": "2021-03-01",
                  "end": "2021-03-07"
                }
              }
            ],
            "section": [
              {
                "title": "処方指示 BODY",
                "entry": [
                  {
                    "reference": "urn:uuid:1a1fcd84-ba4c-456d-baf3-e3198e7c40fa"
                  }
                ]
              }
            ]
          }
        }
      }
    ]
  }
}
異常終了
{
"errorCode": "PLAT500",
"errorMessage": "例外内容"
}

備考

なし