검진

1. 건강검진 대상자 상세 조회nhis_edi.health_checkups.targets.detail

POSThttps://api.xdata.kr/v1/jobsX-Env-Scope: sandbox

샌드박스입니다. 실제 기관을 호출하지 않는 모의 응답이며 일일 한도가 없습니다.

GGAB_020 건강검진 대상자 상세(rows·business_datasets)를 조회합니다.

로그인을 먼저 호출합니다. 수신 문서 조회 옵션을 먼저 확인하면 조건을 정확히 지정할 수 있습니다. [국민건강보험공단 EDI 로그인]
success=false. result.data.error_code=GGAB_020_ROW_NOT_FOUND.
selector 생략 시 row_text_contains 기본 건강검진.

Request

변수명	필수	설명
Authorization	Y	API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. 형식 : Basic base64("{client_id}:{client_secret}") [참고] 인증
X-Env-Scope	Y	호출 환경입니다. `sandbox`샌드박스 — 모의 응답 `real_test`데모 — 하루 100 사용 토큰 `production`정식 — 유료 플랜 전용 [참고] 환경
Idempotency-Key	Y	재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. [참고] 재시도
Content-Type	Y	요청 본문 형식입니다. `application/json`고정값 (기본값)
X-Trace-Id	N	추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.

변수명	타입	길이	필수	설명
provider	string	-	Y	호출할 기관입니다. `nhis_edi`이 API 고정값 (기본값) 예시 : nhis_edi
action	string	-	Y	호출할 작업입니다. `nhis_edi.health_checkups.targets.detail`이 API 고정값 (기본값) 예시 : nhis_edi.health_checkups.targets.detail
account_link_id	string	36	조건부	등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다. 형식 : UUID v4 [참고] 자격증명 등록
params	object	-	Y	작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fields	object	-	N	민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. [참고] 암호화

변수명	타입	길이	필수	설명
row_index	number	-	N	이전 목록/검색 결과에서 선택할 행 번호
row_text_contains	string	-	N	선택할 행의 텍스트 포함값
cell_text_contains	string	-	N	선택할 행 셀 텍스트 포함값
row_key	string	-	N	이전 목록/검색 결과 row 식별키
notice_year_month	string	6	N	고지연월 형식 : YYYYMM
goji_round	string	-	N	고지차수 GOJI_CHASU
from_date	string	8	N	조회기간 시작일 미입력 시 오늘 기준 3개월 전. 시작일은 종료일의 6개월 전까지 형식 : YYYYMMDD
to_date	string	8	N	조회기간 종료일 미입력 시 오늘. 조회 기간은 최대 6개월(시작일은 종료일의 6개월 전까지) 형식 : YYYYMMDD

bash

curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: sandbox' \
  --header 'Idempotency-Key: demo-detail-001' \
  --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 확인.

순번	변수명	설명
	rows	건강검진 대상자 행 데이터 배열
	business_datasets	데이터셋 객체 (키=데이터셋명)
	row_count	반환 행 수
	summary	요약 합계
	business	사업장 기본정보
	download_contract	다운로드 기능 계약
	filters	실제 적용된 조회 조건
	insurance_symbols	보험별 사업장번호
	received_count	받은문서 결과 수
	sent_count	보낸문서 결과 수
	source_url	원천 NHIS EDI URL
	status_code	HTTP 또는 업무 상태 코드

json

// result.data
{
  "rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "business_datasets": {},
  "row_count": "...",
  "summary": {},
  "business": {},
  "download_contract": {},
  "filters": {},
  "insurance_symbols": {},
  "received_count": "...",
  "sent_count": "...",
  "source_url": "...",
  "status_code": "..."
}

순번	오류 코드	발생 조건
	PROVIDER_VALIDATION_ERROR	양식 불일치 — 고른 행이 이 조회의 서식이 아닙니다.