subject fields
The subject endpoint uses a subject attributes first schema, where all metadata is nested under subject values.
Column names that have a . between words denote that the term after the . is a nested field. Nesting structure can be more easily browsed in the subject JSON schema
| column_name | description | data_type |
|---|---|---|
| id | The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is unique within a given system. The identified entity may have a different 'id' in a different system. | STRING |
| identifier | A 'business' identifier for the entity, typically as provided by an external system or authority, that persists across implementing systems (i.e. a 'logical' identifier). Uses a specialized, complex 'Identifier' data type to capture information about the source of the business identifier - or a URI expressed as a string to an existing entity. | ARRAY |
| identifier.system | The system or namespace that defines the identifier. | STRING |
| identifier.value | The value of the identifier, as defined by the system. | STRING |
| species | nan | STRING |
| sex | nan | STRING |
| race | nan | STRING |
| ethnicity | nan | STRING |
| days_to_birth | Per GDC Dictionary, number of days between the date used for index and the date from a person's date of birth represented as a calculated negative number of days. | INT64 |
| subject_associated_project | nan | ARRAY |
| vital_status | nan | STRING |
| age_at_death | nan | INT64 |
| cause_of_death | nan | STRING |
| Files | List of ids of File entities associated with the Patient | ARRAY |
| ResearchSubject | A research subject is the entity of interest in a specific research study or project, typically a human being or an animal, but can also be a device, group of humans or animals, or a tissue sample. Human research subjects are usually not traceable to a particular person to protect the subject’s privacy. This entity plays the role of the case_id in existing data. | ARRAY |
| ResearchSubject.id | The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is unique within a given system. The identified entity may have a different 'id' in a different system. For CDA, this is case_id. | STRING |
| ResearchSubject.identifier | A 'business' identifier for the entity, typically as provided by an external system or authority, that persists across implementing systems (i.e. a 'logical' identifier). Uses a specialized, complex 'Identifier' data type to capture information about the source of the business identifier - or a URI expressed as a string to an existing entity. | ARRAY |
| ResearchSubject.identifier.system | The system or namespace that defines the identifier. | STRING |
| ResearchSubject.identifier.value | The value of the identifier, as defined by the system. | STRING |
| ResearchSubject.member_of_research_project | nan | STRING |
| ResearchSubject.primary_diagnosis_condition | nan | STRING |
| ResearchSubject.primary_diagnosis_site | nan | STRING |
| ResearchSubject.Files | List of ids of File entities associated with the ResearchSubject | ARRAY |
| ResearchSubject.Diagnosis | nan | ARRAY |
| ResearchSubject.Diagnosis.id | The 'logical' identifier of the entity in the repository, e.g. a UUID. This 'id' is unique within a given system. The identified entity may have a different 'id' in a different system. | STRING |
| ResearchSubject.Diagnosis.identifier | A 'business' identifier or accession number for the entity, typically as provided by an external system or authority, that persists across implementing systems (i.e. a 'logical' identifier). | ARRAY |
| ResearchSubject.Diagnosis.identifier.system | The system or namespace that defines the identifier. | STRING |
| ResearchSubject.Diagnosis.identifier.value | The value of the identifier, as defined by the system. | STRING |
| ResearchSubject.Diagnosis.primary_diagnosis | nan | STRING |
| ResearchSubject.Diagnosis.age_at_diagnosis | nan | INT64 |
| ResearchSubject.Diagnosis.morphology | nan | STRING |
| ResearchSubject.Diagnosis.stage | nan | STRING |
| ResearchSubject.Diagnosis.grade | nan | STRING |
| ResearchSubject.Diagnosis.method_of_diagnosis | nan | STRING |
| ResearchSubject.Diagnosis.Treatment | nan | ARRAY |
| ResearchSubject.Diagnosis.Treatment.id | The 'logical' identifier of the entity in the repository, e.g. a UUID. This 'id' is unique within a given system. The identified entity may have a different 'id' in a different system. | STRING |
| ResearchSubject.Diagnosis.Treatment.identifier | A 'business' identifier or accession number for the entity, typically as provided by an external system or authority, that persists across implementing systems (i.e. a 'logical' identifier). | ARRAY |
| ResearchSubject.Diagnosis.Treatment.identifier.system | The system or namespace that defines the identifier. | STRING |
| ResearchSubject.Diagnosis.Treatment.identifier.value | The value of the identifier, as defined by the system. | STRING |
| ResearchSubject.Diagnosis.Treatment.treatment_type | Text name for treatment type; this will ultimately be defined by a common vocabulary | STRING |
| ResearchSubject.Diagnosis.Treatment.treatment_outcome | Text name for treatment outcome; this will ultimately be defined by a common vocabulary | STRING |
| ResearchSubject.Diagnosis.Treatment.days_to_treatment_start | The date and optionally time that the treatment was started in integer. | INT64 |
| ResearchSubject.Diagnosis.Treatment.days_to_treatment_end | nan | INT64 |
| ResearchSubject.Diagnosis.Treatment.therapeutic_agent | nan | STRING |
| ResearchSubject.Diagnosis.Treatment.treatment_anatomic_site | nan | STRING |
| ResearchSubject.Diagnosis.Treatment.treatment_effect | nan | STRING |
| ResearchSubject.Diagnosis.Treatment.treatment_end_reason | nan | STRING |
| ResearchSubject.Diagnosis.Treatment.number_of_cycles | nan | INT64 |
| ResearchSubject.Specimen | Any material taken as a sample from a biological entity (living or dead), or from a physical object or the environment. Specimens are usually collected as an example of their kind, often for use in some investigation. | ARRAY |
| ResearchSubject.Specimen.id | The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is unique within a given system. The identified entity may have a different 'id' in a different system. | STRING |
| ResearchSubject.Specimen.identifier | A 'business' identifier or accession number for the entity, typically as provided by an external system or authority, that persists across implementing systems (i.e. a 'logical' identifier). | ARRAY |
| ResearchSubject.Specimen.identifier.system | The system or namespace that defines the identifier. | STRING |
| ResearchSubject.Specimen.identifier.value | The value of the identifier, as defined by the system. | STRING |
| ResearchSubject.Specimen.associated_project | nan | STRING |
| ResearchSubject.Specimen.age_at_collection | The age of the Patient when this sample was taken. | INT64 |
| ResearchSubject.Specimen.primary_disease_type | nan | STRING |
| ResearchSubject.Specimen.anatomical_site | Per GDC Dictionary, the text term that represents the name of the primary disease site of the submitted tumor sample; recommend dropping tumor; biospecimen_anatomic_site. | STRING |
| ResearchSubject.Specimen.source_material_type | The general kind of material from which the specimen was derived, indicating the physical nature of the source material. | STRING |
| ResearchSubject.Specimen.specimen_type | The high-level type of the specimen, based on its how it has been derived from the original extracted sample. | STRING |
| ResearchSubject.Specimen.derived_from_specimen | A source/parent specimen from which this one was directly derived. | STRING |
| ResearchSubject.Specimen.derived_from_subject | The Patient/ResearchSubject, or Biologically Derived Materal (e.g. a cell line, tissue culture, organoid) from which the specimen was directly or indirectly derived. | STRING |
| ResearchSubject.Specimen.Files | List of ids of File entities associated with the Specimen | ARRAY |
Last update:
2022-06-17