Skip to content

Instantly share code, notes, and snippets.

@lbeckman314

lbeckman314/aced.json

Last active October 13, 2022 19:20
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save lbeckman314/00e466f2c474c3065e0804469b12f3aa to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save lbeckman314/00e466f2c474c3065e0804469b12f3aa to your computer and use it in GitHub Desktop.
Download ZIP
Raw
aced.json
{
"DocumentReference.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "data_file",
"description": " A reference to a document.\n \n A reference to a document of any kind for any purpose. Provides metadata\n about the document so that the document can be discovered and managed. The\n scope of a document is any seralized object with a mime-type, so includes\n formal patient centric documents (CDA), cliical notes, scanned paper, and\n non-patient specific documents like policy text.\n ",
"id": "DocumentReference",
"links": [
{
"backref": "DocumentReferences",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
{
"backref": "DocumentReferences",
"label": "Organizations",
"multiplicity": "many_to_many",
"name": "Organizations",
"required": false,
"target_type": "Organization"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"$ref": "_definitions.yaml#/data_file_properties",
"data_category": {
"term": {
"$ref": "_terms.yaml#/data_category"
},
"type": "string"
},
"data_type": {
"term": {
"$ref": "_terms.yaml#/data_type"
},
"type": "string"
},
"data_format": {
"term": {
"$ref": "_terms.yaml#/data_format"
},
"type": "string"
},
"author_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"author_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"category_coding_us_core_documentreference_category": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"content_attachment_contentType": {
"description": "Mime type of the content, with charset etc..",
"type": [
"string",
"null"
]
},
"content_attachment_data": {
"description": "Data inline, base64ed.",
"type": [
"string",
"null"
]
},
"content_attachment_md5": {
"description": "",
"type": [
"string",
"null"
]
},
"content_attachment_size": {
"description": "Number of bytes of content (if url provided).",
"type": [
"number",
"null"
]
},
"content_attachment_url": {
"description": "Uri where the data can be found.",
"type": [
"string",
"null"
]
},
"content_format_IHE_FormatCode_codesystem": {
"description": "Format/content rules for the document.",
"type": [
"string",
"null"
]
},
"context_encounter_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"context_period_end": {
"description": "End time with inclusive boundary, if not ongoing.",
"type": [
"string",
"null"
]
},
"context_period_start": {
"description": "Starting time with inclusive boundary.",
"type": [
"string",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"custodian_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"custodian_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"date": {
"description": "When this document reference was created.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"identifier_urn_ietf_rfc_3986": {
"description": "Other identifiers for the document.",
"type": [
"string",
"null"
]
},
"meta_profile": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "The status of this document reference.. http://hl7.org/fhir/document-reference-status",
"enum": [
"current",
"superseded",
"entered-in-error"
],
"term": {
"description": "The status of this document reference.. http://hl7.org/fhir/document-reference-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/document-reference-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/document-reference-status",
"term_url": "http://hl7.org/fhir/document-reference-status"
}
}
},
"subject_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"type_coding_0_code": {
"description": "Symbol in syntax defined by the system.",
"type": [
"string",
"null"
]
},
"type_coding_0_display": {
"description": "Representation defined by the system.",
"type": [
"string",
"null"
]
},
"type_coding_0_system": {
"description": "Identity of the terminology system.",
"type": [
"string",
"null"
]
},
"type_coding_1_code": {
"description": "Symbol in syntax defined by the system.",
"type": [
"string",
"null"
]
},
"type_coding_1_display": {
"description": "Representation defined by the system.",
"type": [
"string",
"null"
]
},
"type_coding_1_system": {
"description": "Identity of the terminology system.",
"type": [
"string",
"null"
]
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"status"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "DocumentReference",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Observation.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Clinical",
"description": " Measurements and simple assertions.\n \n Measurements and simple assertions made about a patient, device or other\n subject.\n ",
"id": "Observation",
"links": [
{
"backref": "Observations",
"label": "ResearchStudies",
"multiplicity": "many_to_many",
"name": "ResearchStudies",
"required": false,
"target_type": "ResearchStudy"
},
{
"backref": "Observations",
"label": "Specimen",
"multiplicity": "many_to_many",
"name": "Specimen",
"required": false,
"target_type": "Specimen"
},
{
"backref": "Observations",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
{
"backref": "Observations",
"label": "Encounters",
"multiplicity": "many_to_many",
"name": "Encounters",
"required": false,
"target_type": "Encounter"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"category_coding_observation_category": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"code_coding_0_code": {
"description": "Symbol in syntax defined by the system.",
"type": [
"string",
"null"
]
},
"code_coding_0_display": {
"description": "Representation defined by the system.",
"type": [
"string",
"null"
]
},
"code_coding_0_system": {
"description": "Identity of the terminology system.",
"type": [
"string",
"null"
]
},
"code_coding_1_code": {
"description": "Symbol in syntax defined by the system.",
"type": [
"string",
"null"
]
},
"code_coding_1_display": {
"description": "Representation defined by the system.",
"type": [
"string",
"null"
]
},
"code_coding_1_system": {
"description": "Identity of the terminology system.",
"type": [
"string",
"null"
]
},
"code_coding_loinc_org": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"code_coding_sct": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"code_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"component_0_code_coding_loinc_org": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"component_0_code_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"component_0_valueQuantity_code": {
"description": "Coded form of the unit.",
"type": [
"string",
"null"
]
},
"component_0_valueQuantity_system": {
"description": "System that defines coded unit form.",
"type": [
"string",
"null"
]
},
"component_0_valueQuantity_unit": {
"description": "Unit representation.",
"type": [
"string",
"null"
]
},
"component_0_valueQuantity_value": {
"description": "Numerical value (with implicit precision).",
"type": [
"number",
"null"
]
},
"component_1_code_coding_loinc_org": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"component_1_code_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"component_1_valueQuantity_code": {
"description": "Coded form of the unit.",
"type": [
"string",
"null"
]
},
"component_1_valueQuantity_system": {
"description": "System that defines coded unit form.",
"type": [
"string",
"null"
]
},
"component_1_valueQuantity_unit": {
"description": "Unit representation.",
"type": [
"string",
"null"
]
},
"component_1_valueQuantity_value": {
"description": "Numerical value (with implicit precision).",
"type": [
"number",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"effectiveDateTime": {
"description": "Clinically relevant time/time-period for observation.",
"type": [
"string",
"null"
]
},
"encounter_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"issued": {
"description": "Date/Time this version was made available.",
"type": [
"string",
"null"
]
},
"meta_profile": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"meta_profile_0": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"meta_profile_1": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "The status of the result value.. http://hl7.org/fhir/observation-status",
"enum": [
"registered",
"preliminary",
"final",
"amended",
"corrected",
"cancelled",
"entered-in-error",
"unknown"
],
"term": {
"description": "The status of the result value.. http://hl7.org/fhir/observation-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/observation-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/observation-status",
"term_url": "http://hl7.org/fhir/observation-status"
}
}
},
"subject_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"valueCodeableConcept_coding_loinc_org": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"valueCodeableConcept_coding_sct": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"valueCodeableConcept_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"valueQuantity_code": {
"description": "Coded form of the unit.",
"type": [
"string",
"null"
]
},
"valueQuantity_system": {
"description": "System that defines coded unit form.",
"type": [
"string",
"null"
]
},
"valueQuantity_unit": {
"description": "Unit representation.",
"type": [
"string",
"null"
]
},
"valueQuantity_value": {
"description": "Numerical value (with implicit precision).",
"type": [
"number",
"null"
]
},
"valueSampledData_data": {
"description": "Decimal values with spaces, or \"E\" | \"U\" | \"L\".",
"type": [
"string",
"null"
]
},
"valueSampledData_dimensions": {
"description": "Number of sample points at each time point.",
"type": [
"number"
]
},
"valueSampledData_origin_system": {
"description": "System that defines coded unit form.",
"type": [
"string",
"null"
]
},
"valueSampledData_origin_value": {
"description": "Numerical value (with implicit precision).",
"type": [
"number",
"null"
]
},
"valueSampledData_period": {
"description": "Number of milliseconds between samples.",
"type": [
"number"
]
},
"valueString": {
"description": "Actual result.",
"type": [
"string",
"null"
]
}
},
"required": [
"submitter_id",
"type",
"status"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Observation",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Patient.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Administrative",
"description": " Information about an individual or animal receiving health care services.\n \n Demographics and other administrative information about an individual or\n animal receiving care or other health-related services.\n ",
"id": "Patient",
"links": [
{
"backref": "Patients",
"label": "Organizations",
"multiplicity": "many_to_many",
"name": "Organizations",
"required": true,
"target_type": "Organization"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"address_city": {
"description": "Name of city, town etc..",
"type": [
"string",
"null"
]
},
"address_country": {
"description": "Country (e.g. can be ISO 3166 2 or 3 letter code).",
"type": [
"string",
"null"
]
},
"address_geolocation_latitude": {
"description": "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).\nLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).",
"type": [
"number",
"null"
]
},
"address_geolocation_longitude": {
"description": "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).\nLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).",
"type": [
"number",
"null"
]
},
"address_line": {
"description": "Street name, number, direction & P.O. Box etc..",
"type": [
"string",
"null"
]
},
"address_postalCode": {
"description": "Postal code for area.",
"type": [
"string",
"null"
]
},
"address_state": {
"description": "Sub-unit of country (abbreviations ok).",
"type": [
"string",
"null"
]
},
"birthDate": {
"description": "The date of birth for the individual.",
"type": [
"string",
"null"
]
},
"communication_language_coding_iso639_1": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"communication_language_coding_urn_ietf_bcp_47": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"communication_language_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"deceasedDateTime": {
"description": "Indicates if the individual is deceased or not.",
"type": [
"string",
"null"
]
},
"disability_adjusted_life_years": {
"description": "Disability Adjusted Life Years as defined in the literature and summarized at <a href=\"https://en.wikipedia.org/wiki/Disability-adjusted_life_year\"/>.",
"type": [
"number",
"null"
]
},
"gender": {
"description": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.. http://hl7.org/fhir/administrative-gender",
"enum": [
"male",
"female",
"other",
"unknown"
],
"term": {
"description": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.. http://hl7.org/fhir/administrative-gender",
"termDef": {
"cde_id": "http://hl7.org/fhir/administrative-gender",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/administrative-gender",
"term_url": "http://hl7.org/fhir/administrative-gender"
}
}
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"identifier_DL": {
"description": "An identifier for this patient.",
"type": [
"string",
"null"
]
},
"identifier_MR": {
"description": "An identifier for this patient.",
"type": [
"string",
"null"
]
},
"identifier_PPN": {
"description": "An identifier for this patient.",
"type": [
"string",
"null"
]
},
"identifier_SS": {
"description": "An identifier for this patient.",
"type": [
"string",
"null"
]
},
"identifier_synthea": {
"description": "An identifier for this patient.",
"type": [
"string",
"null"
]
},
"maritalStatus_coding_v3_MaritalStatus": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"maritalStatus_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"meta_profile": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"multipleBirthBoolean": {
"description": "Whether patient is part of a multiple birth.",
"type": [
"boolean",
"null"
]
},
"multipleBirthInteger": {
"description": "Whether patient is part of a multiple birth.",
"type": [
"number",
"null"
]
},
"name_0_family": {
"description": "Family name (often called 'Surname').",
"type": [
"string",
"null"
]
},
"name_0_given": {
"description": "Given names (not always 'first'). Includes middle names.",
"type": [
"string",
"null"
]
},
"name_0_prefix": {
"description": "Parts that come before the name.",
"type": [
"string",
"null"
]
},
"name_0_suffix": {
"description": "Parts that come after the name.",
"type": [
"string",
"null"
]
},
"name_0_use": {
"description": "Identifies the purpose for this name.. http://hl7.org/fhir/name-use",
"enum": [
"usual",
"official",
"temp",
"nickname",
"anonymous",
"old",
"maiden"
],
"term": {
"description": "Identifies the purpose for this name.. http://hl7.org/fhir/name-use",
"termDef": {
"cde_id": "http://hl7.org/fhir/name-use",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/name-use",
"term_url": "http://hl7.org/fhir/name-use"
}
}
},
"name_1_family": {
"description": "Family name (often called 'Surname').",
"type": [
"string",
"null"
]
},
"name_1_given": {
"description": "Given names (not always 'first'). Includes middle names.",
"type": [
"string",
"null"
]
},
"name_1_prefix": {
"description": "Parts that come before the name.",
"type": [
"string",
"null"
]
},
"name_1_suffix": {
"description": "Parts that come after the name.",
"type": [
"string",
"null"
]
},
"name_1_use": {
"description": "Identifies the purpose for this name.. http://hl7.org/fhir/name-use",
"enum": [
"usual",
"official",
"temp",
"nickname",
"anonymous",
"old",
"maiden"
],
"term": {
"description": "Identifies the purpose for this name.. http://hl7.org/fhir/name-use",
"termDef": {
"cde_id": "http://hl7.org/fhir/name-use",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/name-use",
"term_url": "http://hl7.org/fhir/name-use"
}
}
},
"name_family": {
"description": "Family name (often called 'Surname').",
"type": [
"string",
"null"
]
},
"name_given": {
"description": "Given names (not always 'first'). Includes middle names.",
"type": [
"string",
"null"
]
},
"name_prefix": {
"description": "Parts that come before the name.",
"type": [
"string",
"null"
]
},
"name_suffix": {
"description": "Parts that come after the name.",
"type": [
"string",
"null"
]
},
"name_use": {
"description": "Identifies the purpose for this name.. http://hl7.org/fhir/name-use",
"enum": [
"usual",
"official",
"temp",
"nickname",
"anonymous",
"old",
"maiden"
],
"term": {
"description": "Identifies the purpose for this name.. http://hl7.org/fhir/name-use",
"termDef": {
"cde_id": "http://hl7.org/fhir/name-use",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/name-use",
"term_url": "http://hl7.org/fhir/name-use"
}
}
},
"patient_birthPlace_city": {
"description": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.",
"type": [
"string",
"null"
]
},
"patient_birthPlace_country": {
"description": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.",
"type": [
"string",
"null"
]
},
"patient_birthPlace_state": {
"description": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.",
"type": [
"string",
"null"
]
},
"patient_mothersMaidenName": {
"description": "Mother's maiden (unmarried) name, commonly collected to help verify patient identity.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"quality_adjusted_life_years": {
"description": "Quality Adjusted Life Years as defined in the literature and summarized at <a href=\"https://en.wikipedia.org/wiki/Quality-adjusted_life_year\"/>.",
"type": [
"number",
"null"
]
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"telecom_system": {
"description": "Telecommunications form for contact point - what communications system is required to make use of the contact.. http://hl7.org/fhir/contact-point-system",
"enum": [
"phone",
"fax",
"email",
"pager",
"url",
"sms",
"other"
],
"term": {
"description": "Telecommunications form for contact point - what communications system is required to make use of the contact.. http://hl7.org/fhir/contact-point-system",
"termDef": {
"cde_id": "http://hl7.org/fhir/contact-point-system",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/contact-point-system",
"term_url": "http://hl7.org/fhir/contact-point-system"
}
}
},
"telecom_use": {
"description": "Identifies the purpose for the contact point.. http://hl7.org/fhir/contact-point-use",
"enum": [
"home",
"work",
"temp",
"old",
"mobile"
],
"term": {
"description": "Identifies the purpose for the contact point.. http://hl7.org/fhir/contact-point-use",
"termDef": {
"cde_id": "http://hl7.org/fhir/contact-point-use",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/contact-point-use",
"term_url": "http://hl7.org/fhir/contact-point-use"
}
}
},
"telecom_value": {
"description": "The actual contact point details.",
"type": [
"string",
"null"
]
},
"text_div": {
"description": "Limited xhtml content.",
"type": [
"string"
]
},
"text_status": {
"description": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.. http://hl7.org/fhir/narrative-status",
"enum": [
"generated",
"extensions",
"additional",
"empty"
],
"term": {
"description": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.. http://hl7.org/fhir/narrative-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/narrative-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/narrative-status",
"term_url": "http://hl7.org/fhir/narrative-status"
}
}
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"us_core_birthsex": {
"description": "A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9).",
"type": [
"string",
"null"
]
},
"us_core_ethnicity_ombCategory": {
"description": "Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.\nThe 2 ethnicity category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.govinfo.gov/content/pkg/FR-1997-10-30/pdf/97-28653.pdf).. http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category",
"enum": [
"2135-2",
"2186-5",
"ASKU",
"UNK"
],
"term": {
"description": "Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.\nThe 2 ethnicity category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.govinfo.gov/content/pkg/FR-1997-10-30/pdf/97-28653.pdf).. http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category",
"termDef": {
"cde_id": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category",
"term_url": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category"
}
}
},
"us_core_ethnicity_text": {
"description": "Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.\nPlain text representation of the ethnicity concept(s).",
"type": [
"string",
"null"
]
},
"us_core_race_ombCategory": {
"description": "Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.\nThe 5 race category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.govinfo.gov/content/pkg/FR-1997-10-30/pdf/97-28653.pdf).. http://hl7.org/fhir/us/core/ValueSet/omb-race-category",
"enum": [
"1002-5",
"2028-9",
"2054-5",
"2076-8",
"2106-3",
"2131-1",
"ASKU",
"UNK"
],
"term": {
"description": "Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.\nThe 5 race category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.govinfo.gov/content/pkg/FR-1997-10-30/pdf/97-28653.pdf).. http://hl7.org/fhir/us/core/ValueSet/omb-race-category",
"termDef": {
"cde_id": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category",
"term_url": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category"
}
}
},
"us_core_race_text": {
"description": "Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.\nPlain text representation of the race concept(s).",
"type": [
"string",
"null"
]
}
},
"required": [
"submitter_id",
"type",
"text_status",
"text_div"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Patient",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Practitioner.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Administrative",
"description": " A person with a formal responsibility in the provisioning of healthcare or\n related services.\n \n A person who is directly or indirectly involved in the provisioning of\n healthcare.\n ",
"id": "Practitioner",
"links": [],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"gender": {
"description": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.. http://hl7.org/fhir/administrative-gender",
"enum": [
"male",
"female",
"other",
"unknown"
],
"term": {
"description": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.. http://hl7.org/fhir/administrative-gender",
"termDef": {
"cde_id": "http://hl7.org/fhir/administrative-gender",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/administrative-gender",
"term_url": "http://hl7.org/fhir/administrative-gender"
}
}
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"identifier_name": {
"description": "An identifier for the person as this agent.",
"type": [
"string",
"null"
]
},
"identifier_synthea": {
"description": "An identifier for the person as this agent.",
"type": [
"string",
"null"
]
},
"name_text": {
"description": "Text representation of the full name.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"qualification_code_coding_synthea": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"qualification_code_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"qualification_issuer_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Practitioner",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"MedicationRequest.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Clinical",
"description": " Ordering of medication for patient or group.\n \n An order or request for both supply of the medication and the instructions\n for administration of the medication to a patient. The resource is called\n \"MedicationRequest\" rather than \"MedicationPrescription\" or\n \"MedicationOrder\" to generalize the use across inpatient and outpatient\n settings, including care plans, etc., and to harmonize with workflow\n patterns.\n ",
"id": "MedicationRequest",
"links": [
{
"backref": "MedicationRequests",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
{
"backref": "MedicationRequests",
"label": "Encounters",
"multiplicity": "many_to_many",
"name": "Encounters",
"required": false,
"target_type": "Encounter"
},
{
"backref": "MedicationRequests",
"label": "Medications",
"multiplicity": "many_to_many",
"name": "Medications",
"required": false,
"target_type": "Medication"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"authoredOn": {
"description": "When request was initially authored.",
"type": [
"string",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"dosageInstruction_additionalInstruction_coding_sct": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"dosageInstruction_additionalInstruction_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"dosageInstruction_asNeededBoolean": {
"description": "Take \"as needed\" (for x).",
"type": [
"boolean",
"null"
]
},
"dosageInstruction_doseAndRate_doseQuantity_value": {
"description": "Numerical value (with implicit precision).",
"type": [
"number",
"null"
]
},
"dosageInstruction_doseAndRate_type_coding_dose_rate_type": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"dosageInstruction_sequence": {
"description": "The order of the dosage instructions.",
"type": [
"number",
"null"
]
},
"dosageInstruction_text": {
"description": "Free text dosage instructions e.g. SIG.",
"type": [
"string",
"null"
]
},
"dosageInstruction_timing_repeat_frequency": {
"description": "Event occurs frequency times per period.",
"type": [
"number",
"null"
]
},
"dosageInstruction_timing_repeat_period": {
"description": "Event occurs frequency times per period.",
"type": [
"number",
"null"
]
},
"dosageInstruction_timing_repeat_periodUnit": {
"description": "s | min | h | d | wk | mo | a - unit of time (UCUM).",
"type": [
"string",
"null"
]
},
"encounter_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"intent": {
"description": "Whether the request is a proposal, plan, or an original order.. http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
"enum": [
"proposal",
"plan",
"order",
"original-order",
"reflex-order",
"filler-order",
"instance-order",
"option"
],
"term": {
"description": "Whether the request is a proposal, plan, or an original order.. http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
"termDef": {
"cde_id": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
"term_url": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent"
}
}
},
"medicationCodeableConcept_coding_rxnorm": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"medicationCodeableConcept_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"medicationReference_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"meta_profile": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"reasonReference_0_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"reasonReference_1_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"reasonReference_2_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"reasonReference_3_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"reasonReference_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"requester_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"requester_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "A code specifying the current state of the order. Generally, this will be active or completed state.. http://hl7.org/fhir/CodeSystem/medicationrequest-status",
"enum": [
"active",
"on-hold",
"cancelled",
"completed",
"entered-in-error",
"stopped",
"draft",
"unknown"
],
"term": {
"description": "A code specifying the current state of the order. Generally, this will be active or completed state.. http://hl7.org/fhir/CodeSystem/medicationrequest-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/CodeSystem/medicationrequest-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/CodeSystem/medicationrequest-status",
"term_url": "http://hl7.org/fhir/CodeSystem/medicationrequest-status"
}
}
},
"subject_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"status",
"intent"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "MedicationRequest",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"_program.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "program",
"title": "Program",
"type": "object",
"category": "administrative",
"program": "*",
"project": "*",
"description": "A broad framework of goals to be achieved. (NCIt C52647)\n",
"additionalProperties": false,
"submittable": false,
"validators": null,
"systemProperties": [
"id"
],
"required": [
"name",
"dbgap_accession_number"
],
"uniqueKeys": [
[
"id"
],
[
"name"
]
],
"links": [],
"properties": {
"type": {
"type": "string"
},
"id": {
"$ref": "_definitions.yaml#/UUID",
"systemAlias": "node_id"
},
"name": {
"type": "string",
"description": "Full name/title of the program."
},
"dbgap_accession_number": {
"type": "string",
"description": "The dbgap accession number provided for the program."
}
}
},
"_project.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "project",
"title": "Project",
"type": "object",
"program": "*",
"project": "*",
"category": "administrative",
"description": "Any specifically defined piece of work that is undertaken or attempted to meet a single requirement. (NCIt C47885)\n",
"additionalProperties": false,
"submittable": true,
"validators": null,
"systemProperties": [
"id",
"state",
"released",
"releasable",
"intended_release_date"
],
"required": [
"code",
"name",
"dbgap_accession_number",
"programs"
],
"uniqueKeys": [
[
"id"
],
[
"code"
]
],
"links": [
{
"name": "programs",
"backref": "projects",
"label": "member_of",
"target_type": "program",
"multiplicity": "many_to_one",
"required": true
}
],
"constraints": null,
"properties": {
"type": {
"type": "string"
},
"id": {
"$ref": "_definitions.yaml#/UUID",
"systemAlias": "node_id",
"description": "UUID for the project."
},
"name": {
"type": "string",
"description": "Display name/brief description for the project."
},
"code": {
"type": "string",
"description": "Unique identifier for the project."
},
"investigator_name": {
"description": "Name of the principal investigator for the project.",
"type": "string"
},
"investigator_affiliation": {
"description": "The investigator's affiliation with respect to a research institution.",
"type": "string"
},
"date_collected": {
"description": "The date or date range in which the project data was collected.",
"type": "string"
},
"availability_type": {
"description": "Is the project open or restricted?",
"enum": [
"Open",
"Restricted"
]
},
"availability_mechanism": {
"description": "Mechanism by which the project will be made avilable.",
"type": "string"
},
"support_source": {
"description": "The name of source providing support/grant resources.",
"type": "string"
},
"support_id": {
"description": "The ID of the source providing support/grant resources.",
"type": "string"
},
"programs": {
"$ref": "_definitions.yaml#/to_one",
"description": "Indicates that the project is logically part of the indicated project.\n"
},
"state": {
"description": "The possible states a project can be in. All but `open` are\nequivalent to some type of locked state.\n",
"default": "open",
"enum": [
"open",
"review",
"submitted",
"processing",
"closed",
"legacy"
]
},
"released": {
"description": "To release a project is to tell the GDC to include all submitted\nentities in the next GDC index.\n",
"default": false,
"type": "boolean"
},
"releasable": {
"description": "A project can only be released by the user when `releasable` is true.\n",
"default": false,
"type": "boolean"
},
"intended_release_date": {
"description": "Tracks a Project's intended release date.",
"type": "string",
"format": "date-time"
},
"dbgap_accession_number": {
"type": "string",
"description": "The dbgap accession number provided for the project."
}
}
},
"_definitions.yaml": {
"id": "_definitions",
"UUID": {
"term": {
"$ref": "_terms.yaml#/UUID"
},
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"parent_uuids": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/UUID"
},
"uniqueItems": true
},
"foreign_key_project": {
"type": "object",
"additionalProperties": true,
"properties": {
"id": {
"$ref": "#/UUID"
},
"code": {
"type": "string"
}
}
},
"to_one_project": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/foreign_key_project",
"minItems": 1,
"maxItems": 1
}
},
{
"$ref": "#/foreign_key_project"
}
]
},
"to_many_project": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/foreign_key_project",
"minItems": 1
}
},
{
"$ref": "#/foreign_key_project"
}
]
},
"foreign_key": {
"type": "object",
"additionalProperties": true,
"properties": {
"id": {
"$ref": "#/UUID"
},
"submitter_id": {
"type": "string"
}
}
},
"to_one": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/foreign_key",
"minItems": 1,
"maxItems": 1
}
},
{
"$ref": "#/foreign_key"
}
]
},
"to_many": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/foreign_key",
"minItems": 1
}
},
{
"$ref": "#/foreign_key"
}
]
},
"datetime": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"term": {
"$ref": "_terms.yaml#/datetime"
}
},
"file_name": {
"type": "string",
"term": {
"$ref": "_terms.yaml#/file_name"
}
},
"file_size": {
"type": "integer",
"term": {
"$ref": "_terms.yaml#/file_size"
}
},
"file_format": {
"type": "string",
"term": {
"$ref": "_terms.yaml#/file_format"
}
},
"ga4gh_drs_uri": {
"type": "string",
"term": {
"$ref": "_terms.yaml#/ga4gh_drs_uri"
}
},
"md5sum": {
"type": "string",
"term": {
"$ref": "_terms.yaml#/md5sum"
},
"pattern": "^[a-f0-9]{32}$"
},
"object_id": {
"type": "string",
"description": "The GUID of the object in the index service."
},
"release_state": {
"description": "Release state of an entity.",
"default": "unreleased",
"enum": [
"unreleased",
"released",
"redacted"
]
},
"data_bundle_state": {
"description": "State of a data bundle.",
"default": "submitted",
"enum": [
"submitted",
"validated",
"error",
"released",
"suppressed",
"redacted"
]
},
"data_file_error_type": {
"term": {
"$ref": "_terms.yaml#/data_file_error_type"
},
"enum": [
"file_size",
"file_format",
"md5sum"
]
},
"state": {
"term": {
"$ref": "_terms.yaml#/state"
},
"default": "validated",
"downloadable": [
"uploaded",
"md5summed",
"validating",
"validated",
"error",
"invalid",
"released"
],
"public": [
"live"
],
"oneOf": [
{
"enum": [
"uploading",
"uploaded",
"md5summing",
"md5summed",
"validating",
"error",
"invalid",
"suppressed",
"redacted",
"live"
]
},
{
"enum": [
"validated",
"submitted",
"released"
]
}
]
},
"file_state": {
"term": {
"$ref": "_terms.yaml#/file_state"
},
"default": "registered",
"enum": [
"registered",
"uploading",
"uploaded",
"validating",
"validated",
"submitted",
"processing",
"processed",
"released",
"error"
]
},
"qc_metrics_state": {
"term": {
"$ref": "_terms.yaml#/qc_metric_state"
},
"enum": [
"FAIL",
"PASS",
"WARN"
]
},
"project_id": {
"type": "string",
"term": {
"$ref": "_terms.yaml#/project_id"
}
},
"data_file_properties": {
"$ref": "#/ubiquitous_properties",
"file_name": {
"$ref": "#/file_name"
},
"file_size": {
"$ref": "#/file_size"
},
"file_format": {
"$ref": "#/file_format"
},
"md5sum": {
"$ref": "#/md5sum"
},
"object_id": {
"$ref": "#/object_id"
},
"file_state": {
"$ref": "#/file_state"
},
"error_type": {
"$ref": "#/data_file_error_type"
},
"ga4gh_drs_uri": {
"$ref": "#/ga4gh_drs_uri"
}
},
"workflow_properties": {
"$ref": "#/ubiquitous_properties",
"workflow_link": {
"description": "Link to Github hash for the CWL workflow used.",
"type": "string"
},
"workflow_version": {
"description": "Major version for a GDC workflow.",
"type": "string"
},
"workflow_start_datetime": {
"$ref": "#/datetime"
},
"workflow_end_datetime": {
"$ref": "#/datetime"
}
},
"ubiquitous_properties": {
"type": {
"type": "string"
},
"id": {
"$ref": "#/UUID",
"systemAlias": "node_id"
},
"submitter_id": {
"type": [
"string"
],
"description": "A project-specific identifier for a node. This property is the calling card/nickname/alias for a unit of submission. It can be used in place of the UUID for identifying or recalling a node.\n"
},
"state": {
"$ref": "#/state"
},
"project_id": {
"$ref": "#/project_id"
},
"created_datetime": {
"$ref": "#/datetime"
},
"updated_datetime": {
"$ref": "#/datetime"
}
}
},
"DiagnosticReport.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Clinical",
"description": " A Diagnostic report - a combination of request information, atomic results,\n images, interpretation, as well as formatted reports.\n \n The findings and interpretation of diagnostic tests performed on patients,\n groups of patients, devices, and locations, and/or specimens derived from\n these. The report includes clinical context such as requesting and provider\n information, and some mix of atomic results, images, textual and coded\n interpretations, and formatted representation of diagnostic reports.\n ",
"id": "DiagnosticReport",
"links": [
{
"backref": "DiagnosticReports",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
{
"backref": "DiagnosticReports",
"label": "Encounters",
"multiplicity": "many_to_many",
"name": "Encounters",
"required": false,
"target_type": "Encounter"
},
{
"backref": "DiagnosticReports",
"label": "Organizations",
"multiplicity": "many_to_many",
"name": "Organizations",
"required": false,
"target_type": "Organization"
},
{
"backref": "DiagnosticReports",
"label": "Practitioners",
"multiplicity": "many_to_many",
"name": "Practitioners",
"required": false,
"target_type": "Practitioner"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"category_coding_0_code": {
"description": "Symbol in syntax defined by the system.",
"type": [
"string",
"null"
]
},
"category_coding_0_display": {
"description": "Representation defined by the system.",
"type": [
"string",
"null"
]
},
"category_coding_0_system": {
"description": "Identity of the terminology system.",
"type": [
"string",
"null"
]
},
"category_coding_1_code": {
"description": "Symbol in syntax defined by the system.",
"type": [
"string",
"null"
]
},
"category_coding_1_display": {
"description": "Representation defined by the system.",
"type": [
"string",
"null"
]
},
"category_coding_1_system": {
"description": "Identity of the terminology system.",
"type": [
"string",
"null"
]
},
"category_coding_v2_0074": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"code_coding_0_code": {
"description": "Symbol in syntax defined by the system.",
"type": [
"string",
"null"
]
},
"code_coding_0_display": {
"description": "Representation defined by the system.",
"type": [
"string",
"null"
]
},
"code_coding_0_system": {
"description": "Identity of the terminology system.",
"type": [
"string",
"null"
]
},
"code_coding_1_code": {
"description": "Symbol in syntax defined by the system.",
"type": [
"string",
"null"
]
},
"code_coding_1_display": {
"description": "Representation defined by the system.",
"type": [
"string",
"null"
]
},
"code_coding_1_system": {
"description": "Identity of the terminology system.",
"type": [
"string",
"null"
]
},
"code_coding_loinc_org": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"code_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"effectiveDateTime": {
"description": "Clinically relevant time/time-period for report.",
"type": [
"string",
"null"
]
},
"encounter_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"issued": {
"description": "DateTime this version was made.",
"type": [
"string",
"null"
]
},
"meta_profile": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"performer_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"performer_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"presentedForm_contentType": {
"description": "Mime type of the content, with charset etc..",
"type": [
"string",
"null"
]
},
"presentedForm_data": {
"description": "Data inline, base64ed.",
"type": [
"string",
"null"
]
},
"presentedForm_url": {
"description": "Uri where the data can be found.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"result_0_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_0_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_10_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_10_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_11_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_11_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_12_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_12_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_13_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_13_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_14_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_14_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_15_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_15_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_16_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_16_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_17_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_17_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_18_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_18_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_19_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_19_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_1_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_1_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_20_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_20_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_21_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_21_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_22_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_22_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_23_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_23_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_24_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_24_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_25_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_25_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_26_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_26_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_27_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_27_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_28_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_28_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_29_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_29_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_2_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_2_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_30_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_30_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_31_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_31_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_32_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_32_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_33_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_33_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_34_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_34_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_35_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_35_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_36_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_36_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_37_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_37_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_38_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_38_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_39_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_39_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_3_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_3_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_40_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_40_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_41_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_41_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_42_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_42_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_43_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_43_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_44_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_44_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_45_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_45_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_46_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_46_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_47_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_47_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_48_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_48_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_49_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_49_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_4_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_4_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_50_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_50_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_5_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_5_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_6_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_6_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_7_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_7_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_8_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_8_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_9_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_9_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"result_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"result_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"specimen_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "The status of the diagnostic report.. http://hl7.org/fhir/diagnostic-report-status",
"enum": [
"registered",
"partial",
"preliminary",
"final",
"amended",
"corrected",
"appended",
"cancelled",
"entered-in-error",
"unknown"
],
"term": {
"description": "The status of the diagnostic report.. http://hl7.org/fhir/diagnostic-report-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/diagnostic-report-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/diagnostic-report-status",
"term_url": "http://hl7.org/fhir/diagnostic-report-status"
}
}
},
"subject_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"status"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "DiagnosticReport",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"_settings.yaml": {
"enable_case_cache": false,
"_dict_commit": "520a25999fd183f6c5b7ddef2980f3e839517da5",
"_dict_version": "0.2.1-9-g520a259"
},
"Task.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Analysis",
"description": " A task to be performed.\n ",
"id": "Task",
"links": [
{
"backref": "Tasks",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
{
"backref": "Tasks",
"label": "Specimen",
"multiplicity": "many_to_many",
"name": "Specimen",
"required": true,
"target_type": "Specimen"
},
{
"backref": "Tasks",
"label": "DocumentReferences",
"multiplicity": "many_to_many",
"name": "DocumentReferences",
"required": true,
"target_type": "DocumentReference"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"focus_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"for_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"input_type_coding_": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"input_valueReference_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"intent": {
"description": "unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option.",
"type": [
"string"
]
},
"output_type_coding_": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"output_valueReference_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "The current status of the task.. http://hl7.org/fhir/task-status",
"enum": [
"draft",
"requested",
"received",
"accepted",
"rejected",
"ready",
"cancelled",
"in-progress",
"on-hold",
"failed",
"completed",
"entered-in-error"
],
"term": {
"description": "The current status of the task.. http://hl7.org/fhir/task-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/task-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/task-status",
"term_url": "http://hl7.org/fhir/task-status"
}
}
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"text_div": {
"description": "Limited xhtml content.",
"type": [
"string"
]
},
"text_status": {
"description": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.. http://hl7.org/fhir/narrative-status",
"enum": [
"generated",
"extensions",
"additional",
"empty"
],
"term": {
"description": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.. http://hl7.org/fhir/narrative-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/narrative-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/narrative-status",
"term_url": "http://hl7.org/fhir/narrative-status"
}
}
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"text_status",
"text_div",
"status",
"intent"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Task",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Condition.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Clinical",
"description": " Detailed information about conditions, problems or diagnoses.\n \n A clinical condition, problem, diagnosis, or other event, situation, issue,\n or clinical concept that has risen to a level of concern.\n ",
"id": "Condition",
"links": [
{
"backref": "Conditions",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
{
"backref": "Conditions",
"label": "Encounters",
"multiplicity": "many_to_many",
"name": "Encounters",
"required": true,
"target_type": "Encounter"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"abatementDateTime": {
"description": "When in resolution/remission.",
"type": [
"string",
"null"
]
},
"category_coding_condition_category": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"clinicalStatus_coding_condition_clinical": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"code_coding_sct": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"code_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"encounter_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"meta_profile": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"onsetDateTime": {
"description": "Estimated or actual date, date-time, or age.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"recordedDate": {
"description": "Date record was first recorded.",
"type": [
"string",
"null"
]
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"subject_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"verificationStatus_coding_condition_ver_status": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
}
},
"required": [
"submitter_id",
"type"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Condition",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Location.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Administrative",
"description": " Details and position information for a physical place.\n \n Details and position information for a physical place where services are\n provided and resources and participants may be stored, found, contained, or\n accommodated.\n ",
"id": "Location",
"links": [
{
"backref": "Locations",
"label": "Organizations",
"multiplicity": "many_to_many",
"name": "Organizations",
"required": true,
"target_type": "Organization"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"address_city": {
"description": "Name of city, town etc..",
"type": [
"string",
"null"
]
},
"address_line": {
"description": "Street name, number, direction & P.O. Box etc..",
"type": [
"string",
"null"
]
},
"address_postalCode": {
"description": "Postal code for area.",
"type": [
"string",
"null"
]
},
"address_state": {
"description": "Sub-unit of country (abbreviations ok).",
"type": [
"string",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"identifier_name": {
"description": "Unique code or number identifying the location to its users.",
"type": [
"string",
"null"
]
},
"managingOrganization_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"position_latitude": {
"description": "Latitude with WGS84 datum.",
"type": [
"number"
]
},
"position_longitude": {
"description": "Longitude with WGS84 datum.",
"type": [
"number"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"position_longitude",
"position_latitude"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Location",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Encounter.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Clinical",
"description": " An interaction during which services are provided to the patient.\n \n An interaction between a patient and healthcare provider(s) for the purpose\n of providing healthcare service(s) or assessing the health status of a\n patient.\n ",
"id": "Encounter",
"links": [
{
"backref": "Encounters",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"class_v3_ActCode": {
"description": "Classification of patient encounter.",
"type": [
"string"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"hospitalization_dischargeDisposition_coding_patient_discharge": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"hospitalization_dischargeDisposition_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"identifier_synthea": {
"description": "Identifier(s) by which this encounter is known.",
"type": [
"string",
"null"
]
},
"location_location_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"location_location_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"meta_profile": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"participant_individual_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"participant_individual_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"participant_period_end": {
"description": "End time with inclusive boundary, if not ongoing.",
"type": [
"string",
"null"
]
},
"participant_period_start": {
"description": "Starting time with inclusive boundary.",
"type": [
"string",
"null"
]
},
"participant_type_coding_v3_ParticipationType": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"participant_type_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"period_end": {
"description": "End time with inclusive boundary, if not ongoing.",
"type": [
"string",
"null"
]
},
"period_start": {
"description": "Starting time with inclusive boundary.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"reasonCode_coding_sct": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"serviceProvider_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"serviceProvider_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "None. http://hl7.org/fhir/encounter-status",
"enum": [
"planned",
"arrived",
"triaged",
"in-progress",
"onleave",
"finished",
"cancelled",
"entered-in-error",
"unknown"
],
"term": {
"description": "None. http://hl7.org/fhir/encounter-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/encounter-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/encounter-status",
"term_url": "http://hl7.org/fhir/encounter-status"
}
}
},
"subject_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"subject_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"type_coding_sct": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"type_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"status",
"class_v3_ActCode"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Encounter",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Procedure.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Clinical",
"description": " An action that is being or was performed on a patient.\n \n An action that is or was performed on or for a patient. This can be a\n physical intervention like an operation, or less invasive like long term\n services, counseling, or hypnotherapy.\n ",
"id": "Procedure",
"links": [
{
"backref": "Procedures",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
{
"backref": "Procedures",
"label": "Encounters",
"multiplicity": "many_to_many",
"name": "Encounters",
"required": false,
"target_type": "Encounter"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"code_coding_sct": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"code_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"encounter_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"location_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"location_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"meta_profile": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"performedPeriod_end": {
"description": "End time with inclusive boundary, if not ongoing.",
"type": [
"string",
"null"
]
},
"performedPeriod_start": {
"description": "Starting time with inclusive boundary.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"reasonReference_0_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"reasonReference_0_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"reasonReference_1_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"reasonReference_1_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"reasonReference_2_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"reasonReference_2_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"reasonReference_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"reasonReference_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.. http://hl7.org/fhir/event-status",
"enum": [
"preparation",
"in-progress",
"not-done",
"on-hold",
"stopped",
"completed",
"entered-in-error",
"unknown"
],
"term": {
"description": "A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.. http://hl7.org/fhir/event-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/event-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/event-status",
"term_url": "http://hl7.org/fhir/event-status"
}
}
},
"subject_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"status"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Procedure",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Organization.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Administrative",
"description": " A grouping of people or organizations with a common purpose.\n \n A formally or informally recognized grouping of people or organizations\n formed for the purpose of achieving some form of collective action.\n Includes companies, institutions, corporations, departments, community\n groups, healthcare practice groups, payer/insurer, etc.\n ",
"id": "Organization",
"links": [
{
"backref": "Organizations",
"label": "Organizations",
"multiplicity": "many_to_many",
"name": "Organizations",
"required": false,
"target_type": "Organization"
},
{
"backref": "DiagnosticReports",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"identifier_name": {
"description": "Identifies this organization across multiple systems.",
"type": [
"string",
"null"
]
},
"identifier_synthea": {
"description": "Identifies this organization across multiple systems.",
"type": [
"string",
"null"
]
},
"name": {
"description": "Name used for the organization.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"telecom_system": {
"description": "Telecommunications form for contact point - what communications system is required to make use of the contact.. http://hl7.org/fhir/contact-point-system",
"enum": [
"phone",
"fax",
"email",
"pager",
"url",
"sms",
"other"
],
"term": {
"description": "Telecommunications form for contact point - what communications system is required to make use of the contact.. http://hl7.org/fhir/contact-point-system",
"termDef": {
"cde_id": "http://hl7.org/fhir/contact-point-system",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/contact-point-system",
"term_url": "http://hl7.org/fhir/contact-point-system"
}
}
},
"telecom_value": {
"description": "The actual contact point details.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Organization",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"_terms.yaml": {
"id": "_terms",
"data_category": {
"description": "Broad categorization of the contents of the data file.\n"
},
"data_file_error_type": {
"description": "Type of error for the data file object.\n"
},
"data_format": {
"description": "Format of the data files.\n"
},
"data_type": {
"description": "Specific content type of the data file. (CMG)\n"
},
"datetime": {
"description": "A combination of date and time of day in the form [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]\n"
},
"encoding": {
"description": "Version of ASCII encoding of quality values found in the file.\n",
"termDef": {
"term": "Encoding",
"source": "FastQC",
"cde_id": null,
"cde_version": null,
"term_url": "http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/3%20Analysis%20Modules/1%20Basic%20Statistics.html"
}
},
"file_format": {
"description": "The format of the data file object.\n"
},
"file_name": {
"description": "The name (or part of a name) of a file (of any type).\n"
},
"file_size": {
"description": "The size of the data file (object) in bytes.\n"
},
"file_state": {
"description": "The current state of the data file object.\n"
},
"md5sum": {
"description": "The 128-bit hash value expressed as a 32 digit hexadecimal number used as a file's digital fingerprint.\n"
},
"project_id": {
"description": "Unique ID for any specific defined piece of work that is undertaken or attempted to meet a single requirement.\n"
},
"state": {
"description": "The current state of the object.\n"
},
"UUID": {
"description": "A 128-bit identifier. Depending on the mechanism used to generate it, it is either guaranteed to be different from all other UUIDs/GUIDs generated until 3400 AD or extremely likely to be different. Its relatively small size lends itself well to sorting, ordering, and hashing of all sorts, storing in databases, simple allocation, and ease of programming in general.\n",
"termDef": {
"term": "Universally Unique Identifier",
"source": "NCIt",
"cde_id": "C54100",
"cde_version": null,
"term_url": "https://ncit.nci.nih.gov/ncitbrowser/ConceptReport.jsp?dictionary=NCI_Thesaurus&version=16.02d&ns=NCI_Thesaurus&code=C54100"
}
},
"microsatellite_instability_abnormal": {
"description": "The yes/no indicator to signify the status of a tumor for microsatellite instability.\n",
"termDef": {
"term": "Microsatellite Instability Occurrence Indicator",
"source": "caDSR",
"cde_id": 3123142,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3123142&version=1.0"
}
},
"morphology": {
"description": "The third edition of the International Classification of Diseases for Oncology, published in 2000 used principally in tumor and cancer registries for coding the site (topography) and the histology (morphology) of neoplasms. The study of the structure of the cells and their arrangement to constitute tissues and, finally, the association among these to form organs. In pathology, the microscopic process of identifying normal and abnormal morphologic characteristics in tissues, by employing various cytochemical and immunocytochemical stains. A system of numbered categories for representation of data.\n",
"termDef": {
"term": "International Classification of Diseases for Oncology, Third Edition ICD-O-3 Histology Code",
"source": "caDSR",
"cde_id": 3226275,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3226275&version=1.0"
}
},
"new_event_anatomic_site": {
"description": "Text term to specify the anatomic location of the return of tumor after treatment.\n",
"termDef": {
"term": "New Neoplasm Event Occurrence Anatomic Site",
"source": "caDSR",
"cde_id": 3108271,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3108271&version=2.0"
}
},
"new_event_type": {
"description": "Text term to identify a new tumor event.\n",
"termDef": {
"term": "New Neoplasm Event Type",
"source": "caDSR",
"cde_id": 3119721,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3119721&version=1.0"
}
},
"normal_tumor_genotype_snp_match": {
"description": "Text term that represents whether or not the genotype of the normal tumor matches or if the data is not available.\n",
"termDef": {
"term": "Normal Tumor Genotype Match Indicator",
"source": "caDSR",
"cde_id": 4588156,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=4588156&version=1.0"
}
},
"number_proliferating_cells": {
"description": "Numeric value that represents the count of proliferating cells determined during pathologic review of the sample slide(s).\n",
"termDef": {
"term": "Pathology Review Slide Proliferating Cell Count",
"source": "caDSR",
"cde_id": 5432636,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432636&version=1.0"
}
},
"oct_embedded": {
"description": "Indicator of whether or not the sample was embedded in Optimal Cutting Temperature (OCT) compound.\n",
"termDef": {
"term": "Tissue Sample Optimal Cutting Temperature Compound Embedding Indicator",
"source": "caDSR",
"cde_id": 5432538,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432538&version=1.0"
}
},
"years_smoked": {
"description": "Numeric value (or unknown) to represent the number of years a person has been smoking (HARMONIZED). If the number of years is greater than 89, see 'years_smoked_gt89'.\n",
"termDef": {
"term": "Person Smoking Duration Year Count",
"source": "caDSR",
"cde_id": 3137957,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3137957&version=1.0"
}
},
"percent_eosinophil_infiltration": {
"description": "Numeric value to represent the percentage of infiltration by eosinophils in a tumor sample or specimen.\n",
"termDef": {
"term": "Specimen Eosinophilia Percentage Value",
"source": "caDSR",
"cde_id": 2897700,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897700&version=2.0"
}
},
"percent_gc_content": {
"description": "The overall %GC of all bases in all sequences.\n",
"termDef": {
"term": "%GC",
"source": "FastQC",
"cde_id": null,
"cde_version": null,
"term_url": "http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/3%20Analysis%20Modules/1%20Basic%20Statistics.html"
}
},
"percent_granulocyte_infiltration": {
"description": "Numeric value to represent the percentage of infiltration by granulocytes in a tumor sample or specimen.\n",
"termDef": {
"term": "Specimen Granulocyte Infiltration Percentage Value",
"source": "caDSR",
"cde_id": 2897705,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897705&version=2.0"
}
},
"percent_inflam_infiltration": {
"description": "Numeric value to represent local response to cellular injury, marked by capillary dilatation, edema and leukocyte infiltration; clinically, inflammation is manifest by reddness, heat, pain, swelling and loss of function, with the need to heal damaged tissue.\n",
"termDef": {
"term": "Specimen Inflammation Change Percentage Value",
"source": "caDSR",
"cde_id": 2897695,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897695&version=1.0"
}
},
"percent_lymphocyte_infiltration": {
"description": "Numeric value to represent the percentage of infiltration by lymphocytes in a solid tissue normal sample or specimen.\n",
"termDef": {
"term": "Specimen Lymphocyte Infiltration Percentage Value",
"source": "caDSR",
"cde_id": 2897710,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897710&version=2.0"
}
},
"percent_monocyte_infiltration": {
"description": "Numeric value to represent the percentage of monocyte infiltration in a sample or specimen.\n",
"termDef": {
"term": "Specimen Monocyte Infiltration Percentage Value",
"source": "caDSR",
"cde_id": 5455535,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5455535&version=1.0"
}
},
"percent_necrosis": {
"description": "Numeric value to represent the percentage of cell death in a malignant tumor sample or specimen.\n",
"termDef": {
"term": "Malignant Neoplasm Necrosis Percentage Value",
"source": "caDSR",
"cde_id": 2841237,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841237&version=1.0"
}
},
"percent_neutrophil_infiltration": {
"description": "Numeric value to represent the percentage of infiltration by neutrophils in a tumor sample or specimen.\n",
"termDef": {
"term": "Malignant Neoplasm Neutrophil Infiltration Percentage Cell Value",
"source": "caDSR",
"cde_id": 2841267,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841267&version=1.0"
}
},
"percent_normal_cells": {
"description": "Numeric value to represent the percentage of normal cell content in a malignant tumor sample or specimen.\n",
"termDef": {
"term": "Malignant Neoplasm Normal Cell Percentage Value",
"source": "caDSR",
"cde_id": 2841233,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841233&version=1.0"
}
},
"percent_stromal_cells": {
"description": "Numeric value to represent the percentage of reactive cells that are present in a malignant tumor sample or specimen but are not malignant such as fibroblasts, vascular structures, etc.\n",
"termDef": {
"term": "Malignant Neoplasm Stromal Cell Percentage Value",
"source": "caDSR",
"cde_id": 2841241,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841241&version=1.0"
}
},
"percent_tumor_cells": {
"description": "Numeric value that represents the percentage of infiltration by granulocytes in a sample.\n",
"termDef": {
"term": "Specimen Tumor Cell Percentage Value",
"source": "caDSR",
"cde_id": 5432686,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432686&version=1.0"
}
},
"percent_tumor_nuclei": {
"description": "Numeric value to represent the percentage of tumor nuclei in a malignant neoplasm sample or specimen.\n",
"termDef": {
"term": "Malignant Neoplasm Neoplasm Nucleus Percentage Cell Value",
"source": "caDSR",
"cde_id": 2841225,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841225&version=1.0"
}
},
"perineural_invasion_present": {
"description": "a yes/no indicator to ask if perineural invasion or infiltration of tumor or cancer is present.\n",
"termDef": {
"term": "Tumor Perineural Invasion Ind",
"source": "caDSR",
"cde_id": 64181,
"cde_version": 3,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=64181&version=3.0"
}
},
"platform": {
"description": "Name of the platform used to obtain data.\n"
},
"portion_number": {
"description": "Numeric value that represents the sequential number assigned to a portion of the sample.\n",
"termDef": {
"term": "Biospecimen Portion Sequence Number",
"source": "caDSR",
"cde_id": 5432711,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432711&version=1.0"
}
},
"portion_weight": {
"description": "Numeric value that represents the sample portion weight, measured in milligrams.\n",
"termDef": {
"term": "Biospecimen Portion Weight Milligram Value",
"source": "caDSR",
"cde_id": 5432593,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432593&version=1.0"
}
},
"preservation_method": {
"description": "Text term that represents the method used to preserve the sample.\n",
"termDef": {
"term": "Tissue Sample Preservation Method Type",
"source": "caDSR",
"cde_id": 5432521,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432521&version=1.0"
}
},
"prior_malignancy": {
"description": "Text term to describe the patient's history of prior cancer diagnosis and the spatial location of any previous cancer occurrence.\n",
"termDef": {
"term": "Prior Cancer Diagnosis Occurrence Description Text",
"source": "caDSR",
"cde_id": 3382736,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3382736&version=2.0"
}
},
"prior_treatment": {
"description": "A yes/no/unknown/not applicable indicator related to the administration of therapeutic agents received before the body specimen was collected.\n",
"termDef": {
"term": "Therapeutic Procedure Prior Specimen Collection Administered Yes No Unknown Not Applicable Indicator",
"source": "caDSR",
"cde_id": 4231463,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=4231463&version=1.0"
}
},
"progesterone_receptor_percent_positive_ihc": {
"description": "Classification to represent Progesterone Receptor Positive results expressed as a percentage value.\n",
"termDef": {
"term": "Progesterone Receptor Level Cell Percentage Category",
"source": "caDSR",
"cde_id": 3128342,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3128342&version=1.0"
}
},
"progesterone_receptor_result_ihc": {
"description": "Text term to represent the overall result of Progresterone Receptor (PR) testing.\n",
"termDef": {
"term": "Breast Carcinoma Progesterone Receptor Status",
"source": "caDSR",
"cde_id": 2957357,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2957357&version=2.0"
}
},
"progression_or_recurrence": {
"description": "Yes/No/Unknown indicator to identify whether a patient has had a new tumor event after initial treatment.\n",
"termDef": {
"term": "New Neoplasm Event Post Initial Therapy Indicator",
"source": "caDSR",
"cde_id": 3121376,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3121376&version=1.0"
}
},
"qc_metric_state": {
"description": "State classification given by FASTQC for the metric. Metric specific details about the states are available on their website.\n",
"termDef": {
"term": "QC Metric State",
"source": "FastQC",
"cde_id": null,
"cde_version": null,
"term_url": "http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/3%20Analysis%20Modules/"
}
},
"race": {
"description": "An arbitrary classification of a taxonomic group that is a division of a species (HARMONIZED). It usually arises as a consequence of geographical isolation within a species and is characterized by shared heredity, physical attributes and behavior, and in the case of humans, by common history, nationality, or geographic distribution. The provided values are based on the categories defined by the U.S. Office of Management and Business and used by the U.S. Census Bureau. (GTEx)\n",
"termDef": {
"term": "Race Category Text",
"source": "caDSR",
"cde_id": 2192199,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2192199&version=1.0"
}
},
"read_length": {
"description": "The length of the reads.\n"
},
"read_group_name": {
"description": "The name of the read group.\n"
},
"relationship_age_at_diagnosis": {
"description": "The age (in years) when the patient's relative was first diagnosed.\n",
"termDef": {
"term": "Relative Diagnosis Age Value",
"source": "caDSR",
"cde_id": 5300571,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5300571&version=1.0"
}
},
"relationship_to_proband": {
"description": "The subgroup that describes the state of connectedness between members of the unit of society organized around kinship ties.\n",
"termDef": {
"term": "Family Member Relationship Type",
"source": "caDSR",
"cde_id": 2690165,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2690165&version=2.0"
}
},
"relationship_type": {
"description": "The subgroup that describes the state of connectedness between members of the unit of society organized around kinship ties.\n",
"termDef": {
"term": "Family Member Relationship Type",
"source": "caDSR",
"cde_id": 2690165,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2690165&version=2.0"
}
},
"relative_with_cancer_history": {
"description": "Indicator to signify whether or not an individual's biological relative has been diagnosed with another type of cancer.\n",
"termDef": {
"term": "Other Cancer Biological Relative History Indicator",
"source": "caDSR",
"cde_id": 3901752,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3901752&version=1.0"
}
},
"residual_disease": {
"description": "Text terms to describe the status of a tissue margin following surgical resection.\n",
"termDef": {
"term": "Surgical Margin Resection Status",
"source": "caDSR",
"cde_id": 2608702,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2608702&version=1.0"
}
},
"RIN": {
"description": "A numerical assessment of the integrity of RNA based on the entire electrophoretic trace of the RNA sample including the presence or absence of degradation products.\n",
"termDef": {
"term": "Biospecimen RNA Integrity Number Value",
"source": "caDSR",
"cde_id": 5278775,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5278775&version=1.0"
}
},
"sample_type": {
"description": "Text term to describe the source of a biospecimen used for a laboratory test.\n",
"termDef": {
"term": "Specimen Type Collection Biospecimen Type",
"source": "caDSR",
"cde_id": 3111302,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3111302&version=2.0"
}
},
"sample_type_id": {
"description": "The accompanying sample type id for the sample type.\n"
},
"section_location": {
"description": "Tissue source of the slide.\n"
},
"sequencing_center": {
"description": "Name of the center that provided the sequence files.\n"
},
"shortest_dimension": {
"description": "Numeric value that represents the shortest dimension of the sample, measured in millimeters.\n",
"termDef": {
"term": "Tissue Sample Short Dimension Millimeter Measurement",
"source": "caDSR",
"cde_id": 5432603,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432603&version=1.0"
}
},
"site_of_resection_or_biopsy": {
"description": "The third edition of the International Classification of Diseases for Oncology, published in 2000, used principally in tumor and cancer registries for coding the site (topography) and the histology (morphology) of neoplasms. The description of an anatomical region or of a body part. Named locations of, or within, the body. A system of numbered categories for representation of data.\n",
"termDef": {
"term": "International Classification of Diseases for Oncology, Third Edition ICD-O-3 Site Code",
"source": "caDSR",
"cde_id": 3226281,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3226281&version=1.0"
}
},
"size_selection_range": {
"description": "Range of size selection.\n"
},
"smoking_history": {
"description": "Category describing current smoking status and smoking history as self-reported by a patient.\n",
"termDef": {
"term": "Smoking History",
"source": "caDSR",
"cde_id": 2181650,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2181650&version=1.0"
}
},
"smoking_intensity": {
"description": "Numeric computed value to represent lifetime tobacco exposure defined as number of cigarettes smoked per day x number of years smoked divided by 20\n",
"termDef": {
"term": "Person Cigarette Smoking History Pack Year Value",
"source": "caDSR",
"cde_id": 2955385,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2955385&version=1.0"
}
},
"source_center": {
"description": "Name of the center that provided the item.\n"
},
"spectrophotometer_method": {
"description": "Name of the method used to determine the concentration of purified nucleic acid within a solution.\n",
"termDef": {
"term": "Purification Nucleic Acid Solution Concentration Determination Method Type",
"source": "caDSR",
"cde_id": 3008378,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3008378&version=1.0"
}
},
"spike_ins_fasta": {
"description": "Name of the FASTA file that contains the spike-in sequences.\n"
},
"spike_ins_concentration": {
"description": "Spike in concentration.\n"
},
"target_capture_kit_name": {
"description": "Name of Target Capture Kit.\n"
},
"target_capture_kit_vendor": {
"description": "Vendor of Target Capture Kit.\n"
},
"target_capture_kit_catalog_number": {
"description": "Catalog of Target Capture Kit.\n"
},
"target_capture_kit_version": {
"description": "Version of Target Capture Kit.\n"
},
"target_capture_kit_target_region": {
"description": "Target Capture Kit BED file.\n"
},
"therapeutic_agents": {
"description": "Text identification of the individual agent(s) used as part of a prior treatment regimen.\n",
"termDef": {
"term": "Prior Therapy Regimen Text",
"source": "caDSR",
"cde_id": 2975232,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2975232&version=1.0"
}
},
"time_between_clamping_and_freezing": {
"description": "Numeric representation of the elapsed time between the surgical clamping of blood supply and freezing of the sample, measured in minutes.\n",
"termDef": {
"term": "Tissue Sample Clamping and Freezing Elapsed Minute Time",
"source": "caDSR",
"cde_id": 5432611,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432611&version=1.0"
}
},
"time_between_excision_and_freezing": {
"description": "Numeric representation of the elapsed time between the excision and freezing of the sample, measured in minutes.\n",
"termDef": {
"term": "Tissue Sample Excision and Freezing Elapsed Minute Time",
"source": "caDSR",
"cde_id": 5432612,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432612&version=1.0"
}
},
"tissue_or_organ_of_origin": {
"description": "Text term that describes the anatomic site of the tumor or disease.\n",
"termDef": {
"term": "Tumor Disease Anatomic Site",
"source": "caDSR",
"cde_id": 3427536,
"cde_version": 3,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3427536&version=3.0"
}
},
"tissue_type": {
"description": "Text term that represents a description of the kind of tissue collected with respect to disease status or proximity to tumor tissue.\n",
"termDef": {
"term": "Tissue Sample Description Type",
"source": "caDSR",
"cde_id": 5432687,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432687&version=1.0"
}
},
"to_trim_adapter_sequence": {
"description": "Does the user suggest adapter trimming?\n"
},
"tobacco_smoking_onset_year": {
"description": "The year in which the participant began smoking.\n",
"termDef": {
"term": "Started Smoking Year",
"source": "caDSR",
"cde_id": 2228604,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2228604&version=1.0"
}
},
"tobacco_smoking_quit_year": {
"description": "The year in which the participant quit smoking.\n",
"termDef": {
"term": "Stopped Smoking Year",
"source": "caDSR",
"cde_id": 2228610,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2228610&version=1.0"
}
},
"tobacco_smoking_status": {
"description": "Category describing current smoking status and smoking history as self-reported by a patient.\n",
"termDef": {
"term": "Patient Smoking History Category",
"source": "caDSR",
"cde_id": 2181650,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2181650&version=1.0"
}
},
"total_sequences": {
"description": "A count of the total number of sequences processed.\n",
"termDef": {
"term": "Total Sequences",
"source": "FastQC",
"cde_id": null,
"cde_version": null,
"term_url": "http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/3%20Analysis%20Modules/1%20Basic%20Statistics.html"
}
},
"treatment_anatomic_site": {
"description": "The anatomic site or field targeted by a treatment regimen or single agent therapy.\n",
"termDef": {
"term": "Treatment Anatomic Site",
"source": null,
"cde_id": null,
"cde_version": null,
"term_url": null
}
},
"treatment_intent_type": {
"description": "Text term to identify the reason for the administration of a treatment regimen. [Manually-curated]\n",
"termDef": {
"term": "Treatment Regimen Intent Type",
"source": "caDSR",
"cde_id": 2793511,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2793511&version=1.0"
}
},
"treatment_or_therapy": {
"description": "A yes/no/unknown/not applicable indicator related to the administration of therapeutic agents received before the body specimen was collected.\n",
"termDef": {
"term": "Therapeutic Procedure Prior Specimen Collection Administered Yes No Unknown Not Applicable Indicator",
"source": "caDSR",
"cde_id": 4231463,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=4231463&version=1.0"
}
},
"treatment_outcome": {
"description": "Text term that describes the patient¿s final outcome after the treatment was administered.\n",
"termDef": {
"term": "Treatment Outcome Type",
"source": "caDSR",
"cde_id": 5102383,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5102383&version=1.0"
}
},
"treatment_type": {
"description": "Text term that describes the kind of treatment administered.\n",
"termDef": {
"term": "Treatment Method Type",
"source": "caDSR",
"cde_id": 5102381,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5102381&version=1.0"
}
},
"tumor_grade": {
"description": "Numeric value to express the degree of abnormality of cancer cells, a measure of differentiation and aggressiveness.\n",
"termDef": {
"term": "Neoplasm Histologic Grade",
"source": "caDSR",
"cde_id": 2785839,
"cde_version": 2,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2785839&version=2.0"
}
},
"tumor_code": {
"description": "Diagnostic tumor code of the tissue sample source.\n"
},
"tumor_code_id": {
"description": "BCR-defined id code for the tumor sample.\n"
},
"tumor_descriptor": {
"description": "Text that describes the kind of disease present in the tumor specimen as related to a specific timepoint.\n",
"termDef": {
"term": "Tumor Tissue Disease Description Type",
"source": "caDSR",
"cde_id": 3288124,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3288124&version=1.0"
}
},
"tumor_stage": {
"description": "The extent of a cancer in the body. Staging is usually based on the size of the tumor, whether lymph nodes contain cancer, and whether the cancer has spread from the original site to other parts of the body. The accepted values for tumor_stage depend on the tumor site, type, and accepted staging system. These items should accompany the tumor_stage value as associated metadata.\n",
"termDef": {
"term": "Tumor Stage",
"source": "NCIt",
"cde_id": "C16899",
"cde_version": null,
"term_url": "https://ncit.nci.nih.gov/ncitbrowser/pages/concept_details.jsf?dictionary=NCI%20Thesaurus&code=C16899"
}
},
"vascular_invasion_present": {
"description": "The yes/no indicator to ask if large vessel or venous invasion was detected by surgery or presence in a tumor specimen.\n",
"termDef": {
"term": "Tumor Vascular Invasion Ind-3",
"source": "caDSR",
"cde_id": 64358,
"cde_version": 3,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=64358&version=3.0"
}
},
"vital_status": {
"description": "The survival state of the person registered on the protocol.\n",
"termDef": {
"term": "Patient Vital Status",
"source": "caDSR",
"cde_id": 5,
"cde_version": 5,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5&version=5.0"
}
},
"weight": {
"description": "The weight of the patient measured in lbs (HARMONIZED).\n",
"termDef": {
"term": "Patient Weight Measurement",
"source": "caDSR",
"cde_id": 651,
"cde_version": 4,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=651&version=4.0"
}
},
"well_number": {
"description": "Numeric value that represents the the well location within a plate for the analyte or aliquot from the sample.\n",
"termDef": {
"term": "Biospecimen Analyte or Aliquot Plate Well Number",
"source": "caDSR",
"cde_id": 5432613,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432613&version=1.0"
}
},
"workflow_type": {
"description": "Generic name for the workflow used to analyze a data set.\n"
},
"year_of_birth": {
"description": "Numeric value to represent the calendar year in which an individual was born.\n",
"termDef": {
"term": "Year Birth Date Number",
"source": "caDSR",
"cde_id": 2896954,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2896954&version=1.0"
}
},
"year_of_diagnosis": {
"description": "Numeric value to represent the year of an individual's initial pathologic diagnosis of cancer.\n",
"termDef": {
"term": "Year of initial pathologic diagnosis",
"source": "caDSR",
"cde_id": 2896960,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2896960&version=1.0"
}
},
"year_of_death": {
"description": "Numeric value to represent the year of the death of an individual.\n",
"termDef": {
"term": "Year Death Number",
"source": "caDSR",
"cde_id": 2897030,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897030&version=1.0"
}
},
"years_smoked_gt89": {
"description": "Indicate whether the numeric value to represent the number of years a person has been smoking (HARMONIZED) is greater than 89 years.\n",
"termDef": {
"term": "Person Smoking Duration Year Count",
"source": "caDSR",
"cde_id": 3137957,
"cde_version": 1,
"term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3137957&version=1.0"
}
},
"ga4gh_drs_uri": {
"description": "DRS URI as defined by GA4GH DRS spec for pointers to file objects.\n"
}
},
"ImagingStudy.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Clinical",
"description": " A set of images produced in single study (one or more series of references\n images).\n \n Representation of the content produced in a DICOM imaging study. A study\n comprises a set of series, each of which includes a set of Service-Object\n Pair Instances (SOP Instances - images or other data) acquired or produced\n in a common context. A series is of only one modality (e.g. X-ray, CT, MR,\n ultrasound), but a study may have multiple series of different modalities.\n ",
"id": "ImagingStudy",
"links": [
{
"backref": "ImagingStudies",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
{
"backref": "ImagingStudies",
"label": "Encounters",
"multiplicity": "many_to_many",
"name": "Encounters",
"required": false,
"target_type": "Encounter"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"encounter_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"identifier_urn_ietf_rfc_3986": {
"description": "Identifiers for the whole study.",
"type": [
"string",
"null"
]
},
"location_display": {
"description": "Text alternative for the resource.",
"type": [
"string",
"null"
]
},
"location_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"numberOfInstances": {
"description": "Number of Study Related Instances.",
"type": [
"number",
"null"
]
},
"numberOfSeries": {
"description": "Number of Study Related Series.",
"type": [
"number",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"series_bodySite_sct": {
"description": "Body part examined.",
"type": [
"string",
"null"
]
},
"series_instance_number": {
"description": "The number of this instance in the series.",
"type": [
"number",
"null"
]
},
"series_instance_sopClass_urn_ietf_rfc_3986": {
"description": "DICOM class type.",
"type": [
"string"
]
},
"series_instance_title": {
"description": "Description of instance.",
"type": [
"string",
"null"
]
},
"series_instance_uid": {
"description": "DICOM SOP Instance UID.",
"type": [
"string"
]
},
"series_modality_sect_CID_29_html": {
"description": "The modality of the instances in the series.",
"type": [
"string"
]
},
"series_number": {
"description": "Numeric identifier of this series.",
"type": [
"number",
"null"
]
},
"series_numberOfInstances": {
"description": "Number of Series Related Instances.",
"type": [
"number",
"null"
]
},
"series_started": {
"description": "When the series started.",
"type": [
"string",
"null"
]
},
"series_uid": {
"description": "DICOM Series Instance UID for the series.",
"type": [
"string"
]
},
"started": {
"description": "When the study was started.",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "The current state of the ImagingStudy.. http://hl7.org/fhir/imagingstudy-status",
"enum": [
"registered",
"available",
"cancelled",
"entered-in-error",
"unknown"
],
"term": {
"description": "The current state of the ImagingStudy.. http://hl7.org/fhir/imagingstudy-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/imagingstudy-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/imagingstudy-status",
"term_url": "http://hl7.org/fhir/imagingstudy-status"
}
}
},
"subject_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"status",
"series_uid",
"series_modality_sect_CID_29_html",
"series_instance_uid",
"series_instance_sopClass_urn_ietf_rfc_3986"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "ImagingStudy",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"ResearchStudy.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Administrative",
"description": " Investigation to increase healthcare-related patient-independent knowledge.\n \n A process where a researcher or organization plans and then executes a\n series of steps intended to increase the field of healthcare-related\n knowledge. This includes studies of safety, efficacy, comparative\n effectiveness and other information about medications, devices, therapies\n and other interventional and investigative techniques. A ResearchStudy\n involves the gathering of information about human or animal subjects.\n ",
"id": "ResearchStudy",
"links": [
{
"backref": "ResearchStudies",
"label": "ResearchStudies",
"multiplicity": "many_to_many",
"name": "ResearchStudies",
"required": false,
"target_type": "ResearchStudy"
},
{
"backref": "ResearchStudies",
"label": "Practitioners",
"multiplicity": "many_to_many",
"name": "Practitioners",
"required": false,
"target_type": "Practitioner"
},
{
"backref": "ResearchStudies",
"label": "Organizations",
"multiplicity": "many_to_many",
"name": "Organizations",
"required": false,
"target_type": "Organization"
},
{
"backref": "ResearchStudies",
"label": "projects",
"multiplicity": "many_to_many",
"name": "projects",
"required": true,
"target_type": "project"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"condition_0_coding_sct": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"condition_0_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"condition_1_coding_sct": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"condition_1_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"description": {
"description": "What this is study doing.",
"type": [
"string",
"null"
]
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "The current state of the study.. http://hl7.org/fhir/research-study-status",
"enum": [
"active",
"administratively-completed",
"approved",
"closed-to-accrual",
"closed-to-accrual-and-intervention",
"completed",
"disapproved",
"in-review",
"temporarily-closed-to-accrual",
"temporarily-closed-to-accrual-and-intervention",
"withdrawn"
],
"term": {
"description": "The current state of the study.. http://hl7.org/fhir/research-study-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/research-study-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/research-study-status",
"term_url": "http://hl7.org/fhir/research-study-status"
}
}
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"title": {
"description": "Name for this study.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"status"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "ResearchStudy",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Specimen.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Biospecimen",
"description": " Sample for analysis.\n \n A sample to be used for analysis.\n ",
"id": "Specimen",
"links": [
{
"backref": "Specimen",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"subject_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"text_div": {
"description": "Limited xhtml content.",
"type": [
"string"
]
},
"text_status": {
"description": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.. http://hl7.org/fhir/narrative-status",
"enum": [
"generated",
"extensions",
"additional",
"empty"
],
"term": {
"description": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.. http://hl7.org/fhir/narrative-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/narrative-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/narrative-status",
"term_url": "http://hl7.org/fhir/narrative-status"
}
}
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"text_status",
"text_div"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Specimen",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"Medication.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Clinical",
"description": " Definition of a Medication.\n \n This resource is primarily used for the identification and definition of a\n medication for the purposes of prescribing, dispensing, and administering a\n medication as well as for making statements about medication use.\n ",
"id": "Medication",
"links": [],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"code_coding_rxnorm": {
"description": "Code defined by a terminology system.",
"type": [
"string",
"null"
]
},
"code_text": {
"description": "Plain text representation of the concept.",
"type": [
"string",
"null"
]
},
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"meta_profile": {
"description": "Profiles this resource claims to conform to.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "A code to indicate if the medication is in active use.. http://hl7.org/fhir/CodeSystem/medication-status",
"enum": [
"active",
"inactive",
"entered-in-error"
],
"term": {
"description": "A code to indicate if the medication is in active use.. http://hl7.org/fhir/CodeSystem/medication-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/CodeSystem/medication-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/CodeSystem/medication-status",
"term_url": "http://hl7.org/fhir/CodeSystem/medication-status"
}
}
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "Medication",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"ResearchSubject.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"category": "Administrative",
"description": " Physical entity which is the primary unit of interest in the study.\n \n A physical entity which is the primary unit of operational and/or\n administrative interest in a study.\n ",
"id": "ResearchSubject",
"links": [
{
"backref": "ResearchSubjects",
"label": "Patients",
"multiplicity": "many_to_many",
"name": "Patients",
"required": true,
"target_type": "Patient"
},
{
"backref": "ResearchSubjects",
"label": "ResearchStudies",
"multiplicity": "many_to_many",
"name": "ResearchStudies",
"required": true,
"target_type": "ResearchStudy"
}
],
"namespace": "http://hl7.org/fhir",
"program": "*",
"project": "*",
"properties": {
"created_datetime": {
"$ref": "_definitions.yaml#/datetime"
},
"id": {
"description": "",
"type": [
"string",
"null"
]
},
"individual_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"meta_source": {
"description": "Identifies where the resource comes from.",
"type": [
"string",
"null"
]
},
"project_id": {
"$ref": "_definitions.yaml#/project_id"
},
"resourceType": {
"description": "One of the resource types defined as part of this version of FHIR",
"type": [
"string",
"null"
]
},
"state": {
"$ref": "_definitions.yaml#/state"
},
"status": {
"description": "The current state of the subject.. http://hl7.org/fhir/research-subject-status",
"enum": [
"candidate",
"eligible",
"follow-up",
"ineligible",
"not-registered",
"off-study",
"on-study",
"on-study-intervention",
"on-study-observation",
"pending-on-study",
"potential-candidate",
"screening",
"withdrawn"
],
"term": {
"description": "The current state of the subject.. http://hl7.org/fhir/research-subject-status",
"termDef": {
"cde_id": "http://hl7.org/fhir/research-subject-status",
"cde_version": null,
"source": "fhir",
"strength": "required",
"term": "http://hl7.org/fhir/research-subject-status",
"term_url": "http://hl7.org/fhir/research-subject-status"
}
}
},
"study_reference": {
"description": "Literal reference, Relative, internal or absolute URL.",
"type": [
"string",
"null"
]
},
"submitter_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updated_datetime": {
"$ref": "_definitions.yaml#/datetime"
}
},
"required": [
"submitter_id",
"type",
"status"
],
"submittable": true,
"systemProperties": [
"id",
"project_id",
"created_datetime",
"updated_datetime",
"state"
],
"title": "ResearchSubject",
"type": "object",
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"validators": null
},
"core_metadata_collection.yaml": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "core_metadata_collection",
"title": "Core Metadata Collection",
"type": "object",
"nodeTerms": null,
"namespace": "https://data.midrc.org",
"category": "administrative",
"program": "*",
"project": "*",
"description": "A collection of data files in a project.",
"additionalProperties": false,
"submittable": true,
"validators": null,
"systemProperties": [
"id",
"project_id",
"state",
"created_datetime",
"updated_datetime"
],
"links": [
{
"name": "projects",
"backref": "core_metadata_collections",
"label": "data_from",
"target_type": "project",
"multiplicity": "many_to_one",
"required": true
}
],
"required": [
"submitter_id",
"type",
"projects"
],
"uniqueKeys": [
[
"id"
],
[
"project_id",
"submitter_id"
]
],
"properties": {
"$ref": "_definitions.yaml#/ubiquitous_properties",
"contributor": {
"description": "An entity responsible for making contributions to the resource. Examples of a Contributor include a person, an organization, or a service. Typically, the name of a Contributor should be used to indicate the entity.",
"type": "string"
},
"coverage": {
"description": "The spatial or temporal topic of the resource, the spatial applicability of the resource, or the jurisdiction under which the resource is relevant. Spatial topic and spatial applicability may be a named place or a location specified by its geographic coordinates. Temporal topic may be a named period, date, or date range. A jurisdiction may be a named administrative entity or a geographic place to which the resource applies. Recommended best practice is to use a controlled vocabulary such as the Thesaurus of Geographic Names [TGN] (http-//www.getty.edu/research/tools/vocabulary/tgn/index.html). Where appropriate, named places or time periods can be used in preference to numeric identifiers such as sets of coordinates or date ranges.",
"type": "string"
},
"creator": {
"description": "An entity primarily responsible for making the resource. Examples of a Creator include a person, an organization, or a service. Typically, the name of a Creator should be used to indicate the entity.",
"type": "string"
},
"data_type": {
"description": "The nature or genre of the resource. Recommended best practice is to use a controlled vocabulary such as the DCMI Type Vocabulary [DCMITYPE]. To describe the file format, physical medium, or dimensions of the resource, use the Format element.",
"type": "string"
},
"date": {
"description": "The date the collection of data was created.",
"type": "string"
},
"description": {
"description": "An account of the resource. Description may include but is not limited to- an abstract, a table of contents, a graphical representation, or a free-text account of the resource.",
"type": "string"
},
"format": {
"description": "The file format, physical medium, or dimensions of the resource. Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types [MIME] (http-//www.iana.org/assignments/media-types/).",
"type": "string"
},
"language": {
"description": "A language of the resource. Recommended best practice is to use a controlled vocabulary such as RFC 4646 (http-//www.ietf.org/rfc/rfc4646.txt).",
"type": "string"
},
"publisher": {
"description": "An entity responsible for making the resource available. Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity.",
"type": "string"
},
"relation": {
"description": "A related resource. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.",
"type": "string"
},
"rights": {
"description": "Information about rights held in and over the resource. Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights.",
"type": "string"
},
"source": {
"description": "A related resource from which the described resource is derived. The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.",
"type": "string"
},
"subject": {
"description": "The topic of the resource. Typically, the subject will be represented using keywords, key phrases, or classification codes. Recommended best practice is to use a controlled vocabulary.",
"type": "string"
},
"title": {
"description": "A name given to the resource. Typically, a Title will be a name by which the resource is formally known.",
"type": "string"
},
"projects": {
"description": "The project code for the record in the project node that this core_metadata_collection belongs to, i.e., a link to the parent node.",
"$ref": "_definitions.yaml#/to_one_project"
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment