研究ファイル形式 API

研究ファイル形式 (SFF)は、Veeva EDCおよびCDBシステムから臨床データをエクスポートするための標準化された方法です。SFFは研究ファイル形式 API を通じてアクセスされ、研究データ研究定義という2つの主要部分を含む単一のZIPパッケージとして提供されます。

SFFは、臨床および運用データの報告や、他のシステムとの統合に役立ちます。ZIPパッケージには、臨床データ、運用データ、および参照データを提供するマニフェストファイルとCSVが含まれています。マニフェストファイルには、研究定義研究データの関係が詳細に記載されています。

抽出タイプ:SFF抽出には、フルとインクリメンタルの2つのタイプがあります。SFFの完全抽出には、データ収集の開始から最新のSFF完全抽出まで、すべてのデータセットが含まれています。完全なSFF抽出は、ユーザーに24時間ごとにUTCの12:00に提供されます。臨床および運用データは、最新のSFF抽出以降の変更を反映するように、段階的に生成することができます。増分抽出は、研究ファイル形式 API ライセンスをお持ちのお客様のみご利用いただけます。リストパッケージ エンドポイントを使用する際には、フルまたはインクリメンタルを指定できます。

ライセンス: フルSFFパッケージにはVault CDMSライセンスが付属しており、Study in EDC Toolsで研究ごとに有効にすることができます。15分ごとに公開されるSFFインクリメンタルパッケージには、追加のライセンスが必要です。研究ファイル形式 API ライセンスを申請するには、Veevaサポートまでご連絡ください。

現在のSFFリリースには、Veeva以外のEDC(3PD)データは含まれていません。

前提条件

標準の CDMS スーパーユーザスタディロールを持つユーザは、デフォルトで下記のアクションを実行することができます。組織がカスタムロールを使用する場合、そのロールには以下の権限を付与することが必要です:

タイプ 権限ラベル 制御
機能権限 研究ファイル形式 API アクセス 研究ファイル形式 APIにアクセスし、使用する能力。

研究ファイル形式 APIアクセスは、デフォルトでAPIアクセスと制限付きデータアクセスを提供します。
機能権限 ワークベンチタブ* ワークベンチタブからデータワークベンチアプリケーションにアクセスする権限.

* ワークベンチタブの権限は、インクリメンタルエクスポートを使用するワークベンチスタディで研究ファイル形式 APIを使用する場合のみ必要です。

研究ファイル形式 API の有効化方法

Vaultで研究ファイル形式機能を有効にするには:

  1. 研究のために、ツール > EDCツール > スタディ設定 に移動します。 ツールドロップダウン

  2. 編集をクリックします。
  3. 研究ファイル形式 API を有効にするには、「はい」をクリックします。 研究設定で研究ファイル形式APIを学習

スタディ設定CDB増分を有効にするオプションが表示されている場合、SFF増分ライセンスを所有しており、CDMSスタディのいずれかに対して増分パッケージにアクセスできることを意味します。

SFFを初めて有効にする場合は、最初のSFFパッケージが完全に公開され、APIを通じて利用可能になるまで待ちます。この機能は、無効にした後に研究用に再度有効にした場合にも適用されます。

パッケージ構造

SFFパッケージはZIPファイル形式で提供されます。ZIPファイル内には、すべてのCSVファイルが格納された「data」というフォルダがあります。ZIPファイルのルートにある「manifest.json」ファイルには、パッケージの自己記述構造と研究デザイン情報が含まれています。

パッケージファイルのファイル名の形式は以下の通りです。

研究名_SFF_フル/増分_YYYY_MM_DD_HH_MM_SS

例えば、Natevba_SFF_Incremental_2024_08_16_00_30_00

名前に含まれるタイムスタンプは、パッケージの公開時刻を示しています。

完全抽出

ZIPパッケージの完全な抽出は24時間ごとに利用可能であり、次のような状況で下流システムの更新を支援するように設計されています。

  • 初めての研究でSFFを有効にする
  • 新しいスタディデザインの変更または展開中
  • データを完全に「リフレッシュ」して入れ替える
  • 再起動が必要な重大なエラーが発生しました。

スタディデザインデータ

マニフェストファイル内のスタディデザインデータは、常に完全なデータセットとして抽出され、インクリメンタルには抽出されません。抽出のたびに、最新のスタディデザインデータが取得されます。

ラベルとラベルのオーバーライド

ラベルおよびオーバーライドラベルには、最新のスタディデザインバージョンのデータが含まれます。

インクリメンタル抽出

適切なライセンスを所有するユーザーは、15 分ごとにインクリメンタル抽出を利用できます(詳細は上記のライセンスを参照してください)。増分抽出を使用する場合、最後の抽出と現在の抽出に変更がない場合、列見出しのみの空白ファイルとして生成されます。

ファイルを削除

増分抽出の参照データには、DELETES CSVファイルが含まれています。統合システムから削除すべき行を特定するために必要な、すべての削除済みデータが含まれています。

ROWID列

ROWID列はDELETESファイルを除くすべてのファイルに含まれており、更新および削除された行を特定するために使用できます。ROWID(行ID)は、一意のデータ行を作成するために使用される基礎となる識別子です。ROWID の構造はファイルによって異なります。

変更履歴の追跡

増分抽出または ZIP パッケージへの変更は、INSERT ではなく UPSERT (つまり、値がすでに存在する場合は行を更新し、存在しない場合は行を挿入する)として処理する必要があります。これに対する唯一の例外は、削除された行を追跡する DELETES ファイルです。

マニフェストファイル

JSONは、スタディデザインオブジェクトをスタディデータにマッピングするために使用できる構造化されたフォーマットです。Manifest.json ファイルにより、ユーザーはプログラムでデータを消費することができます。これは、スタディデータファイルの構造を定義し、スタディデザインを含みます。

マニフェストファイルのヘッダー情報は、以下の内容で構成されています。

  • スタディ名
  • ドキュメントの URL
  • SFF 版
  • 名前を抽出
  • 作成日時
  • パッケージ内のファイル数
  • 臨床データが徐々に生成されるかどうかに関わらず、
  • マニフェストが参照しているスタディデザインのバージョンは何ですか。

データは4つのJSONコードブロックに分割されています。

  • 運用データ
  • 参照データ
  • 試験データ
  • スタディデザイン

マニフェストファイル例

マニフェストファイルのサンプルをダウンロードします。

サンプルファイルをダウンロード

運用データおよび参照データ

運用データ(operational_data)は、システムファイルを含む運用データファイルを定義し、参照データ(reference_data)は、スタディに関連する参照データファイルを定義します。

試験データ

臨床データ(clinical_data)は、ファイル名、ソース、フォーム、およびカラムヘッダーで構成されています。

フィールド 説明
ファイル名 CSVファイルの名前(例:「prescreening.csv」)
ソース 試験データファイルのソース(例:「EDC」)
フォーム フォーム定義の名称
ファイル列の配列には、定義済みのヘッダー列と臨床アイテム列の両方が含まれます。各アイテムの列は、単一のアイテム定義を表します。

アイテム定義のメタデータはEDC Studioから取得されます。

アイテムには追加の属性がある場合があり、詳細は以下の「アイテムの追加属性」のセクションに記載されています。

追加のアイテム属性

以下は、マニフェストファイル内の試験データに関する追加のアイテム属性の例です。

  • 名前:属性の名前
  • External_id: 属性の外部ID
  • SDTM_name: SDTM名
  • データタイプV:EDCのデータタイプ(下記参照)に基づきます。
  • 長さ:テキスト、数値、コードリスト、および単位のアイテムタイプ用に設定済み
  • 精密さ:および単位のアイテムタイプ用に設定済み
  • v不明:日付または日時形式で入力できます。不明な部分を許可するアイテム定義V
  • マスク:通常、不明な日付と日時用に設定されています。
  • Item_type: 例えば、edc__v、derived__v、read_only__v
  • アイテムグループアイテムグループ定義名(複数可)
    • 品目定義品目グループ定義間で再利用される場合、すべての品目グループ定義フォーム定義にリストされている順番で配列に表示されます。
  • 制限付き:制限付きデータ、ブール値はtrueまたはfalseに等しい
  • コードリストコードリスト定義
  • 単位:単位定義名
データタイプ

データタイプアイテムの属性は、以下のEDCデータタイプに基づいています:

  • テキスト
  • コードリスト
  • url
  • ラベル
  • ブーリアン
  • 数字
  • 単位
  • 日付
  • 日時
  • 時間

スタディデザイン

スタディデザイン(study_design)ブロックには、以下のセクションが含まれます。

  • イベントグループ: スタディで構成されたすべての事象グループ定義を定義します。
  • イベント: スタディで構成されたすべての事象定義を定義します。
  • フォーム: スタディで構成されたすべてのフォーム定義を定義します。
  • アイテムグループ: スタディで構成されたすべてのアイテムグループ定義を定義します。
  • コードリスト: 試験データファイル(ラボ以外)で使用されるコードリスト定義をすべて定義します。
  • 単位: 試験データファイル(ラボ以外)で使用される単位定義をすべて定義します。
  • Subject_groups: スタディで構成されたすべての症例グループ定義を定義します。

試験データファイル(ラボ以外)で使用されるコードリスト定義をすべて定義します。各臨床ファイルには、イベントグループイベントフォーム定義の名前への参照キーがあります。これにより、臨床ファイルとスタディデザインオブジェクトの関係をマッピングすることができます。

マニフェストファイル内の列は順序どおりであることが保証されていません。しかし、プログラムで各カラムを対応するCSVカラムヘッダーにマッピングすることができます。これは順序通りに保存されます。

スタディデータファイル

SFFの研究データ部分も、試験データ、運用データ、参照データで構成されています。試験データファイルには、各被験者に関連する研究サイト国サイトイベントグループイベントフォームを示すヘッダー列が含まれています。フォーム上の各臨床アイテムには、主となる列の見出しの後に配置された、それぞれの列が設けられます。

研究データファイルは制限されたデータが含まれています。研究ファイル形式 API アクセス権限は、デフォルトで制限付きデータアクセス権限を付与します。

通常、イベントグループイベントフォームアイテムグループアイテム定義ステータスなどのオブジェクトには、ラベルではなく名前が使用されます。ラベルは、SFFの完全ZIPパッケージ内のLABELS CSVファイルに記載されています。IDは、データ行のユニークな識別子であるROWIDとして以外は、SFFでは表示されません。

試験データファイル

試験データファイルは、各フォーム定義ごとに1つのCSVファイルで構成されています。ファイルのタイトルはフォーム定義名と同じです。同じ名前のフォーム定義が複数ある場合、追加のフォーム定義には、ファイル名に _2、_3、などという文字列が追加されます。順序は、ソース名フォーム定義名の両方をアルファベット順にソートして決定されます。各ファイルには、特定のフォームインスタンスの試験データの行を表すレコードが含まれています。試験データには、ステータスが「提出済み」および「編集中(in_progress_post_submit__v)」のフォームが含まれます。

試験データヘッダー

試験データヘッダーは、フォーム内の試験データの階層を表す標準の列です。ヘッダーは、すべての試験データファイルで共通です。

列のリストは以下の通りです:

データタイプ 説明
スタディ名テキストスタディ名
SiteCountryテキストスタディ実施施設 3文字の国コード
SITENUMテキスト施設番号
SUBJIDテキスト被験者名
EGROUPNAMEテキスト事象グループ名
EGSEQ数字事象グループ順序
EventNameテキスト事象名
FORMNAMEテキストフォーム名
FSEQ数字フォーム順序
IGSEQ数字項目グループ順序
FORMSTATUSテキストフォームステータス
CREATEDDT日時フォームが作成された日時
FIRSTSUBMITDT日時フォームが最初に送信された日時
LASTSUBMITDT日時フォームが最後に送信された日時
FORMLASTMODDT日時フォームが最後に修正された日時
アイテム 列異なるアイテムカラム (フォームのアイテム数に合わせて拡張)
ROWWRITEDT日時ファイルに書き込まれた行の日時
ROWIDテキスト行 ID

試験アイテムデータ

試験アイテムは、各臨床ファイルの上部に列挙されたヘッダー列の後に表示され、それぞれのアイテム定義名がそれぞれの列に表示されます。必要に応じて動的にデータを追加します。例えば、アイテムグループが非反復の場合、対応するアイテムグループのシーケンスは臨床フォームに表示されません。

データタイプとフォーマット

データタイプ フォーマット 説明
テキスト文字列試験データアイテムについては、テキストをコードリストまたはURLデータタイプとして表現することができます。ステータスは名前と値で表現されます。例えば:submitted__v
数字定義された精度および/または長さ
日付システム日付はYYYY-MM-DD形式で表示されます。各臨床データには、派生/ISO8601日付と入力された生の日付の2つの列があります。各日付には2つの列があり、ISO8601形式とRAW形式が得られます。例えば: BIRTHDT: 1990-01-25 と BIRTHDT_RAW: 25-Jan-1990
日時システムのデータタイムは UTC タイムゾーンです。各臨床日時データには、派生/ISO8601日時と入力された生の日時という2つの列があります。 各データタイムには2つの列があり、ISO8601形式とRAW形式が得られます。例えば:LBDTC: 2021-01-01T12:00:00 および BIRTHDT_RAW: 01-Jan-2021 12:00:00:
TimeHH:mm:ss標準フォーマット、ISO8601
不明日付が不明な場合、派生した日付形式は2024-06-01、RAW形式の日付はUN-Jun-2024となります。

不明な日付を持つ日時については、派生した日時形式は2024-06-01T00:00:00、RAW日時形式はUN-Jun-2024 UN:UN:UNとなります。

月+日が不明な日付の場合、生成される日付フォーマットは2024-01-01、RAW日付フォーマットはUN-UNK-2024となります。

月+日が不明の datetime の場合、派生した datetime フォーマットは2024-01-01T00:00:00、RAW datetime フォーマットはUN-Jun-2024 UN-UNK-2024 UN:UN:UN となります。

不明な時間、派生した日付フォーマットは2024-06-02T00:00:00、RAW日付フォーマットは02-Jun-2024 UN:UN:UNです。
RAWデータと日時出力が未知の日付と日時を表現する方法。派生した日付と日時については、システムは不明な部分(月、日、または時刻)をUTCの1月1日00:00:00にデフォルト設定します。
ブーリアンTrue/False 
単位(アイテム)_UOM
(アイテム)_翻訳済み
(アイテム)_UOM_TRANSLATED
各ユニットアイテムには、ユニット値、翻訳値、翻訳されたユニット値があります。これらは、臨床アイテム名に接尾辞を付加することで示されます。測定単位(UOM)と翻訳された測定単位は、単位ラベルを表示します。
コードリスト(項目)
(アイテム)_DECODE
コード値はアイテム値です。DECODEまたはラベルは、アイテム名に接尾辞を追加して動的に追加される2番目の列です。例えば:ethnicity_DECODE

運用データおよびシステムデータセット

SFF ZIPパッケージには、試験データとともに、運用データを含む複数のシステムデータセットが含まれています。

システムデータセットは、特定のCDMSオブジェクトに関連するデータを提供し、スタディ内のすべての対象の進捗状況を追跡します。ZIPパッケージには自動的に次のファイルが含まれます。

  • SYS_EVENTS.csv
  • SYS_FORMS.csv
  • SYS_SUBJECTS.csv
  • SYS_ILB.csv
  • SYS_LINKS.csv
  • SYS_SITES.csv
  • QUERIES.csv
  • QUERY_MSGS.csv

SYS_EVENTS

SYS_EVENTSデータセットは、特定の症例に関連するイベントおよびイベントグループについて、現在のステータスと変更理由を記載しています。

次のイベントステータスが含まれています。

  • blank__v (空白)
  • submitted__v (提出済み)
  • in_progress__v (進行中)
  • planned__v (計画)
  • did_not_occur__v (発生せず)

SYS_EVENTS 列の一覧:

データタイプ 説明
スタディ名テキストスタディ名
SiteCountryテキストスタディ実施施設 3文字の国コード
SITENUMテキスト施設番号
SUBJIDテキスト被験者名
EGROUPNAMEテキスト事象グループ名
EGROUPORDER数字イベントグループ順序
EGSEQ数字事象グループ順序
EventNameテキスト事象名
EVENTORDER数字イベント順序
EVENTDT日付イベント日付
VISMETHODテキスト訪問方法
PLANNEDDT日付予定日
OVERDUEDT日付イベント期限日
EVENTSTATUSテキストイベントステータス
EVENTRESTRICTEDブーリアンイベント制限あり
CHANGEREASONテキストイベント変更理由
EXPFORMS数字Expected Number of Forms
FROZENブーリアンイベントフリーズ済み
FROZENDT日時日時イベントがフリーズしています。
LOCKEDブーリアンイベントロック済み
LOCKEDDT日時日時イベントがロックされています。
SIGNEDブーリアンイベントが署名済み
SIGNEDDT日時日時イベントに署名済み
EVENTDTLASTMODDT日時イベントの日付 最終更新日時
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

SYS_FORMS

SYS_FORMSデータセットは、症例データを含むすべてのフォームの概要を提供します。これには、フォームのステータス、SDVおよびDMRのフォームレベルのレビューステータス、フォームレベルのILB(故意の空白)情報が含まれます。

次のフォームステータスが含まれています:

  • blank__v (空白)
  • submitted__v (提出済み)
  • in_progress__v (進行中)
  • in_progress_post_submit__v (編集中)

SYS_FORMS 列のリスト:

データタイプ 説明
スタディ名テキストスタディ名
SiteCountryテキストスタディ実施施設 3文字の国コード
SITENUMテキスト施設番号
SUBJIDテキスト被験者名
EGROUPNAMEテキスト事象グループ名
EGSEQ数字事象グループ順序
EventNameテキスト事象名
FORMNAMEテキストフォーム名
FSEQ数字フォーム順序
FORMSTATUSテキストフォームステータス
FORMRESTRICTEDブーリアンフォーム 制限
CREATEDDT日時フォーム作成日
FIRSTSUBMITDT日時フォーム 最初送信日
LASTSUBMITDT日時フォーム 最終送信日
NUMSUBMITS数字フォーム送信数
OVERDUEDT日付フォーム 期限日
CHANGEREASONテキストフォーム変更理由
SDVOVRPLANテキストSDV プランの上書き
SDVREQブーリアン必須 SDV
SDVCOMPブーリアンSDV 完了
FIRSTSDVDT日時初期 SDV 日付
SDVCOMPDT日時SDV完了日時
SDVUSERMODDT日時SDVユーザー 変更日
DMROVRPLANテキストDMR プランの上書き
DMRREQブーリアン必須 DMR
DMRCOMPブーリアンDMR 完了
FIRSTDMRDT日時初期 DMR 日付
DMRCOMPDT日時DMR完了日時
DMRUSERMODDT日時DMRユーザー 変更日
機能停止ブーリアンフォームフリーズ済み
FROZENDT日時日時フォームがフリーズ
ロック済みブーリアンフォームロック済み
LOCKEDDT日時日時フォームがロックされています。
SIGNEDブーリアンフォーム署名済み
SIGNEDDT日時日時フォームに署名済み
ILBブーリアン意図的に空欄のままにしておくフォーム
ILBREASONテキストフォームの意図的に空白のままにされている理由
FORMLASTMODBYテキストフォーム 最終更新者
FORMLASTMODDT日時フォーム 最終変更日時
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

SYS_SUBJECTS

SYS_SUBJECTSデータセットには、研究内の症例に関するデータが含まれています。

SYS_SUBJECTS 列の一覧:

データタイプ 説明
スタディ名テキストスタディ名
SiteCountryテキストスタディ実施施設 3文字の国コード
SITENUMテキスト施設番号
SUBJIDテキスト被験者名
EGROUPNAMEテキスト事象グループ名
EGSEQ数字事象グループ順序
EventNameテキスト事象名
FORMNAMEテキストフォーム名
FSEQ数字フォーム順序
FORMSTATUSテキストフォームステータス
FORMRESTRICTEDブーリアンフォーム 制限
CREATEDDT日時フォーム作成日
FIRSTSUBMITDT日時フォーム 最初送信日
LASTSUBMITDT日時フォーム 最終送信日
NUMSUBMITS数字フォーム送信数
OVERDUEDT日付フォーム 期限日
EVDTTOSUB数字イベント開催日から提出までの日数
CHANGEREASONテキストフォーム変更理由
SDVOVRPLANテキストSDV プランの上書き
SDVREQブーリアン必須 SDV
SDVCOMPブーリアンSDV 完了
FIRSTSDVDT日時初期 SDV 日付
SDVCOMPDT日時SDV完了日時
SDVUSERMODDT日時SDVユーザー 変更日
SUBTOSDV数字SDV への送信からの日数
DMROVRPLANテキストDMR プランの上書き
DMRREQブーリアン必須 DMR
DMRCOMPブーリアンDMR 完了
FIRSTDMRDT日時初期 DMR 日付
DMRCOMPDT日時DMR完了日時
DMRUSERMODDT日時DMRユーザー 変更日
SUBTODMR数字DMR への送信からの日数
機能停止ブーリアンフォームフリーズ済み
FROZENDT日時日時フォームがフリーズ
SUBTOFROZEN数字申請から凍結までの日数
ロック済みブーリアンフォームロック済み
LOCKEDDT日時日時フォームがロックされています。
SUBTOLOCKED数字提出からロックまでの日数
SIGNEDブーリアンフォーム署名済み
SIGNEDDT日時日時フォームに署名済み
SUBTOSIGNED数字提出から署名までの日数
ILBブーリアン意図的に空欄のままにしておくフォーム
ILBREASONテキストフォームの意図的に空白のままにされている理由
FORMLASTMODBYテキストフォーム 最終更新者
FORMLASTMODDT日時フォーム 最終変更日時
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

SYS_ILB

SYS_ILBデータセットには、すべてのスタディ実施施設における各症例の特定のフォーム上の関連アイテムの「故意に未記入のままにされたデータ」が含まれています。提出済みステータスのデータが含まれています。

SYS_ILB 列のリスト:

データタイプ 説明
スタディ名テキストスタディ名
SiteCountryテキストスタディ実施施設 3文字の国コード
SITENUMテキスト施設番号
SUBJIDテキスト被験者名
EGROUPNAMEテキスト事象グループ名
EGSEQ数字事象グループ順序
EventNameテキスト事象名
FORMNAMEテキストフォーム名
FSEQ数字フォーム順序
IGROUPNAMEテキスト項目グループ名
IGSEQ数字項目グループ順序
ITEMNAMEテキスト項目名
ILBREASONテキスト未実施理由
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

SYS_LINKSデータセットには、フォーム間リンクのために試験データに追加されたリンクに関する情報が含まれています。

SYS_LINKS 列のリスト:

データタイプ 説明
スタディ名テキストスタディ名
SiteCountryテキストスタディ実施施設 3文字の国コード
SITENUMテキスト施設番号
SUBJIDテキスト被験者名
EGROUPNAMEテキスト事象グループ名
EGSEQ数字事象グループ順序
EventNameテキスト事象名
FORMNAMEテキストフォーム名
FSEQ数字フォーム順序
LINKIDテキストリンク Vault ID
LINKCREATEDBYテキストリンク作成者
LINKCREATEDDT日時リンク作成日時
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

SYS_SITES

このデータセットには、スタディ実施施設に関するデータが含まれています。

SYS_SITES列の一覧:

データタイプ 説明
スタディ名テキストスタディ名
SiteCountryテキストスタディ実施施設 3文字の国コード
SITENUMテキスト施設番号
SITENAMEテキスト施設名
SITEPIテキスト施設試験責任医師長
SITESTATUSテキスト施設ステータス
SITETIMEZONEテキスト施設タイムゾーン
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

クエリ

クエリファイルには、スタディで作成された各クエリの記録が含まれています。また、クエリがいつ開かれ、いつ閉じられ、誰が作成したかなどの運用指標も含まれています。このデータを使用して、下流のレポートや分析用の追加指標を計算することができます。

クエリファイルのカラムのリスト:

データタイプ 説明
スタディ名テキストスタディ名
SiteCountryテキストスタディ実施施設 3文字の国コード
SITENUMテキスト施設番号
SUBJIDテキスト被験者名
EGROUPNAMEテキスト事象グループ名
EGSEQ数字事象グループ順序
EventNameテキスト事象名
EVENTDT日付イベント日付
EVENTSTATUSテキストイベントステータス
FORMNAMEテキストフォーム名
FSEQ数字フォーム順序
IGROUPNAMEテキスト項目グループ名
IGSEQ数字項目グループ順序
ITEMNAMEテキスト項目名
QUERYNAMEテキストクエリ名
QUERYIDテキストクエリ ID
ORIGINSYSテキスト元のシステム
ORIGINIDテキストIDの生成元
ORIGINNAMEテキスト発案者名
QUERYSTATUSテキストクエリステータス
QUERYTYPEテキストクエリタイプ
QUERYRESTRICTEDブーリアン制限ありクエリ
MANUALQUERYブーリアン手動またはシステムクエリ
RULEDEFテキストルール 定義 名
TRIGIDテキストトリガー名
FIRSTQUERYMSGテキスト最初のクエリメッセージ
QUERYTEAMテキストクエリチーム
QUERYROWEXTERNALIDテキストクエリ行外部ID(Veeva EDC以外のデータに対するクエリで設定されている場合、入力されます)
QUERYCREATEDBYテキストクエリ作成者
QUERYCREATEDDT日時クエリ作成日時
QUERYLASTCLOSEDDT日時クエリ 最後のクローズ日時
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

クエリメッセージ

クエリメッセージファイルは、特定のクエリに関連する各メッセージを表示することで、クエリファイルを補完します。クエリIDをキーとして使用して、クエリファイルとクエリメッセージファイルの間の対応付けを行うことができます。

クエリメッセージファイルの列の一覧:

データタイプ 説明
スタディ名テキストスタディ名
SiteCountryテキストスタディ実施施設 3文字の国コード
SITENUMテキスト施設番号
SUBJIDテキスト被験者名
QUERYNAMEテキストクエリ名
QUERYIDテキストクエリ ID
QUERYMSGSTATUSテキストメッセージステータスクエリ
RESTRICTEDMSGブーリアン制限付きクエリメッセージ
QUERYMSGテキストクエリメッセージ
QUERYMSGBYテキストメッセージ作成者
QUERYMSGDT日時問い合わせメッセージ日付
QUERYTEAMテキストメッセージを作成したチームに問い合わせる
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

参照データファイル

参照データには、ラベル、表示上書きラベル、削除、ローカルラボユニット定義、ローカルラボコードリスト定義のファイルが含まれています。

DELETESファイルに関する情報は、「増分抽出」を参照してください。

ラベル

ラベルファイルには、イベントグループイベントフォームアイテムグループアイテムなどの研究定義オブジェクトに関連するラベルが表示されます。このファイルには最新のスタディデザインバージョンのラベルが含まれており、SFFのZIPパッケージのフルバージョンでのみ入手可能です。ラベルは、使用中の保管庫で設定されている言語で表示されます。

ラベルファイルの列の一覧:

データタイプ 説明
名前テキストオブジェクト名
ラベルテキストオブジェクトラベル
タイプテキストオブジェクトタイプ(イベントグループ、イベント、フォーム、アイテムグループ、アイテムなど)
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

ラベルファイルの例:

名前 ラベル タイプ ROWWRITEDT ROWID
事前審査事前審査事象グループ2024-06-01T21:06:00Zprescreening_eventgroup
visit1来院 1事象2024-06-01T21:06:00Zvisit1_event
physical_exam健康診断フォーム2024-06-01T21:06:00Zphysical_exam_form
ig_prescreen事前審査項目グループ2024-06-01T21:06:00Zig_prescreen_itemgroup
dob生年月日項目2024-06-01T21:06:00Zdob_item
in_progress__v進行中event_status2024-06-01T21:06:00Zin_progress__v_event_status
submitted__v送信済みevent_status2024-06-01T21:06:00Zsubmitted__v_event_status
blank__v空白event_status2024-06-01T21:06:00Zblank__v_event_status
did_not_occur__v未実施 event_status2024-06-01T21:06:00Zdid_not_occur__v_event_status
planned__v予定event_status2024-06-01T21:06:00Zplanned__v_event_status

ROWIDは、上記の例では連結された文字列である可能性があります。

ラベルを上書き

オーバーライドラベルファイルの列の一覧:

データタイプ 説明
SRCDEFINITIONテキストソース(オブジェクト)定義名
SRCLABELTYPEテキストソース(オブジェクト)ラベルタイプ:イベントグループなど
TARGETDEFINITIONテキストターゲット(オブジェクト)定義名
TARGETLABELTYPEテキスト対象(オブジェクト)ラベルの種類:イベントなど
TARGETOVERRIDELABELテキストターゲット(オブジェクト) オーバーライドラベル
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

ローカルラボユニット

ローカルラボユニットファイルは、ローカルラボモジュールに関連するユニット定義を表示します。

ラボユニットファイルの列の一覧:

データタイプ 説明
UNITNAMEテキスト単位 定義 名
UNITEXTIDテキスト単位定義外部 ID
UNITTYPEテキスト単位定義タイプ
UNITITEMCODEテキスト単位項目定義コーダー
UNITITEMDECODEテキスト単位アイテム定義コーダー
UNITITEMEXTIDテキスト単位アイテム定義外部 ID
UNITITEMABBRテキスト単位アイテム定義略称
UNITITEMSTANDARDブーリアン単位アイテム定義標準
UNITITEMCONVテキスト単位 項目 定義 変換式
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

ローカルラボコードリスト

ローカルラボコードリストファイルは、ローカルラボモジュールに関連するコードリスト定義を表示します。

ロケールラボユニットファイルの列の一覧:

データタイプ 説明
CODELISTNAMEテキストコードリスト 定義 名
CODELISTEXTIDテキストコードリスト定義外部 ID
CODELISTITEMCODEテキストコードリスト項目定義コーダー
CODELISTITEMDECODEテキストデコードリスト項目定義コーダー
ROWWRITEDT日時行がファイルに書き込まれた日時
ROWIDテキスト行 ID

エラー処理に関する情報は、CDMS開発者ポータルのCDB固有のエラーセクションを参照してください。