API docs by Redocly

自治体検診対象者情報登録API（自治体） (1.0.0)

Download OpenAPI specification:

自治体検診

postMunicipalCheckupRegistrationTasks

リクエストデータを基に、自治体検診対象者情報を登録する。

Authorizations:
bearerAuth
Request Body schema: application/json
required

変更区分。 使い分けは以下の通り。

コード値 利用するSCHEMA 使い分け
1（登録/更新） requestAtRegisterOrUpdate ・自治体検診対象者として自治体に登録されたことを契機に、PMHに自治体検診対象者情報を新規に登録する。その際、マイナンバー等を基に検索を行い、既に自治体内に当該自治体検診対象者のデータが存在する場合、更新する。
・想定される利用ケースは以下の通り。
　(1)自治体検診の対象者情報を登録したい場合
　(2)対象者情報を更新したい場合（自治体内転居による住所変更、氏名変更等）
　(3)対象者の自治体検診を追加・削除したい場合
　(4)対象者の検診実施日を追加・削除をしたい場合
2（削除） requestAtDelete ・自治体検診対象者として自治体から消除されたことを契機に、PMHに登録している自治体検診対象者情報を消除する。また、「消除の異動日」を更新したい場合は、再送することで更新する。
・想定されるケースは以下の通り。
　(1)「転出」および「死亡」した場合
　(2)誤登録をした場合
Array
One of
modificationSeg
required
string
Value: "1"

変更区分
自治体から今回連携されるデータが前回連携時と比較してどのような変更なのかを表す。

myNumber
required
string = 12 characters ^[0-9]+$

個人番号（マイナンバー）
■バリデーション
最小桁数:12桁 最大桁数:12桁 文字種:半角数字

municipalityIdentityKey
required
string <= 100 characters

自治体別本人キー
自治体内で住民を一意に特定できる情報

checkupTargetNumber
required
string = 64 characters ^[a-zA-Z0-9]+$

検診対象者番号

required
object (basicFiveInfoForResister)

基本５情報

isNotDisclosed
required
boolean

不開示フラグ
対象者の情報を不開示にするか表す。
DVフラグ（支援措置区分）に変わるフラグで、より広い意味での活用を想定したフラグ

Array of objects

自治体検診情報 実施された検診分配列を設定する

Responses

Request samples

Content type
application/json
Example
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "processNumber": "G0020230401120000000000"
}