환자 메모 관리 API

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

개요

환자 메모 관리 API는 의료진이 환자에 대한 메모를 작성하고 업데이트하는 기능을 제공합니다.

주요 기능

• 환자 메모 업데이트: 환자 메모 생성 및 업데이트 (Upsert)

[PUT] /v1/users/{userId}/memo - 환자 메모 업데이트

환자 메모 업데이트

특정 환자의 메모를 생성하거나 업데이트합니다. 메모가 없으면 새로 생성하고, 이미 있으면 기존 메모를 업데이트합니다 (Upsert).

• HTTP Method: PUT
• 인증: 액세스 토큰 (accessToken) 필요

[클라이언트 수정 필요]
asis: /v1/patients/user-cycles/{userCycleId}/memo
tobe: /v1/users/{userId}/memo

Headers

Header	Type	Description	Required
Authorization	Bearer {accessToken}	사용자 인증을 통해 발급받은 액세스 토큰 입니다.	✔
Content-Type	application/json	요청 본문 형식	✔

Path Parameters

필드	타입	설명	Required
userId	number	사용자 ID	✔

Request Body

필드	타입	설명	Required
memo	string	메모 내용	✔

Request Body 예시

{
  "memo": "환자가 수면제 복용을 중단했습니다. 지속적인 관찰이 필요합니다."
}

Responses

Http Status Code	설명	Error Code(s)
200 OK	메모 업데이트 성공	-
400 Bad Request	잘못된 요청	BAD_REQUEST (40000)
401 Unauthorized	인증 실패	UNAUTHORIZED (40100)
404 Not Found	환자 미발견	NOT_FOUND (40400)
500 Internal Server Error	서버 내부 오류	INTERNAL_SERVER_ERROR (50000)

200 OK - 성공

{
  "success": true
}

필드	타입	설명
success	boolean	성공 여부 (true)

Upsert 동작:

• 해당 userId 대한 메모가 없으면 새로 생성
• 메모가 이미 있으면 기존 메모를 새로운 내용으로 업데이트

400 Bad Request - 잘못된 요청

{
  "status": 400,
  "code": 40000,
  "message": "메모 내용이 비어있습니다."
}

발생 가능한 에러 메시지:

• "메모 내용이 비어있습니다." - memo 필드가 비어있거나 누락됨
• "요청한 정보가 유효하지 않습니다." - 유효하지 않은 userId

401 Unauthorized - 인증 실패

{
  "status": 401,
  "code": 40100,
  "message": "UNAUTHORIZED"
}

액세스 토큰이 유효하지 않거나 만료된 경우 발생합니다.

404 Not Found - 환자 미발견

{
  "status": 404,
  "code": 40400,
  "message": "환자 정보를 찾을 수 없습니다."
}

해당 userCycleId에 해당하는 환자가 존재하지 않는 경우 발생합니다.

500 Internal Server Error - 서버 내부 오류

{
  "status": 500,
  "code": 50000,
  "message": "INTERNAL_SERVER_ERROR"
}

사용 사례

메모 작성 예시

초기 진료 메모:

{
  "memo": "초진 상담 완료. 환자는 만성 불면증을 호소하며, 수면제 복용 이력이 있습니다. CBT-i 프로그램 시작을 권장했습니다."
}

경과 관찰 메모:

{
  "memo": "Day 15 진행 중. 수면 효율이 80%에서 90%로 개선되었습니다. 환자의 순응도가 높아 치료 진행이 원활합니다."
}

특이사항 메모:

{
  "memo": "환자가 개인 사정으로 인해 1주일간 앱 사용을 중단했습니다. 재개 후 수면 패턴 변화를 면밀히 모니터링 필요."
}

권한 및 보안

• 접근 권한: 해당 환자를 담당하는 의료진 또는 관리자만 메모를 작성/수정할 수 있습니다.
• 개인정보 보호: 메모에는 민감한 의료 정보가 포함될 수 있으므로, GDPR 및 개인정보보호법을 준수해야 합니다.
• 감사 추적: 메모의 생성 및 수정 이력이 시스템에 기록됩니다.

메모 작성 가이드라인

1. 객관적 기록: 관찰한 사실과 데이터를 객관적으로 기록합니다.
2. 간결성: 핵심 내용을 간결하게 작성합니다.
3. 날짜 명시: 특정 사건이나 관찰 내용에는 날짜를 명시합니다.
4. 전문 용어 사용: 의학적으로 정확한 용어를 사용합니다.
5. 개인정보 주의: 불필요한 개인 식별 정보는 기록하지 않습니다.