스터디 파일 형식 API에 대한 팁 및 모범 사례
이 페이지에는 스터디 파일 형식 API를 사용하기 위한 몇 가지 팁과 모범 사례가 나열되어 있습니다.
프로그래밍 방식 사용량 사용
SFF API는 파일을 수동으로 읽는 것이 아니라 프로그래밍 방식으로 액세스하도록 설계되었습니다. SFF 패키지에 포함된 매니페스트 파일은 각 열에 대한 CSV 파일 및 메타데이터를 구성하며, 각 스터디 데이터 섹션에는 자체 블록이 있습니다. 스터디 디자인 섹션은 매니페스트 파일 내에서 별도로 구성됩니다. 아이템 정의 데이터는 각 아이템이 CSV 파일의 열이기 때문에 임상 데이터 섹션에 포함됩니다.
또한 SFF 열 헤더는 기계가 읽을 수 있도록 설계되었습니다. JSON 형식의 속성은 특정 순서로 유지되지 않으므로 프로그래밍 방식으로 열을 구문 분석하는 것이 중요합니다. 이것의 예외는 임상 데이터 섹션의 itemgroups 배열 속성인데, 이 경우에는 각 항목 정의가 항목 그룹 내에서 표시되는 순서가 유지됩니다.
효율적인 변경 사항 추적
SFF의 각 파일에는 각 행의 고유 식별자 역할을 하는 ROWID 열이 포함되어 있습니다. 이 열을 사용하여 행 수준 변경 내용을 추적할 수 있습니다.
- 각 변경 사항을 UPSERT로 처리: 행이 증분 SFF 파일에 나타나면 해당 행에 대한 추가 또는 수정을 나타냅니다.
- DELETES CSV 파일은 가장 최근의 변경 증분에서 삭제된 모든 행을 나열합니다.
오류로 인해 증분 패키지가 변경 사항을 캡처하지 못하는 경우 패키지는 계속 생성되지만 비어 있습니다. 이는 파일에 변경 사항이 없기 때문에 패키지가 비어 있는 것과 다릅니다.
생성일 활용
파일 이름에는 정의된 각 증분에 대해 게시된 시간(증분 추출의 경우 15분마다, 전체 추출의 경우 24시간마다)이 포함됩니다. API에서 반환된 created_date 순서대로 SFF ZIP 패키지를 사용하는 것이 가장 좋습니다. 특히 증분 SFF 사용량에 created_date를 사용하면 다운스트림 시스템에 변경 사항을 적용하여 동기화 상태를 유지하는 순서를 이해하는 데 도움이 됩니다. 예를 들어 created_date는 00:30(UTC)쯤일 수 있지만 게시된 시간은 00:45로 표시될 수 있습니다. 이는 시스템이 00:30에서 00:45 사이의 시간 간격을 캡처했기 때문입니다.
설정 및 새로 고침을 위해 전체 SFF 패키지 검색
처음 활성화할 때 전체 SFF 패키지를 검색합니다. 증분 SFF도 활성화된 경우 처음에는 전체 패키지만 검색해야 합니다. 그런 다음, 데이터가 동기화되지 않아 전체 새로 고침이 필요한 경우 전체 패키지를 다시 검색할 수 있습니다.