mdf-reader
Version:
Reads MDF YAML and returns helpful accessors
1,602 lines • 151 kB
YAML
program:
$schema: http://json-schema.org/draft-06/schema#
id: program
title: program
category: administrative
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: primary
desc: >-
Within the Integrated Canine Data Commons, studies are grouped into discrete
programs, based upon the origins and/or scientific nature of each
study/trial. These programs may or may not directly relate to any official,
e.g. NCI, funding program. The Program node contains the properties required
to appropriately characterize any given ICDC program.
description: >-
Within the Integrated Canine Data Commons, studies are grouped into discrete
programs, based upon the origins and/or scientific nature of each
study/trial. These programs may or may not directly relate to any official,
e.g. NCI, funding program. The Program node contains the properties required
to appropriately characterize any given ICDC program.
template: 'Yes'
properties:
program_name:
category: program
description: >-
The name of the program under which related studies will be grouped, in
full text and unabbreviated form, exactly as it will be displayed within
the UI.
type: string
src: Internally-curated
propertyType: required
display: 'no'
program_acronym:
labeled: Program
category: program
description: >-
The name of the program under which related studies will be grouped,
expressed in the form of the acronym by which it will identified within
the UI. <br>This property is used as the key via which study records can
be associated with the appropriate program during data loading, and to
identify the correct records during data updates.
type: string
src: Internally-curated
key: true
propertyType: required
display: 'yes'
program_short_description:
category: program
description: An abbreviated, single sentence description of the program.
type: string
src: Internally-curated
propertyType: required
display: 'no'
program_full_description:
category: program
description: A more detailed, multiple sentence description of the program.
type: string
src: Internally-curated
propertyType: required
display: 'no'
program_external_url:
category: program
description: >-
The external url to which users should be directed in order to learn
more about the program.
type: string
src: Internally-curated
propertyType: preferred
display: 'no'
program_sort_order:
category: program
description: >-
An arbitrarily-assigned value used to dictate the order in which
programs are displayed within the application\'s UI.
type: integer
src: Internally-curated
propertyType: optional
display: 'no'
inclusion:
required: &ref_0
- program_name
- program_acronym
- program_short_description
- program_full_description
optional: &ref_2
- program_sort_order
preferred: &ref_1
- program_external_url
uiDisplay:
'yes': &ref_3
- program_acronym
'no': &ref_4
- program_name
- program_short_description
- program_full_description
- program_external_url
- program_sort_order
required: *ref_0
preferred: *ref_1
optional: *ref_2
'yes': *ref_3
'no': *ref_4
multiplicity: Many To One
links:
- Dst: program
Src: study
multiplicity: many_to_one
study:
$schema: http://json-schema.org/draft-06/schema#
id: study
title: study
category: study
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: primary
desc: >-
The Study node contains properties required to characterize each study/trial
in terms of a title, how and why the study/trial was conducted, and the
results that were generated.
description: >-
The Study node contains properties required to characterize each study/trial
in terms of a title, how and why the study/trial was conducted, and the
results that were generated.
template: 'Yes'
properties:
clinical_study_id:
category: study
description: >-
Where applicable, the ID for the study/trial as generated by the source
database.
type: string
src: Data Owner(s)
propertyType: optional
display: 'no'
clinical_study_designation:
labeled: Study Code, Assigned to Study
category: study
description: >-
A unique, human-friendly, alpha-numeric identifier by which the
study/trial will be identified within the UI. <br>This property is used
as the key via which child records, e.g. case records, can be associated
with the appropriate study during data loading, and to identify the
correct records during data updates.
type: string
src: Internally-generated
key: true
propertyType: required
display: 'yes'
clinical_study_name:
labeled: Study Name
category: study
description: >-
A succinct, narrative title for the study/trial, exactly as it should be
displayed within the application's UI.
type: string
src: Data Owner(s)
propertyType: required
display: 'yes'
clinical_study_description:
labeled: Description
category: study
description: >-
A multiple sentence summary of what the study/trial was intended to
determine and how it was conducted.
type: string
src: Data Owner(s)
propertyType: required
display: 'yes'
clinical_study_type:
labeled: Study Type
category: study
description: >-
An arbitrary designation of the study/trial to indicate its underlying.
nature, e.g. Clinical Trial, Transcriptomics, Genomics.
type: string
src: Internally-curated
propertyType: required
display: 'yes'
date_of_iacuc_approval:
labeled: Date of IACUC Approval
category: study
description: >-
Where applicable, the date upon which the study/trial was approved by
the IACUC.
type: datetime
src: Data Owner(s)
propertyType: optional
display: 'yes'
dates_of_conduct:
labeled: Conducted
category: study
description: >-
An indication of the general time period during which the study/trial
was active, e.g. (from) month and year (to) month and year.
type: string
src: Data Owner(s)
propertyType: preferred
display: 'yes'
accession_id:
labeled: Accession ID
category: study
description: >-
A unique, alpha-numeric identifier, in the format of six digits, which
is assigned to the study/trial as of it being on-boarded, and which can
be resolved by identifiers.org when prefixed with "icdc:" to create a
compact identifier in the format icdc:xxxxxx.
type: string
src: Internally-curated
propertyType: required
display: 'yes'
study_disposition:
category: study
description: >-
An arbitrarily-assigned value used to dictate how the study/trial is
displayed via the ICDC Production environment, based upon the degree to
which the data has been on-boarded and/or whether the data is subject to
any temporary embargo which prevents its public release.
type: &ref_5
- Unrestricted
- Pending
- Under Embargo
enum: *ref_5
src: Internally-curated
propertyType: required
display: 'no'
inclusion:
required: &ref_6
- clinical_study_designation
- clinical_study_name
- clinical_study_description
- clinical_study_type
- accession_id
- study_disposition
optional: &ref_8
- clinical_study_id
- date_of_iacuc_approval
preferred: &ref_7
- dates_of_conduct
uiDisplay:
'yes': &ref_9
- clinical_study_designation
- clinical_study_name
- clinical_study_description
- clinical_study_type
- date_of_iacuc_approval
- dates_of_conduct
- accession_id
'no': &ref_10
- clinical_study_id
- study_disposition
required: *ref_6
preferred: *ref_7
optional: *ref_8
'yes': *ref_9
'no': *ref_10
multiplicity: Many To One
links:
- name: program
backref: study
label: systolic_bp
target_type: program
required: false
multiplicity: many_to_one
targetId: program_acronym
generatedType: Internally-curated
- Dst: study
Src: study_site
multiplicity: many_to_many
- Dst: study
Src: study_arm
multiplicity: many_to_one
- Dst: study
Src: cohort
multiplicity: many_to_one
- Dst: study
Src: case
multiplicity: many_to_one
- Dst: study
Src: principal_investigator
multiplicity: many_to_many
- Dst: study
Src: file
multiplicity: many_to_one
- Dst: study
Src: image_collection
multiplicity: many_to_one
- Dst: study
Src: publication
multiplicity: many_to_one
study_site:
$schema: http://json-schema.org/draft-06/schema#
id: study_site
title: study_site
category: study
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: secondary
desc: >-
The Study Site node contains properties which identify the various sites at
which any given study/trial was conducted, either in terms of where clinical
trial patients were assessed and treated, or in terms of the geographical
sites at which biospecimens were acquired from patients/subjects/donors for
subsequent analysis.
description: >-
The Study Site node contains properties which identify the various sites at
which any given study/trial was conducted, either in terms of where clinical
trial patients were assessed and treated, or in terms of the geographical
sites at which biospecimens were acquired from patients/subjects/donors for
subsequent analysis.
template: 'Yes'
properties:
site_short_name:
labeled: Study Site
category: study_site
description: >-
The widely-accepted acronym for the institution at which the
patient/subject/donor was enrolled into the study/trial, and then
treated under the appropriate veterinary medicine program.
type: string
src: Data Owner(s)
propertyType: optional
display: 'yes'
veterinary_medical_center:
category: study_site
description: >-
The full name of the insitution at which the patient/subject/donor was
enrolled into the study/trial, and then treated under the appropriate
veterinary medicine program, together with the site's city and state.
type: string
src: Data Owner(s)
propertyType: optional
display: 'no'
registering_institution:
category: study_site
description: Pending
type: string
src: Data Owner(s)
propertyType: optional
display: 'no'
inclusion:
optional: &ref_11
- site_short_name
- veterinary_medical_center
- registering_institution
uiDisplay:
'yes': &ref_12
- site_short_name
'no': &ref_13
- veterinary_medical_center
- registering_institution
required: []
preferred: []
optional: *ref_11
'yes': *ref_12
'no': *ref_13
multiplicity: Many To One
links:
- name: study
backref: study_site
label: systolic_bp
target_type: study
required: false
multiplicity: many_to_many
targetId: clinical_study_designation
generatedType: Internally-generated
study_arm:
$schema: http://json-schema.org/draft-06/schema#
id: study_arm
title: study_arm
category: study
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: secondary
desc: >-
The Study Arm node contains properties required to describe the arms into
which any given study/trial was divided. Division of a study/trial into
multiple arms is optional and is at the discretion of the data owners, based
upon the way in which the study/trial in question was structured, and how
best that structure can be represented within the ICDC. Where applicable,
the appropriate study arms are defined during the study on-boarding process
and then created via a specific data loading file.
description: >-
The Study Arm node contains properties required to describe the arms into
which any given study/trial was divided. Division of a study/trial into
multiple arms is optional and is at the discretion of the data owners, based
upon the way in which the study/trial in question was structured, and how
best that structure can be represented within the ICDC. Where applicable,
the appropriate study arms are defined during the study on-boarding process
and then created via a specific data loading file.
template: 'Yes'
properties:
arm:
labeled: Arm, Assigned to Arm
category: study_arm
description: >-
Where applicable, the nature of each arm into which the study/trial has
been divided. For example, in multiple agent clinical trials, the name
of the therapeutic agent used in any given study arm.
type: string
src: Internally-curated
propertyType: preferred
display: 'yes'
ctep_treatment_assignment_code:
category: study_arm
description: TBD
type:
pattern: |
^.+$
src: Internally-curated
propertyType: optional
display: 'no'
arm_description:
category: study_arm
description: A short description of the study arm.
type: string
src: Internally-curated
propertyType: preferred
display: 'no'
arm_id:
category: study_arm
description: >-
A unique identifier via which study arms can be differentiated from one
another across studies/trials. <br>This property is used as the key via
which child records, e.g. cohort records, can be associated with the
appropriate study arm during data loading, and to identify the correct
records during data updates.
type: string
src: Internally-curated
key: true
propertyType: required
display: 'no'
inclusion:
required: &ref_14
- arm_id
optional: &ref_16
- ctep_treatment_assignment_code
preferred: &ref_15
- arm
- arm_description
uiDisplay:
'yes': &ref_17
- arm
'no': &ref_18
- ctep_treatment_assignment_code
- arm_description
- arm_id
required: *ref_14
preferred: *ref_15
optional: *ref_16
'yes': *ref_17
'no': *ref_18
multiplicity: Many To One
links:
- name: study
backref: study_arm
label: systolic_bp
target_type: study
required: false
multiplicity: many_to_one
targetId: clinical_study_designation
generatedType: Internally-generated
- Dst: study_arm
Src: agent
multiplicity: many_to_many
- Dst: study_arm
Src: cohort
multiplicity: many_to_one
- Dst: study_arm
Src: case
multiplicity: many_to_one
agent:
$schema: http://json-schema.org/draft-06/schema#
id: agent
title: agent
category: clinical_trial
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: extended
class: secondary
desc: >-
The Agent node documents the name of each therapeutic agent being
administered during a clinical trial. In this way, in clinical trials which
assess the efficacy of combination therapies, adverse events observed during
the trial can be attributed specifically to one or more of the medications
being used.
description: >-
The Agent node documents the name of each therapeutic agent being
administered during a clinical trial. In this way, in clinical trials which
assess the efficacy of combination therapies, adverse events observed during
the trial can be attributed specifically to one or more of the medications
being used.
template: 'No'
properties:
medication:
category: agent
type: &ref_78
- http://localhost/terms/domain/medication
src: STUDY_MED_ADMIN/SDAD/1
propertyType: optional
display: 'no'
document_number:
category: agent
description: S/N of the executed CRF
type: &ref_77
pattern: |
^R[0-9]+$
src: ALL
propertyType: optional
display: 'no'
inclusion:
optional: &ref_19
- medication
- document_number
uiDisplay:
'no': &ref_20
- medication
- document_number
required: []
preferred: []
optional: *ref_19
'yes': []
'no': *ref_20
multiplicity: Many To One
links:
- name: study_arm
backref: agent
label: systolic_bp
target_type: study_arm
required: false
multiplicity: many_to_many
targetId: arm_id
generatedType: Internally-curated
- Dst: agent
Src: agent_administration
multiplicity: many_to_one
- Dst: agent
Src: adverse_event
multiplicity: many_to_one
cohort:
$schema: http://json-schema.org/draft-06/schema#
id: cohort
title: cohort
category: study
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: secondary
desc: >-
The Cohort node contains properties required to describe the cohorts into
which any given study/trial was divided. Division of a study/trial into
multiple cohorts is optional and is at the discretion of the data owners,
based upon the way in which the study/trial in question was structured, and
how best that structure can be represented within the ICDC. Where
applicable, the appropriate cohorts are defined during the study on-boarding
process and then created via a specific data loading file.
description: >-
The Cohort node contains properties required to describe the cohorts into
which any given study/trial was divided. Division of a study/trial into
multiple cohorts is optional and is at the discretion of the data owners,
based upon the way in which the study/trial in question was structured, and
how best that structure can be represented within the ICDC. Where
applicable, the appropriate cohorts are defined during the study on-boarding
process and then created via a specific data loading file.
template: 'Yes'
properties:
cohort_description:
labeled: Cohort, Assigned to Cohort
category: cohort
description: >-
Where applicable, the nature of each cohort into which the study/trial
has been divided, e.g. in studies examining the effects of multiple
doses of a therapeutic agent, the name and dose of the therapeutic agent
used in any given cohort.
type: string
src: Internally-curated
propertyType: required
display: 'yes'
cohort_dose:
labeled: Cohorts
category: cohort
description: >-
The intended or protocol dose of the therapeutic agent used in any given
cohort.
type: string
src: Internally-curated
propertyType: optional
display: 'yes'
cohort_id:
category: cohort
description: >-
A unique identifier via which cohorts can be differentiated from one
another across studies/trials. <br>This property is used as the key via
which cases can be associated with the appropriate cohort during data
loading, and to identify the correct records during data updates.
type: string
src: Internally-curated
key: true
propertyType: required
display: 'no'
inclusion:
required: &ref_21
- cohort_description
- cohort_id
optional: &ref_22
- cohort_dose
uiDisplay:
'yes': &ref_23
- cohort_description
- cohort_dose
'no': &ref_24
- cohort_id
required: *ref_21
preferred: []
optional: *ref_22
'yes': *ref_23
'no': *ref_24
multiplicity: Many To One
links:
- name: study_arm
backref: cohort
label: systolic_bp
target_type: study_arm
required: false
multiplicity: many_to_one
targetId: arm_id
generatedType: Internally-curated
- name: study
backref: cohort
label: systolic_bp
target_type: study
required: false
multiplicity: many_to_one
targetId: clinical_study_designation
generatedType: Internally-generated
- Dst: cohort
Src: case
multiplicity: many_to_one
case:
$schema: http://json-schema.org/draft-06/schema#
id: case
title: case
category: case
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: primary
desc: >-
The Case node contains properties required to unambiguously identify each
patient/subject/donor, either based upon the data submitter's original ID,
or upon a study-specific Case ID derived from it during data transformation,
which prefixes each original ID with a short, study-specific code.
description: >-
The Case node contains properties required to unambiguously identify each
patient/subject/donor, either based upon the data submitter's original ID,
or upon a study-specific Case ID derived from it during data transformation,
which prefixes each original ID with a short, study-specific code.
template: 'Yes'
properties:
case_id:
labeled: Case ID
category: case
description: >-
The globally unique ID by which any given patient/subject/donor can be
unambiguously identified and displayed across studies/trials;
specifically the value of patient_id as supplied by the data submitter,
prefixed with the appropriate ICDC study code during data alignment
and/or transformation. <br>This property is used as the key via which
child records, e.g. sample records, can be associated with the
appropriate case during data loading, and to identify the correct
records during data updates.
type: string
src: Internally-generated
key: true
propertyType: required
display: 'yes'
patient_id:
category: case
description: >-
The preferred ID by which the data submitter uniquely identifies any
given patient/subject/donor, at least within a single study/trial,
recorded exactly as provided by the data submitter. Once prefixed with
the appropriate ICDC study code during data alignment and/or
transformation, values of Patient ID become values of Case ID.
type: string
src: Data Owner(s)
propertyType: required
display: 'no'
patient_first_name:
labeled: Case Name
category: case
description: Where available, the given name of the patient/subject/donor.
type: string
src: Data Owner(s)
propertyType: preferred
display: 'yes'
inclusion:
required: &ref_25
- case_id
- patient_id
preferred: &ref_26
- patient_first_name
uiDisplay:
'yes': &ref_27
- case_id
- patient_first_name
'no': &ref_28
- patient_id
required: *ref_25
preferred: *ref_26
optional: []
'yes': *ref_27
'no': *ref_28
multiplicity: Many To One
links:
- name: cohort
backref: case
label: systolic_bp
target_type: cohort
required: false
multiplicity: many_to_one
targetId: cohort_id
generatedType: Internally-curated
- name: study
backref: case
label: systolic_bp
target_type: study
required: false
multiplicity: many_to_one
targetId: clinical_study_designation
generatedType: Internally-generated
- name: study_arm
backref: case
label: systolic_bp
target_type: study_arm
required: false
multiplicity: many_to_one
targetId: arm_id
generatedType: Internally-curated
- name: adverse_event
backref: case
label: systolic_bp
target_type: adverse_event
required: false
multiplicity: many_to_one
- name: off_study
backref: case
label: systolic_bp
target_type: off_study
required: false
multiplicity: one_to_one
- name: off_treatment
backref: case
label: systolic_bp
target_type: off_treatment
required: false
multiplicity: one_to_one
- name: canine_individual
backref: case
label: systolic_bp
target_type: canine_individual
required: false
multiplicity: many_to_one
targetId: canine_individual_id
generatedType: Loader-generated
- Dst: case
Src: registration
multiplicity: many_to_many
- Dst: case
Src: demographic
multiplicity: one_to_one
- Dst: case
Src: cycle
multiplicity: many_to_one
- Dst: case
Src: visit
multiplicity: many_to_one
- Dst: case
Src: diagnosis
multiplicity: many_to_one
- Dst: case
Src: enrollment
multiplicity: one_to_one
- Dst: case
Src: sample
multiplicity: many_to_one
- Dst: case
Src: file
multiplicity: many_to_one
- Dst: case
Src: adverse_event
multiplicity: many_to_one
- Dst: case
Src: follow_up
multiplicity: many_to_one
registration:
$schema: http://json-schema.org/draft-06/schema#
id: registration
title: registration
category: case
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: secondary
desc: >-
The Registration node functions to capture multiple IDs that may be
associated with any single patient/subject/donor. Specifically, it captures
multiple IDs in the form of Key:Value pairs, which represent each alternate
ID and the specific source from which that alternate ID originates. These
registrations can then be used to identify multi-study participants, i.e.
canine individuals enrolled in two or more ICDC studies as study-specific
cases, but which nonetheless represent the same underlying
patient/subject/donor.
description: >-
The Registration node functions to capture multiple IDs that may be
associated with any single patient/subject/donor. Specifically, it captures
multiple IDs in the form of Key:Value pairs, which represent each alternate
ID and the specific source from which that alternate ID originates. These
registrations can then be used to identify multi-study participants, i.e.
canine individuals enrolled in two or more ICDC studies as study-specific
cases, but which nonetheless represent the same underlying
patient/subject/donor.
template: 'Yes'
properties:
registration_origin:
category: registration
description: >-
The entity with which each registration ID is directly associated, for
example, an ICDC study, as denoted by the appropriate study code, or the
biobank or tissue repository from which samples for a study/trial
participant were acquired, as denoted by the appropriate acronym.
type: string
src: Data Owner(s)
propertyType: required
display: 'no'
registration_id:
category: registration
description: >-
Any ID used by a data submitter to identify a patient/subject/donor,
either locally or globally.
type: string
src: Data Owner(s)
propertyType: required
display: 'no'
inclusion:
required: &ref_29
- registration_origin
- registration_id
uiDisplay:
'no': &ref_30
- registration_origin
- registration_id
required: *ref_29
preferred: []
optional: []
'yes': []
'no': *ref_30
multiplicity: Many To One
links:
- name: case
backref: registration
label: systolic_bp
target_type: case
required: false
multiplicity: many_to_many
targetId: case_id
generatedType: Internally-generated
biospecimen_source:
$schema: http://json-schema.org/draft-06/schema#
id: biospecimen_source
title: biospecimen_source
category: biospecimen
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: secondary
desc: >-
The Biospecimen Source node functions essentially as a look-up table used by
the front-end of the application to convert the names of biobanks and tissue
repositories represented in the form of acronyms into human-readable, full
text names.
description: >-
The Biospecimen Source node functions essentially as a look-up table used by
the front-end of the application to convert the names of biobanks and tissue
repositories represented in the form of acronyms into human-readable, full
text names.
template: 'No'
properties:
biospecimen_repository_acronym:
labeled: Biobank
category: biospecimen_source
description: >-
The name of the biobank or tissue repository from which or to which
samples for any given patient/subject/donor were acquired or submitted,
expressed in the form of an acronym.
type: string
src: Internally-curated
propertyType: required
display: 'yes'
biospecimen_repository_full_name:
category: biospecimen_source
description: >-
The name of the biobank or tissue repository from which or to which
samples for any given patient/subject/donor were acquired or submitted,
expressed in full text form.
type: string
src: Internally-curated
propertyType: required
display: 'no'
inclusion:
required: &ref_31
- biospecimen_repository_acronym
- biospecimen_repository_full_name
uiDisplay:
'yes': &ref_32
- biospecimen_repository_acronym
'no': &ref_33
- biospecimen_repository_full_name
required: *ref_31
preferred: []
optional: []
'yes': *ref_32
'no': *ref_33
multiplicity: Many To One
links: []
canine_individual:
$schema: http://json-schema.org/draft-06/schema#
id: canine_individual
title: canine_individual
category: case
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: secondary
desc: >-
The Canine Individual node contains only a single property, i.e.
canine_individual_id, a loader-generated ID which identifies each underlying
canine subject represented by two or more study-specific ICDC cases. This ID
functions to map data sets ultimately derived from the same underlying
patient/subject/donor, but generated from discrete cases in separate
studies, to the underlying canine individual, such that all data sets
derived from any given canine individual can be identified within the
application’s user interface and combined.
description: >-
The Canine Individual node contains only a single property, i.e.
canine_individual_id, a loader-generated ID which identifies each underlying
canine subject represented by two or more study-specific ICDC cases. This ID
functions to map data sets ultimately derived from the same underlying
patient/subject/donor, but generated from discrete cases in separate
studies, to the underlying canine individual, such that all data sets
derived from any given canine individual can be identified within the
application’s user interface and combined.
template: 'No'
properties:
canine_individual_id:
labeled: Canine ID
category: canine_individual
description: >-
A unique numerical ID, which, based upon the existence of
registration-based matches between two or more study-specific cases, is
auto-generated by the data loader, and which thereby tethers matching
cases to the single underlying multi-study participant.
type: string
src: Loader-generated
key: true
propertyType: required
display: 'yes'
inclusion:
required: &ref_34
- canine_individual_id
uiDisplay:
'yes': &ref_35
- canine_individual_id
required: *ref_34
preferred: []
optional: []
'yes': *ref_35
'no': []
multiplicity: Many To One
links:
- Dst: canine_individual
Src: case
multiplicity: many_to_one
demographic:
$schema: http://json-schema.org/draft-06/schema#
id: demographic
title: demographic
category: case
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: core
class: primary
desc: >-
The Demographic node is comprised of properties which describe the key
characteristics of each patient/subject/donor, such as breed, sex and
neutered status.
description: >-
The Demographic node is comprised of properties which describe the key
characteristics of each patient/subject/donor, such as breed, sex and
neutered status.
template: 'Yes'
properties:
demographic_id:
category: demographic
description: >-
A unique identifier of each demographic record, used to identify the
correct demographic records during data updates. The value of this
property will generally be the same as the value of the case_id
property.
type: string
src: Data Owner(s)
key: true
propertyType: required
display: 'no'
breed:
labeled: Breed
category: demographic
description: >-
The specific breed of the canine patient/subject/donor, per the list of
breeds officially recognized by the American Kennel Club.
type: &ref_36
- Affenpinscher
- Afghan Hound
- Airedale Terrier
- Akita
- Alaskan Klee Kai
- Alaskan Malamute
- American Bulldog
- American English Coonhound
- American Eskimo Dog
- American Foxhound
- American Hairless Terrier
- American Leopard Hound
- American Staffordshire Terrier
- American Water Spaniel
- Anatolian Shepherd Dog
- Appenzeller Sennenhunde
- Australian Cattle Dog
- Australian Kelpie
- Australian Shepherd
- Australian Stumpy Tail Cattle Dog
- Australian Terrier
- Azawakh
- Barbado da Terceira
- Barbet
- Basenji
- Basset Fauve de Bretagne
- Basset Hound
- Bavarian Mountain Scent Hound
- Beagle
- Bearded Collie
- Beauceron
- Bedlington Terrier
- Belgian Laekenois
- Belgian Malinois
- Belgian Sheepdog
- Belgian Tervuren
- Bergamasco Sheepdog
- Berger Picard
- Bernese Mountain Dog
- Bichon Frise
- Biewer Terrier
- Black Russian Terrier
- Black and Tan Coonhound
- Bloodhound
- Bluetick Coonhound
- Boerboel
- Bohemian Shepherd
- Bolognese
- Border Collie
- Border Terrier
- Borzoi
- Boston Terrier
- Bouvier des Flandres
- Boxer
- Boykin Spaniel
- Bracco Italiano
- Braque Francais Pyrenean
- Braque du Bourbonnais
- Briard
- Brittany
- Broholmer
- Brussels Griffon
- Bull Terrier
- Bulldog
- Bullmastiff
- Cairn Terrier
- Canaan Dog
- Cane Corso
- Cardigan Welsh Corgi
- Carolina Dog
- Catahoula Hound
- Catahoula Leopard Dog
- Caucasian Shepherd Dog
- Cavalier King Charles Spaniel
- Central Asian Shepherd Dog
- Cesky Terrier
- Chesapeake Bay Retriever
- Chihuahua
- Chinese Crested
- Chinese Shar-Pei
- Chinook
- Chow Chow
- Cirneco dell'Etna
- Clumber Spaniel
- Cocker Spaniel
- Collie
- Coton de Tulear
- Croatian Sheepdog
- Curly-Coated Retriever
- Czechoslovakian Vlcak
- Dachshund
- Dalmatian
- Dandie Dinmont Terrier
- Danish-Swedish Farmdog
- Deutscher Wachtelhund
- Doberman Pinscher
- Dogo Argentino
- Dogue de Bordeaux
- Drentsche Patrijshond
- Drever
- Dutch Shepherd
- English Cocker Spaniel
- English Foxhound
- English Setter
- English Springer Spaniel
- English Toy Spaniel
- Entlebucher Mountain Dog
- Estrela Mountain Dog
- Eurasier
- Field Spaniel
- Finnish Lapphund
- Finnish Spitz
- Flat-Coated Retriever
- French Bulldog
- French Spaniel
- German Longhaired Pointer
- German Pinscher
- German Shepherd Dog
- German Shorthaired Pointer
- German Spitz
- German Wirehaired Pointer
- Giant Schnauzer
- Glen of Imaal Terrier
- Golden Retriever
- Gordon Setter
- Grand Basset Griffon Vendeen
- Great Dane
- Great Pyrenees
- Greater Swiss Mountain Dog
- Greyhound
- Hamiltonstovare
- Hanoverian Scenthound
- Harrier
- Havanese
- Hokkaido
- Hovawart
- Ibizan Hound
- Icelandic Sheepdog
- Irish Red and White Setter
- Irish Setter
- Irish Terrier
- Irish Water Spaniel
- Irish Wolfhound
- Italian Greyhound
- Jagdterrier
- Japanese Akitainu
- Japanese Chin
- Japanese Spitz
- Japanese Terrier
- Jindo
- Kai Ken
- Karelian Bear Dog
- Keeshond
- Kerry Blue Terrier
- Kishu Ken
- Komondor
- Kromfohrlander
- Kuvasz
- Labrador Retriever
- Lagotto Romagnolo
- Lakeland Terrier
- Lancashire Heeler
- Lapponian Herder
- Leonberger
- Lhasa Apso
- Lowchen
- Maltese
- Manchester Terrier
- Mastiff
- Miniature American Shepherd
- Miniature Bull Terrier
- Miniature Dachshund
- Miniature Pinscher
- Miniature Schnauzer
- Mixed Breed
- Mountain Cur
- Mudi
- Neapolitan Mastiff
- Nederlandse Kooikerhondje
- Newfoundland
- Norfolk Terrier
- Norrbottenspets
- Norwegian Buhund
- Norwegian Elkhound
- Norwegian Lundehund
- Norwich Terrier
- Nova Scotia Duck Tolling Retriever
- Old English Sheepdog
- Other
- Otterhound
- Papillon
- Parson Russell Terrier
- Pekingese
- Pembroke Welsh Corgi
- Perro de Presa Canario
- Peruvian Inca Orchid
- Petit Basset Griffon Vendeen
- Pharaoh Hound
- Plott Hound
- Pointer
- Polish Lowland Sheepdog
- Pomeranian
- Poodle
- Porcelaine
- Portuguese Podengo
- Portuguese Podengo Pequeno
- Portuguese Pointer
- Portuguese Sheepdog
- Portuguese Water Dog
- Pudelpointer
- Pug
- Puli
- Pumi
- Pyrenean Mastiff
- Pyrenean Shepherd
- Rafeiro do Alentejo
- Rat Terrier
- Redbone Coonhound
- Rhodesian Ridgeback
- Romanian Mioritic Shepherd Dog
- Rottweiler
- Russell Terrier
- Russian Toy
- Russian Tsvetnaya Bolonka
- Saint Bernard
- Saluki
- Samoyed
- Schapendoes
- Schipperke
- Scottish Deerhound
- Scottish Terrier
- Sealyham Terrier
- Segugio Italiano
- Shetland Sheepdog
- Shiba Inu
- Shih Tzu
- Shikoku
- Siberian Husky
- Silky Terrier
- Skye Terrier
- Sloughi
- Slovakian Wirehaired Pointer
- Slovensky Cuvac
- Slovensky Kopov
- Small Munsterlander Pointer
- Smooth Fox Terrier
- Soft Coated Wheaten Terrier
- Spanish Mastiff
- Spanish Water Dog
- Spinone Italiano
- Stabyhoun
- Staffordshire Bull Terrier
- Standard Schnauzer
- Sussex Spaniel
- Swedish Lapphund
- Swedish Vallhund
- Taiwan Dog
- Teddy Roosevelt Terrier
- Thai Ridgeback
- Tibetan Mastiff
- Tibetan Spaniel
- Tibetan Terrier
- Tornjak
- Tosa
- Toy Fox Terrier
- Toy Poodle
- Transylvanian Hound
- Treeing Tennessee Brindle Coonhound
- Treeing Walker Coonhound
- Unknown
- Vizsla
- Weimaraner
- Welsh Springer Spaniel
- Welsh Terrier
- West Highland White Terrier
- Wetterhoun
- Whippet
- Wire Fox Terrier
- Wirehaired Pointing Griffon
- Wirehaired Vizsla
- Working Kelpie
- Xoloitzcuintli
- Yakutian Laika
- Yorkshire Terrier
enum: *ref_36
src: Data Owner(s)
propertyType: required
display: 'yes'
additional_breed_detail:
category: demographic
description: >-
For patients/subjects/donors formally designated as either Mixed Breed
or Other, any available detail as to the breeds contributing to the
overall mix of breeds or clarification of the nature of the Other breed.
Values for this field are therefore not relevant to pure-bred
patients/subjects/donors, but for those of mixed breed or other origins,
values are definitely preferred wherever available.
type: string
src: Data Owner(s)
propertyType: preferred
display: 'no'
patient_age_at_enrollment:
labeled: Age, Age at Enrollment
category: demographic
description: >-
The age of the canine patient/subject/donor as of study/trial
enrollment, expressed in standard human years, as opposed to dog years.
type:
units:
- years
value_type: number
src: Data Owner(s)
propertyType: preferred
display: 'yes'
date_of_birth:
category: demographic
description: The date of birth of the canine patient/subject/donor.
type: datetime
src: Data Owner(s)
propertyType: optional
display: 'no'
sex:
labeled: Sex
category: demographic
description: The biological sex of the patient/subject/donor.
type: &ref_37
- Male
- Female
- Unknown
enum: *ref_37
src: Data Owner(s)
propertyType: required
display: 'yes'
weight:
labeled: Weight (kg)
category: demographic
description: >-
The weight of the patient/subject/donor at the time of study/trial
enrollment and/or biospecimens being acquired, at least in the case of
studies that are not longitudinal in nature.
type:
units:
- kg
value_type: number
src: Data Owner(s)
propertyType: preferred
display: 'yes'
neutered_indicator:
labeled: Neutered Status
category: demographic
description: >-
Indicator as to whether the patient/subject/donor has been either spayed
(female subjects) or neutered (male subjects).
type: &ref_38
- 'Yes'
- 'No'
- Unknown
enum: *ref_38
src: Data Owner(s)
propertyType: required
display: 'yes'
inclusion:
required: &ref_39
- demographic_id
- breed
- sex
- neutered_indicator
optional: &ref_41
- date_of_birth
preferred: &ref_40
- additional_breed_detail
- patient_age_at_enrollment
- weight
uiDisplay:
'yes': &ref_42
- breed
- patient_age_at_enrollment
- sex
- weight
- neutered_indicator
'no': &ref_43
- demographic_id
- additional_breed_detail
- date_of_birth
required: *ref_39
preferred: *ref_40
optional: *ref_41
'yes': *ref_42
'no': *ref_43
multiplicity: Many To One
links:
- name: case
backref: demographic
label: systolic_bp
target_type: case
required: false
multiplicity: one_to_one
targetId: case_id
generatedType: Internally-generated
cycle:
$schema: http://json-schema.org/draft-06/schema#
id: cycle
title: cycle
category: clinical_trial
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: extended
class: secondary
desc: >-
In clinical trials where therapeutic agents are administered in multiple
discrete treatment cycles, the properties within the Cycle node serve to
capture the dates upon which each cycle started and ended, providing a
detailed timeframe for the therapeutic intervention(s) in question. Adverse
events can then be associated with the correct cycle based upon when they
were observed.
description: >-
In clinical trials where therapeutic agents are administered in multiple
discrete treatment cycles, the properties within the Cycle node serve to
capture the dates upon which each cycle started and ended, providing a
detailed timeframe for the therapeutic intervention(s) in question. Adverse
events can then be associated with the correct cycle based upon when they
were observed.
template: 'Yes'
properties:
cycle_number:
category: cycle
description: >-
For a patient/subject/donor enrolled in a clinical trial evaluating the
effects of therapy administered in multiple cycles, the number of the
treatment cycle during which visits occurred such that therapy could be
administered and/or clinical observations could be made, with cycles
numbered according to their chronological order.
type: integer
src: Data Owner(s)
propertyType: required
display: 'no'
date_of_cycle_start:
category: cycle
description: The date upon which the treament cycle in question began.
type: datetime
src: Data Owner(s)
propertyType: optional
display: 'no'
date_of_cycle_end:
category: cycle
description: The date upon which the treatent cycle in question ended.
type: datetime
src: Data Owner(s)
propertyType: optional
display: 'no'
inclusion:
required: &ref_44
- cycle_number
optional: &ref_45
- date_of_cycle_start
- date_of_cycle_end
uiDisplay:
'no': &ref_46
- cycle_number
- date_of_cycle_start
- date_of_cycle_end
required: *ref_44
preferred: []
optional: *ref_45
'yes': []
'no': *ref_46
multiplicity: Many To One
links:
- name: case
backref: cycle
label: systolic_bp
target_type: case
required: false
multiplicity: many_to_one
targetId: case_id
generatedType: Internally-generated
- Dst: cycle
Src: visit
multiplicity: many_to_one
visit:
$schema: http://json-schema.org/draft-06/schema#
id: visit
title: visit
category: clinical_trial
program: '*'
project: '*'
additionalProperties: false
submittable: true
constraints: null
type: object
assignment: extended
class: secondary
desc: >-
Clinical trials typically require the patient to make multiple visits to the
study site for clinical evaluation and/or the administration of additional
medication(s). Properties within the Visit node serve to capture the date
upon which each visit occurs. Adverse events and various clinical
assessments can then be associated with the correct visit based upon date.
description: >-
Clinical trials typically require the patient to make multiple visits to the
study site for clinical evaluation and/or the administration of additional
medication(s). Properties within the Visit node serve to capture the date
upon which each visit occurs. Adverse events and various clinical
assessments can then be associated with the correct visit based upon date.
template: 'Yes'
properties:
visit_date:
category: visit
description: The date upon which the visit occurred.
type: datetime
src: Data-derived
propertyType: optional
display: 'no'
visit_number:
category: visit
description: >-
The number of the visit during which therapy was administered and/or
clinical observations were made, with visits numbered according to their
chronological order.
type: Integer
src: Data-deived
propertyType: optional
display: 'no'
visit_id:
category: visit
description: >-
A globally unique identifier of each visit record; specifically the
value of case_id concatenated with the value of visit_date, the date
upon which the visit occurred. <br>This property is used as the key via
which child records, e.g. physical examinat