검진 - 국민건강보험공단 EDI
1. 건강검진 대상자 상세 조회nhis_ edi. health_ checkups. targets. detail
MCP 도구 이름 nhis_
POSThttps:// api. xdata. kr/ v1/ jobsX-Env-Scope: real_test
현재 혜택은 요금제에서 확인해 주세요. 현재 데모 정책과 계정의 남은 양을 확인해 주세요.
최근 석 달 안에 받은 건강검진 대상자 문서에서 검진년도와 통보일, 사무직과 비사무직 대상자 수, 사업장 주소와 연락처를 돌려줍니다.
- 로그인을 먼저 호출합니다. 수신 문서 조회 옵션을 먼저 확인하면 조건을 정확히 지정할 수 있습니다. [국민건강보험공단 EDI 로그인]
- success=false. result.data.error_code=GGAB_020_ROW_NOT_FOUND.
- success=false. result.data.error_code=GGAB_020_DATASET_EMPTY (business_datasets 비어 있음).행은 찾았고 상세 읽기도 끝났지만 응답에 업무 dataset 이 하나도 없을 때입니다.
- selector 생략 시 row_text_contains 기본 건강검진.
Request
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. | |
| X- | Y | 호출 환경입니다.
| |
| Idempotency- | Y | 재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. | |
| Content- | Y | 요청 본문 형식입니다.
| |
| X- | N | 추적 아이디입니다. 지정하지 않으면 서버가 발급합니다. |
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| provider | string | - | Y | 호출할 기관입니다.
| |
| action | string | - | Y | 호출할 작업입니다.
| |
| account_ | string | 36 | 조건부 | 등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명이 하나뿐일 때만 그것이 자동으로 선택됩니다. 둘 이상이면 대표로 지정한 것이 있어도 고르지 않으므로 직접 지정해야 합니다. 대표는 묶음 상품이 기관마다 자격증명을 고를 때만 씁니다. 등록한 자격증명이 없거나 하나를 고르지 못하거나 지정한 아이디를 쓸 수 없으면 접수 단계에서 400 VALIDATION_INVALID_FIELD 로 거절되고 작업은 만들어지지 않습니다. 이유와 할 일은 error.message 의 한국어 문장에 있습니다. | |
| params | object | - | N | 작업 파라미터입니다. 이 API 는 빈 객체로 호출할 수 있습니다. | |
| encrypted_ | object | - | N | 민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. |
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| row_ | number | - | N | 이전 목록/검색 결과에서 선택할 행 번호 | |
| row_ | string | - | N | 선택할 행의 텍스트 포함값 | |
| cell_ | string | - | N | 선택할 행 셀 텍스트 포함값 | |
| row_ | string | - | N | 이전 목록/검색 결과 row 식별키 | |
| notice_ | string | 6 | N | 고지연월 | |
| goji_ | string | - | N | 고지차수 GOJI_CHASU | |
| from_ | string | 8 | N | 조회기간 시작일. 미입력 시 오늘 기준 3개월 전. 시작일은 종료일의 6개월 전까지 | |
| to_ | string | 8 | N | 조회기간 종료일. 미입력 시 오늘. 조회 기간은 최대 6개월(시작일은 종료일의 6개월 전까지) |
curl --request POST \
--url 'https://api.xdata.kr/v1/jobs' \
--header 'Authorization: Basic {base64(client_id:client_secret)}' \
--header 'X-Env-Scope: real_test' \
--header "Idempotency-Key: detail-$(date +%s)-$RANDOM" \
--header 'Content-Type: application/json' \
--data '{
"provider": "nhis_edi",
"action": "nhis_edi.health_checkups.targets.detail",
"account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
"params": {}
}'Response
- rows·business_datasets 확인.
- 여러 JSON 타입이 함께 표시된 칸은 서버가 세부 타입을 고정하지 않는 기관 원문 또는 동적 값입니다.예시 값의 타입으로 단정하지 말고 실제 값의 타입을 확인해 주세요. null은 값이 비어 있다는 뜻이며, 필드 자체의 생략 여부는 필수 여부와 설명을 확인해 주세요.
| 순번 | 변수명 | 타입 | 설명 |
|---|---|---|---|
| success | boolean | 상세를 읽어 업무 dataset 을 받았는지 여부(찾는 항목이 없거나 응답에 업무 dataset 이 하나도 없으면 false) | |
| feature_ | string | 기능 식별자 | |
| phase | string | 단계(이 액션은 detail) | |
| workflow_ | string | 워크플로 단계 | |
| screen_ | string | 화면 식별자 | |
| route_ | string | 라우트 종류 | |
| row_ | number | 결과 행 수 | |
| rows | array | 업무 dataset 의 결과 행 목록 | |
| business_ | object | 시스템 dataset을 제외한 업무 dataset | |
| summary | object | 찾았는지와 dataset 별 행 수 요약 객체(matched, document_id, business_dataset_count, business_row_count, dataset_row_counts) | |
| source_ | object | 출처 증적 객체 | |
| error_ | string | number | boolean | object | array | null | 오류 코드(문제가 없으면 null, 항목을 못 찾으면 문서 번호가 앞에 붙은 ROW_NOT_FOUND 코드, 업무 dataset 이 없으면 문서 번호가 앞에 붙은 DATASET_EMPTY 코드) | |
| implementation_ | string | number | boolean | object | array | null | 구현 상태(문제가 없으면 null, 항목을 못 찾으면 lookup_row_not_found, 업무 dataset 이 없으면 lookup_dataset_empty) |
// result.data
{
"success": true,
"feature_name": "...",
"phase": "detail",
"workflow_step": "health_checkup_targets_loaded",
"screen_id": "...",
"route_kind": "live",
"row_count": 0,
"rows": [],
"business_datasets": {
"...": {
"rows": []
}
},
"summary": {
"matched": true,
"document_id": "GGAB_020",
"business_dataset_count": 1,
"business_row_count": 0,
"dataset_row_counts": {
"...": 0
}
},
"source_evidence": {
"screenshot": "...",
"xfdl": "...",
"sql_id": "...",
"page_link_id": "...",
"selected_row": {},
"detail_source": "...",
"detail_source_attempts": [],
"response_dataset_names": [
"..."
],
"dataset_row_counts": {
"...": 0
},
"source_summary": {}
},
"error_code": null,
"implementation_status": null
}| 순번 | 오류 코드 | 발생 조건 |
|---|---|---|
| PROVIDER_ | 읽기 미완료 — 행은 찾았지만 그 행의 내용을 끝까지 불러오지 못했습니다. 잠시 뒤 다시 시도합니다. | |
| PROVIDER_ | 양식 불일치 — 고른 행이 이 조회의 서식이 아닙니다. |