Skip to main content

PRV_PAT_002:【取得】PLAT患者情報(医療機関用)

処理概要

患者情報を確認する。

機能 IDAPI 論理名HTTP メソッドURI
PRV_PAT_002【取得】PLAT 患者情報(医療機関用)GET{applicationPath}/providers/patients/{patientId}
連携方式データ形式利用可能な接続先
REST APIJSON 形式(エンコーディング:utf-8)ローカル、リモート

リクエスト(認証)

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

リクエスト(クエリ)

クエリパラメータとパスパラメータが指定されていない場合は、一覧を返却する。

No.項目名物理名属性Nullable設定要領
1参照先locationstring参照先(患者管理)
2名前namestring漢字もしくはカナの前方一致検索
3住所addressstring住所を前方一致検索
4電話番号telecomstring電話番号を完全一致検索
5性別genderstring性別
6生年月日birthDatedate生年月日を完全一致検索(YYYY-MM-DD 形式)

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

No.項目名物理名属性Nullable設定要領
1患者 IDpatientIdstring

リクエスト(Body)

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

サンプル(リクエスト)

<パスパラメータ指定の場合>

  {applicationPath}/providers/patients/ClinicX_00002

<クエリパラメータ指定の場合>

  {applicationPath}/providers/patients?name=ヤマダダロウ&birthDate=1980-01-01

レスポンス

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

サンプル(レスポンス)

正常終了
{
"searchResults": {
"count": 1,
"results": [
{
"patient": {
"resourceType": "Patient",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">~~~</div>"
},
"identifier": [
{
"system": "https://www.plat.org/",
"value": "d2db2727-eb07-2e54-fcbd-5ed011499cb7"
},
{
"system": "urn:oid:1.2.392.100495.20.3.51.11310000001",
"value": "clinicX_p00001"
}
],
"active": true,
"name": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
"valueCode": "IDE"
}
],
"family": "山田",
"given": ["太郎"]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
"valueCode": "SYL"
}
],
"family": "ヤマダ",
"given": ["タロウ"]
}
],
"telecom": [
{
"system": "phone",
"value": "09099999999",
"use": "mobile"
}
],
"gender": "male",
"birthDate": "1974-12-25",
"deceasedBoolean": false,
"address": [
{
"use": "home",
"line": ["玉手町 23-10"],
"city": "柏原市",
"district": "大阪府",
"postalCode": "5820001"
}
]
}
}
]
}
}
異常終了
{
"errorCode": "PLAT500"
}

備考

なし