本文へ移動

マイナポータルAPI

連携情報一覧(PMH情報連携API)

公開日

更新日

PMH情報連携APIで連携可能な情報(令和8年6月時点)

PMH情報連携APIを利用して連携する情報(医療費助成情報を除く)は「PHRサービス提供者による健診等情報の取扱いに関する基本的指針」を遵守する必要があります。

マイナポータルの画面で表示する予防接種情報・母子保健情報は、優先的にPMHから取得し、PMHから得られない情報を各中間サーバから取得しています。

すべての連携情報の詳細内容を確認するには、以下のExcelファイルをダウンロードしてください。

すべての連携情報:
pmh-infomation-listXLSX 形式 / 33.2 KB

「PMH情報連携API」で連携できる情報は、以下の表で掲載しているものがすべてとなります。
記載されている情報に係るお問合せは、所管省庁へお願いいたします。

予防接種情報(v4)

Public Medical Hub上で管理される予防接種情報を取得、または予診票を入力し連携することができます。
取得、連携が可能な予防接種情報の詳細は次の表の通りです。

予防接種一覧情報の照会
No.登録・取得項目名項目説明
1取得予診票管理IDワクチン種別と回数で取りまとめたグループのID
2取得予防接種予定ID予防接種対象者が予定している予防接種のID
3取得勧奨実施日初回の勧奨実施日
4取得再勧奨実施日直近の勧奨実施日
5取得予診票表示開始日予診票の表示開始日
6取得予診票表示終了日予診票の表示終了日
7取得在籍フラグ「自治体に在籍中(未転出)」「自治体に未在籍(転出済)」など
8取得案内用URL-厚生労働省厚生労働省による予防接種全般の案内用URL
9取得案内用URL-各自治体各自治体による予防接種全般の案内用URL
10取得種別-予防接種管理番号予防接種の種別・回数を管理する番号
11取得種別-ワクチン通称一般的なワクチンの種別名
12取得種別-回数通称回数の通称
13取得種別-ワクチン種別ワクチンの種別を表すコード
14取得種別-期ワクチンの期
15取得種別-価ワクチンの価
16取得種別-回数ワクチンの接種回数
17取得種別-接種間隔-前回前回の接種年月日
18取得種別-接種間隔-前々回前々回の接種年月日
19取得種別-接種標準期間-年齢接種標準期間の年齢の開始/終了年月日
20取得種別-接種標準期間-年度接種標準期間の年度の開始/終了年月日
21取得種別-接種標準期間-日付接種標準期間の日付の開始/終了年月日
22取得種別-定期接種期間-年齢定期接種期間の年齢の開始/終了年月日
23取得種別-定期接種期間-年度定期接種期間の年度の開始/終了年月日
24取得種別-定期接種期間-日付定期接種期間の日付の開始/終了年月日
25取得種別-法定区分定期接種、または任意接種、または臨時接種
26取得種別-ワクチン適齢期ワクチンごとの接種適齢期を表す区分、「小児期」「その他」など
27取得種別-接種対象期間非表示フラグ定期接種期間/標準接種期間を、画面側で非表示にする設定値
28取得履歴-予防接種予定ID予防接種予定のID
29取得履歴-予防接種日予防接種日
30取得履歴-医師名医師名
31取得履歴-実施区分「個別」「集団」など
32取得履歴-接種区分「接種」「予診」など
33取得履歴-接種同意フラグ接種対象者から同意の有無
34取得履歴-接種結果接種したワクチンの内容
35取得履歴-特別の事情特別の事情を表す区分
36取得履歴-医療機関情報詳細医療機関の詳細
37取得削除フラグ削除フラグ
予診票一覧情報の照会
No.登録・取得項目名項目説明
38取得予診票管理IDワクチン種別と回数で取りまとめたグループのID
39取得予診票名予診票名
40取得回答許可フラグ予診票が回答可能か判定するフラグ
41取得回答状況予診票の回答状況、「未回答」「下書き」「回答済み」など
42取得接種希望予診票に対する接種希望回答、「未回答」「希望」「否希望」など
43取得医療機関代理入力同意医療機関の代理入力への同意、「未回答」「希望」「否希望」など
44取得チェック結果リスト-ワーニングコードチェック結果のワーニングコード
45取得チェック結果リスト-ワーニングメッセージチェック結果のワーニングメッセージ(複数あり)
予診票の回答結果の照会
No.登録・取得項目名項目説明
46取得予診票管理IDワクチン種別と回数で取りまとめたグループのID
47取得予診票名予診票名
48取得回答許可フラグ予診票が回答可能か判定するフラグ
49取得回答状況予診票の回答状況、「未回答」「下書き」「回答済み」など
50取得最終更新ページ番号最終更新ページ番号
51取得基本5情報氏名、氏名カナ、住所、生年月日、性別
52取得定義-予診票/問診票項目のグループのラベル紙面の予診票/問診票のページ毎のタイトルに相当するテキスト
53取得定義-予診票/問診票項目のサブグループーラベル紙面の予診票/問診票のサブグループのタイトルに相当するテキスト
54取得定義-予診票/問診票項目のサブグループー繰り返し上限回数紙面の予診票/問診票のサブグループの繰り返し上限回数
55取得定義-予診票/問診票項目のサブグループー項目紙面の予診票/問診票のサブグループの各項目
56取得回答-予診票/問診票項目マスタID予診票/問診票項目マスタID
57取得回答-繰り返しを許容する予診票/問診票項目の回答の組み合わせを表す連番回答の組み合わせを表す連番
58取得回答-回答結果回答結果
59取得直近の回答済予診回答-予診票/問診票項目マスタID直近の回答済予診回答の予診票/問診票項目マスタID
60取得直近の回答済予診回答-繰り返しを許容する予診票/問診票項目の回答の組み合わせを表す連番直近の回答済予診回答の組み合わせを表す連番
61取得直近の回答済予診回答-回答結果直近の回答済予診回答の回答結果
62取得前回の接種履歴情報-ワクチン通称前回の接種履歴の一般的なワクチンの種別名
63取得前回の接種履歴情報-回数通称前回の接種履歴の回数の通称
64取得前回の接種履歴情報-予防接種日前回の接種履歴の予防接種日
65取得前回の接種履歴情報-法定区分前回の接種履歴の法定区分
66取得前回の接種履歴情報-間隔情報前回の接種履歴の定められた間隔に関する情報
67取得接種完了ワクチン通称接種が完了しているワクチン通称(複数あり)
68取得チェック結果リスト-ワーニングコードチェック結果のワーニングコード
69取得チェック結果リスト-ワーニングメッセージチェック結果のワーニングメッセージ(複数あり)
予診票の回答結果の登録
No.登録・取得項目名項目説明
70登録処理種別固定値「RegisterQuestionnaireAnswer」を設定
71登録予診票管理IDワクチン種別と回数で取りまとめたグループのID
72登録回答状況予診票の回答状況、「下書き」「回答済み」など
73登録最終更新ページ番号最終更新ページ番号
74登録回答-予診票/問診票項目マスタID予診票/問診票項目マスタID
75登録回答-繰り返しを許容する予診票/問診票項目の回答の組み合わせを表す連番繰り返しを許容する予診票/問診票項目の回答の組み合わせを表す連番
76登録回答-回答結果回答結果
接種済証の照会
No.登録・取得項目名項目説明
77取得PDFファイル名PDFファイル名
78取得PDFデータ接種済証 (エンコード形式:base64)

母子保健情報(v3)

Public Medical Hub上で管理される妊娠健診情報、乳幼児健診情報を取得、または問診票を入力し連携することができます。
取得、連携が可能な母子保健情報の詳細は次の表の通りです。

妊婦健診一覧、過去の健診結果の照会
No.登録・取得項目名項目説明
1取得妊娠ID妊娠を管理するID
2取得妊娠届出日妊娠届出日
3取得妊婦健診一覧-妊婦健診管理ID妊婦健診管理ID
4取得妊婦健診一覧-健診実施日健診実施日
5取得妊婦健診一覧-在籍フラグ「自治体に在籍中(未転出)」「自治体に未在籍(転出済)」など
6取得妊婦健診一覧-健診担当者_[1~9]健診を実施した医師や自治体職員の氏名(最大9名分設定可能)
7取得妊婦健診一覧-医療機関情報健診を実施した医療機関情報
8取得妊婦健診一覧-案内用URL厚生労働省による妊婦健診全般の案内用URL
9取得妊婦健診一覧-案内用URL各自治体による妊婦健診全般の案内用タイトル
10取得妊婦健診一覧-結果妊婦健診項目の結果
妊婦健診の受診券情報の照会
No.登録・取得項目名項目説明
11取得受診券管理ID受診券管理ID
12取得受診券名称受診券名称
13取得自治体負担額自治体負担額
14取得受診券の有効期限受診券の有効期限
15取得備考自治体が定義した受診券の補足情報
16取得交付日交付日
17取得利用日利用日
18取得妊婦健診管理IDこの受診券が使用された妊婦健診のID
19取得健診項目-妊婦健診項目妊婦健診項目
里帰り情報の照会
No.登録・取得項目名項目説明
20取得自治体別妊娠管理ID自治体別の妊娠を管理するID
21取得定義-里帰り情報の質問項目のセクションのラベル里帰り情報の質問項目のセクションに相当するテキスト
22取得定義-里帰り情報の質問項目のセクションの繰り返し回数里帰り情報の質問項目セクションの繰り返し回数
23取得定義-里帰り情報の質問項目のリスト里帰り情報の質問項目のリスト
24取得回答-里帰り情報の質問項目ID質問項目を一意に特定するID
25取得回答-里帰り情報の回答結果里帰り情報の質問項目に対する回答結果
里帰り情報の登録・削除
No.登録・取得項目名項目説明
26登録処理種別固定値「RegisterHomecoming」を設定
27登録自治体別妊娠管理ID自治体別の妊娠を管理するID
28登録削除フラグ削除フラグ
29登録回答-里帰り情報の質問項目ID質問項目を一意に特定するID
30登録回答-里帰り情報の回答結果里帰り情報の質問項目に対する回答結果
流産情報の照会
No.登録・取得項目名項目説明
31取得自治体別妊娠管理ID自治体別の妊娠を管理するID
32取得流産死産日流産又は死産の診断を受けた日
流産情報の登録
No.登録・取得項目名項目説明
33登録処理種別固定値「RegisterPregnancyLoss」を設定
34登録自治体別妊娠管理ID自治体別の妊娠を管理するID
35登録流産死産日流産又は死産の診断を受けた日
母親に紐づく母子健康手帳情報の照会
No.登録・取得項目名項目説明
36取得母親に紐づく母子健康手帳情報リスト-妊娠ID妊娠を管理するID
37取得母親に紐づく母子健康手帳情報リスト-妊娠届出日自治体に妊娠を届出した日
38取得母親に紐づく母子健康手帳情報リスト-定義-母子健康手帳情報項目リスト-カテゴリID母子健康手帳の府令様式のカテゴリID
39取得母親に紐づく母子健康手帳情報リスト-定義-母子健康手帳情報項目リスト-カテゴリ名母子健康手帳の府令様式のカテゴリ名
40取得母親に紐づく母子健康手帳情報リスト-定義-母子健康手帳情報項目リスト-カテゴリ留意事項母子健康手帳カテゴリに関してユーザーに対するアドバイスなどを設定
41取得母親に紐づく母子健康手帳情報リスト-定義-母子健康手帳情報項目リスト-母子健康手帳情報項目リスト母子健康手帳情報項目のリスト
42取得母親に紐づく母子健康手帳情報リスト-回答-母子健康手帳情報項目リスト-カテゴリID回答した母子健康手帳の府令様式のカテゴリID
43取得母親に紐づく母子健康手帳情報リスト-回答-母子健康手帳情報項目リスト-母子健康手帳情報項目リスト回答した母子健康手帳情報項目のリスト
母親に紐づく母子健康手帳情報の登録
No.登録・取得項目名項目説明
44登録処理種別固定値「RegisterPrenatalMchbook」を設定
45登録妊娠ID妊娠を管理するID
46登録回答-母子健康手帳情報項目リスト回答した母子健康手帳情報項目のリスト
乳幼児健診一覧、過去の健診結果の照会
No.登録・取得項目名項目説明
1取得乳幼児健診管理ID乳幼児健診管理ID
2取得乳幼児健診名乳幼児健診名
3取得乳幼児健診対象標準期間接種標準期間の年齢、年月日
4取得回答許可フラグ問診票が回答可能か判定するフラグ
5取得回答状況回答状況、「未回答」「下書き」「回答済み」など
6取得健診実施日健診実施日
7取得勧奨実施日初回の勧奨実施日
8取得在籍フラグ「自治体に在籍中(未転出)」「自治体に未在籍(転出済)」など
9取得健診担当者_[1~9]健診を実施した医師や自治体職員の氏名(最大9名分設定可能)
10取得市区町村情報-地方公共団体コード乳幼児健診を受診した地方公共団体コード
11取得市区町村情報-都道府県名乳幼児健診を受診した都道府県名
12取得市区町村情報-市区町村名乳幼児健診を受診した市区町村
13取得医療機関情報-医療機関コード乳幼児健診を受診した医療機関コード
14取得医療機関情報-医療機関名乳幼児健診を受診した医療機関名
15取得会場情報-会場コード乳幼児健診を受診した会場コード
16取得会場情報-会場名乳幼児健診を受診した会場名
17取得案内用URL-厚生労働省厚生労働省による乳幼児健診全般の案内用URL
18取得案内用URL-自治体用各自治体による乳幼児健診全般の案内用URL
19取得案内用URL-自治体用各自治体による乳幼児健診別の案内用URL
20取得健診結果の一覧健診結果の一覧
乳幼児問診票の回答の照会
No.登録・取得項目名項目説明
21取得乳幼児健診管理ID乳幼児健診管理ID
22取得問診票名問診票名
23取得回答許可フラグ問診票が回答可能か判定するフラグ
24取得回答状況回答状況、「未回答」「下書き」「回答済み」など
25取得最終更新ページ番号最終更新ページ番号
26取得基本5情報氏名、氏名カナ、住所、生年月日、性別
27取得定義-問診票項目のグループのラベル紙面の問診票のページ毎のタイトルに相当するテキスト
28取得回答-問診票項目マスタID回答の問診票項目マスタID
29取得回答-繰り返しを許容する問診票項目の回答の組み合わせを表す連番回答の組み合わせを表す連番
30取得回答-回答結果回答結果
乳幼児問診票の回答結果の登録
No.登録・取得項目名項目説明
31登録処理種別固定値「RegisterChildQuestionnaireAnswer」を設定
32登録乳幼児健診管理ID乳幼児健診管理ID
33登録問診票の回答状況問診票の回答状況、「下書き」「回答済み」など
34登録最終更新ページ番号最終更新ページ番号
35登録回答-問診票項目マスタID問診票項目マスタID
36登録回答-繰り返しを許容する問診票項目の回答の組み合わせを表す連番繰り返しを許容する問診票項目の回答の組み合わせを表す連番
37登録回答-回答結果回答結果
子に紐づく母子健康手帳情報の照会
No.登録・取得項目名項目説明
38取得定義-母子健康手帳情報項目リスト-カテゴリID母子健康手帳の府令様式のカテゴリID
39取得定義-母子健康手帳情報項目リスト-カテゴリ名母子健康手帳の府令様式のカテゴリ名
40取得定義-母子健康手帳情報項目リスト-カテゴリ留意事項母子健康手帳カテゴリに関してユーザーに対するアドバイスなどを設定
41取得定義-母子健康手帳情報項目リスト-母子健康手帳情報項目リスト母子健康手帳情報項目のリスト
42取得回答-母子健康手帳情報項目リスト-カテゴリID回答した母子健康手帳の府令様式のカテゴリID
43取得回答-母子健康手帳情報項目リスト-母子健康手帳情報項目リスト回答した母子健康手帳情報項目のリスト
子に紐づく母子健康手帳情報の登録
No.登録・取得項目名項目説明
44登録処理種別固定値「RegisterChildMchbook」を設定
45登録回答-母子健康手帳情報項目リスト回答した母子健康手帳情報項目のリスト

医療費助成情報(v3)

Public Medical Hub上で管理される医療費助成情報を取得することができます。
取得可能な医療費助成情報の詳細は次の表の通りです。

医療費助成情報の照会
No.登録・取得項目名項目説明
1取得受給者証名称受給者証の名称を記載
2取得受給者証省略名称受給者証の省略名称を記載
3取得公費負担者番号公費負担者番号を記載
4取得公費受給者番号公費受給者番号を記載
5取得自己負担上限額管理票区分自己負担上限額管理票区分を記載
6取得自己負担上限額管理票区分名称自己負担上限額管理票区分の名称を記載
7取得詳細-項目名(1階層目)項目名(1階層目)
8取得詳細-値(1階層目)値(1階層目)
9取得詳細-値(1階層目)-項目名(2階層目)項目名(2階層目)
10取得詳細-値(1階層目)-値(2階層目)値(2階層目)
11取得詳細-値(1階層目)-値(2階層目)-項目名(3階層目)項目名(3階層目)
12取得詳細-値(1階層目)-値(2階層目)-値(3階層目)値(3階層目)
13取得当月の月額自己負担上限額・自己負担累積額-年月当月の年月を記載
14取得当月の月額自己負担上限額・自己負担累積額-月額自己負担上限額当月の月額自己負担上限額を記載
15取得当月の月額自己負担上限額・自己負担累積額-月額自己負担総額当月の月額自己負担総額を記載
16取得有効な受給者証がない閲覧期間内の履歴-自己負担上限額管理票区分有効な(連携対象の)受給者証がなく閲覧期間内の履歴が存在する場合の自己負担上限額管理票区分を記載
17取得有効な受給者証がない閲覧期間内の履歴-自己負担上限額管理票区分名称有効な(連携対象の)受給者証がなく閲覧期間内の履歴が存在する場合の自己負担上限額管理票区分の名称を記載
自己負担上限額管理票の照会
No.登録・取得項目名項目説明
18取得自己負担上限額管理票区分自己負担上限額管理票区分を記載
19取得自己負担上限額管理票区分名称自己負担上限額管理票区分の名称を記載
20取得履歴情報-月次履歴ID履歴情報の月次履歴IDを記載
21取得履歴情報-年月履歴情報の年月を記載
22取得履歴情報-都道府県名履歴情報の都道府県名を記載
23取得履歴情報-市区町村名履歴情報の市区町村名を記載
24取得履歴情報-月額医療費総額履歴情報の月額医療費総額を記載
25取得履歴情報-月額自己負担上限額履歴情報の月額自己負担上限額を記載
26取得履歴情報-月額自己負担総額履歴情報の月額自己負担総額を記載
27取得履歴情報-レコード-入力日履歴情報のレコードの入力日を記載
28取得履歴情報-レコード-入力ID履歴情報のレコードの入力IDを記載
29取得履歴情報-レコード-利用日履歴情報のレコードの利用日を記載
30取得履歴情報-レコード-医療機関コード履歴情報のレコードの医療機関コードを記載
31取得履歴情報-レコード-医療機関名履歴情報のレコードの医療機関名を記載
32取得履歴情報-レコード-医療費総額履歴情報のレコードの医療費総額を記載
33取得履歴情報-レコード-自己負担額履歴情報のレコードの自己負担額を記載
34取得履歴情報-レコード-訂正フラグ履歴情報のレコードの訂正フラグを記載
35取得履歴情報-レコード-備考履歴情報のレコードの備考を記載
36取得履歴情報-上限額超過情報-医療機関名履歴情報の上限額を超過した医療機関名
37取得履歴情報-上限額超過情報-超過額履歴情報の上限額を超過した金額

よくある質問・お問合せ

  • よくある質問をご確認ください。
  • 上記「よくある質問」で解決しない場合は、お問合せにてご連絡ください。

※お問合せをご利用いただく際、初めての方はアカウントの新規登録が必要です。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。

関連コンテンツ