건강검진결과

POST

https://api.candiy.io/v1/nhis/checkup

건강보험공단 건강검진결과를 조회합니다.

해당 상품은 보안숫자 추가인증 요청이 진행되는 상품이며, 보안숫자 추가인증 처리는 딥러닝을 통해 학습된 AI엔진이 캡처 이미지를 인식하여 자동 진행합니다.
(단, 3회 실패 시 보안 숫자 수동 입력이 필요합니다.)

시간제한 (Timeout): 300초(sec)

입력부(input)

Key	Name	Type	Description
id *required	요청 식별 아이디(SSO(동일계정) 구분값)	String	사용자 계정을 식별할 수 있는 유일 값 세팅 (ex. 아이디 + UUID) 입력부 특이사항 참고, 사용자 임의지정
loginTypeLevel *required	간편인증 로그인 구분	String	1: 카카오톡, 3: 삼성패스, 4: 국민은행(국민인증서), 5: 통신사(PASS), 6: 네이버, 7: 신한은행(신한인증서), 8:토스, 9: 뱅크샐러드, 10: 하나은행(하나인증서), 11: NH모바일인증서
legalName *required	사용자 본명	String	사용자 본명
birthdate *required	사용자 생년월일	String	생년월일(YYYYMMDD)
phoneNo *required	사용자 명의 전화번호(핸드폰)	String	숫자없이 번호만 입력
telecom *required	통신사	String	0: SKT(SKT알뜰폰), 1: KT(KT알뜰폰), 2: LG U+(LG U+알뜰폰)
startDate *required	조회 시작 연도	String	yyyy 형식의 날짜 (default: 1년전)
endDate *required	조회 종료 연도	String	yyyy 형식의 날짜 (default: 올해)
inquiryType	조회 구분	String	0: 건강검진 일반조회 1: 건강검진 상세조회(PDF파일포함) 3: 상세조회(PDF파일포함)+문진결과(jsonData) (default: 0) 4: 문진결과(jsonData)

Example

입력부 특이사항

최근 10년간 국민건강보험공단에서 실시한 일반건강검진과 암검진, 구강검진 정보를 제공합니다.
건강검진한 병원에서 문진기록을 등록하지 않았거나 누락되었을 경우 문진결과가 제공되지 않을 수 있습니다.
id는 일정 시간(로그인 세션)동안 사용자 계정을 식별할 수 있는 유일 값을 지정해야 합니다. (예시: 아이디 + UUID)

추가인증 출력부(Output)

해당 상품은 추가인증이 필요합니다. 상태코드에 따라 추가인증 요청 상태를 확인할 수 있습니다.

Key

Name

Type

Description

status

상태코드

String

상태를 나타내는 상태코드 (success, error)

data

응답 값

Object

실제 응답 데이터가 들어가는 응답값

transactionId	트랜잭션 아이디	String	추가 인증 정보, 추가 요청에 사용
jobIndex	잡 인덱스	int	추가 인증 정보, 추가 요청에 사용
threadIndex	스레드 인덱스	int	추가 인증 정보, 추가 요청에 사용
multiFactorTimestamp	추가 요청 시간 Timestamp	int	추가 인증 정보, 추가 요청에 사용

Example

추가인증 입력부(Input)

인증 완료 후, 1차 인증에서 발급된 추가 인증 정보와 합께 추가 인증 확인 요청을 진행합니다. isContinue를 바꿔 추가 인증 확인을 중단할 수 있습니다.

Key

Name

Type

Description

isContinue *required

간편인증

String

0: cancel , 1: ok (default: 1)

multiFactorInfo

*required

추가 인증 정보

Object

1차 요청 응답 값

transactionId *required	트랜잭션 아이디	String	추가 인증 정보, 추가 요청에 사용
jobIndex *required	잡 인덱스	int	추가 인증 정보, 추가 요청에 사용
threadIndex *required	스레드 인덱스	int	추가 인증 정보, 추가 요청에 사용
multiFactorTimestamp *required	추가 요청 시간 Timestamp	int	추가 인증 정보, 추가 요청에 사용

Example

추가인증 처리 방식

[기본 요청]
요청 : 입력부(Input) : [기본 파라미터]
응답 : 추가인증 출력부(Output)
[간편인증 추가인증]
요청 : [기본 파라미터] + [간편인증 요청 파라미터]
추가인증 입력부(Input) : isContinue 입력
응답 : 출력부(Output)

추가인증 특이 사항

간편 인증 만료 시간은 4분 30초입니다.
간편 인증 시 인증을 완료하지 않은 경우 "Bad Request: 본인인증 절차가 완료되지 않았습니다. 먼저 본인인증을 완료해주세요." 오류가 발생합니다.

출력부(Output)

Key

Name

Type

Description

status

상태코드

String

상태를 나타내는 상태코드 (success, error)

data

응답 값

Object

실제 응답 데이터가 들어가는 응답값

patientName

검진대상

String

본인

overviewList

한번에보기 List

List

본인정보인 경우만 표시

checkupDate	검진년도	String	yyyy-mm-dd 형식의 날짜
height	신장	String
weight	체중	String
waists	허리둘레	String
BMI	체질량지수	String
vision	시력	String
hearing	청력	String
bloodPressure	혈압	String	수축기혈압/이완기혈압 (예시: "120/80")
proteinuria	요단백	String
hemoglobin	혈색소	String
fastingBloodGlucose	식전혈당	String
totalCholesterol	총콜레스테롤	String
HDLCholesterol	HDL콜레스테롤	String
triglyceride	트리글리세라이드	String
LDLCholesterol	LDL콜레스테롤	String
serumCreatinine	혈청크레아티닌	String
GFR	신사구체여과율(GFR)	String
AST	AST(SGOT)	String
ALT	ALT(SGPT)	String
yGPT	감마지피티(y-GPT)	String	(21.04.14) 대상기관 항목명 변경 : 감마지피티(y-GPT) -> 감마지티피(y-GTP)
chestXrayResult	폐결핵 흉부질환	String
osteoporosis	골다공증	String
evaluation	판정	String	정A, 정B, 주의, 의심, 고∙당, 유질, 일반, 직업, 단순, 휴무

referenceList

참고치 List

List

본인정보인 경우만 표시

refType	구분	String	ex) 단위, 정상A, 정상B, 질환의심
height	신장	String	ex) Cm
weight	체중	String	ex) Kg
waists	허리둘레	String	ex) Cm, 남90미만 여85미만
BMI	체질량지수	String	ex) kg/m2, 18.5-24.9
vision	시력	String
hearing	청력	String
bloodPressure	혈압	String	ex) mmHg
proteinuria	요단백	String	ex) 음성, 약양성
hemoglobin	혈색소	String	ex) g/dL
fastingBloodGlucose	식전혈당	String	ex) mg/dL
totalCholesterol	총콜레스테롤	String	ex) mg/dL
HDLCholesterol	HDL콜레스테롤	String	ex) mg/dL
LDLCholesterol	LDL콜레스테롤	String	ex) mg/dL
triglyceride	트리글리세라이드	String	ex) mg/dL
serumCreatinine	혈청크레아티닌	String	ex) mg/dL
GFR	신사구체여과율(GFR)	String	ex) mL/min
AST	AST(SGOT)	String	ex) U/L
ALT	ALT(SGPT)	String	ex) U/L
yGPT	감마지피티(y-GPT)	String	ex) U/L (21.04.14) 대상기관 항목명 변경 : 감마지피티(y-GPT) -> 감마지티피(y-GTP)
chestXrayResult	폐결핵 흉부질환	String	ex) 정상 비활동성, 정상 및 비활동성의외의자
osteoporosis	골다공증	String	ex) T-score-1이상, -1~2.5초과

resultList

결과 List

List

본인의 건강검진 결과정보 List

caseType	구분	String	0:본인검진
checkupType	검진종류	String	일반
checkupDate	검진일자	String	yyyy-mm-dd 형식의 날짜
organizationName	기관명	String	검진 기관
pdfData	원문 PDF	String	실제 PDF Data를 String 형태로 제공
questionnaire	문진정보	List	문진정보 List

Example

출력부 특이사항

건강검진 결과가 없는 경우 참고치만 제공합니다.