버전: 0.68.0

연구 API 개요

참고: 이 문서에 설명된 모든 API는 dta-wir-medi-api 애플리케이션에 구현되어 있습니다. (Go)

논의 사항

현재 상황:

현재 연구 관련 API 총 12개가 research 도메인 하나의 문서(research-data.md)에 모두 작성되어 있습니다.
API는 크게 4개 그룹으로 분류됩니다:
- 환자 조회 및 관리 (5개)
- 환자 정보 수정 (2개)
- 액세스 코드 및 검증 (3개)
- 사이트 및 불성실 관리 (2개)

결정 필요 사항:

문서 분리 여부
- 현재의 단일 문서 구조를 유지할 것인가?
- 기능 그룹별로 별도 문서로 분리할 것인가? (예: research-patient.md, research-accesscode.md 등)

연구 API는 임상 연구 환자 관리, 데이터 수집, 분석 등을 담당하는 API 집합입니다.

API 엔드포인트	메서드	설명	문서
`/v1/research/patients`	GET	연구 환자 목록 조회	상세보기
`/v1/research/patients/options`	GET	환자 옵션 조회	상세보기
`/v1/research/patients`	POST	연구 환자 등록	상세보기
`/v1/research/patients/users/{userCycleId}`	POST	userCycleId로 연구 환자 생성	상세보기
`/v1/research/patients/{userCycleId}`	DELETE	연구 환자 제거	상세보기

API 엔드포인트	메서드	설명	문서
`/v1/research/patients/{userCycleId}/memo`	PATCH	환자 메모 수정	상세보기
`/v1/research/patients/{userCycleId}/randomization-code`	PATCH	무작위번호 수정	상세보기

API 엔드포인트	메서드	설명	문서
`/v1/research/accesscodes`	POST	액세스 코드 생성 및 알림 전송	상세보기
`/v1/research/patients/randomization-code/validate`	POST	무작위번호 검증	상세보기
`/v1/research/patients/remove/verify-password`	POST	환자 제거를 위한 비밀번호 검증	상세보기

API 엔드포인트	메서드	설명	문서
`/v1/research/sites`	GET	연구 사이트 목록 조회	상세보기
`/v1/research/patients/non-compliance`	POST	불성실 환자 등록/수정	상세보기

모든 연구 API는 유효한 JWT 액세스 토큰이 필요합니다.

request header

Authorization: Bearer {access_token}

권한: