Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor changes to guidance text and examples #51

Merged
merged 1 commit into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/GWDM/1.0.form.json
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,12 @@
"description": "Please provide a list of relevant and specific keywords that can improve the search engine optimisation (SEO) of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users.",
"guidance": "- Please provide **relevant** and **specific keywords** that can **improve the search engine optimization** of your dataset.\\n- Please **enter one keyword at a time** and click **Add New Field** to add further keywords.\\n- Text from the title is automatically included in the search, there is no need to include this in the keywords.\\n- Include words that researcher may include in their searches.",
"examples": [
"Health Data, Research, SAIL, Primary care, GP"
"Outpatient Care",
BSnelling marked this conversation as resolved.
Show resolved Hide resolved
"Socioeconomic Deprivation",
"Infant Morbidity",
"Learning disability",
"Primary Care Prescription",
"Accident and Emergency Admissions"
],
"is_list": false,
"is_optional": true,
Expand Down Expand Up @@ -306,7 +311,7 @@
"required": false,
"title": "Follow-up",
"description": "If known, what is the typical time span that a patient appears in the dataset (follow up period). In a prospective cohort study, after baseline information is collected, participants are followed \u201clongitudinally\u201d i.e. new information is collected about them for a period of time afterward. This is known as the \u201cfollow up period\u201d. What is the typical time span of follow up, e.g. 1 year, 5 years? If there are multiple cohorts in the dataset with varying follow up periods, please provide the longest follow up period.",
"guidance": "If known, please indicate the typical time span that a patient appears in the dataset (follow up period).\\n-**0 - 6 MONTHS**: Data typically available for a patient over a 0-6 month period.\\n-**6 - 12 MONTHS**: Data typically available for a patient over a 6-12 month period.\\n-**1 - 10 YEARS**: Data typically available for a patient over a 1-10 year period.\\n-**> 10 YEARS**: Data typically available for a patient for over a 10 year period.\\n-**CONTINUOUS**: .......... \\n-**UNKNOWN**: Timespan is Unknown.\\n-**OTHER**: Data available for a patient over another time period.",
"guidance": "If known, please indicate the typical time span that a patient appears in the dataset (follow up period).\\n-**0 - 6 MONTHS**: Data typically available for a patient over a 0-6 month period.\\n-**6 - 12 MONTHS**: Data typically available for a patient over a 6-12 month period.\\n-**1 - 10 YEARS**: Data typically available for a patient over a 1-10 year period.\\n-**> 10 YEARS**: Data typically available for a patient for over a 10 year period.\\n-**CONTINUOUS**: Data for patients is being regularly added to and updated.\\n-**UNKNOWN**: Timespan is Unknown.\\n-**OTHER**: Data available for a patient over another time period.",
"examples": null,
"is_list": false,
"is_optional": true,
Expand Down Expand Up @@ -346,7 +351,7 @@
"required": false,
"title": "Purpose of dataset collection",
"description": "Please indicate the purpose(s) that the dataset was collected.",
"guidance": "- **Research cohort**: Data collected for a defined group of people.\\n- **Study**: Data collected for a specific research study.\\n- **Disease registry**: Data collected as part of a disease registry.\\n- **Trial**: Data collected for as part of a clinical trial.\\n- **Care**: Data collected as part of routine clinical care.\\n- **Audit**: Data collected as part of an audit programme.\\n- **Administrative**: Data collected for administrative and management information purposes.\\n- **Financial**: Data collected either for payments or for billing.\\n- **Statutory**: ...........\\n- **Other**: Data collected for other purpose.",
"guidance": "- **Research cohort**: Data collected for a defined group of people.\\n- **Study**: Data collected for a specific research study.\\n- **Disease registry**: Data collected as part of a disease registry.\\n- **Trial**: Data collected for as part of a clinical trial.\\n- **Care**: Data collected as part of routine clinical care.\\n- **Audit**: Data collected as part of an audit programme.\\n- **Administrative**: Data collected for administrative and management information purposes.\\n- **Financial**: Data collected either for payments or for billing.\\n- **Statutory**: Data collected in compliance with statutory requirements.\\n- **Other**: Data collected for other purpose.",
"examples": null,
"is_list": false,
"is_optional": true,
Expand Down
19 changes: 12 additions & 7 deletions docs/GWDM/1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,12 @@ Please provide a list of relevant and specific keywords that can improve the sea

Examples:

* Health Data, Research, SAIL, Primary care, GP
* Outpatient Care
* Socioeconomic Deprivation
* Infant Morbidity
* Learning disability
* Primary Care Prescription
* Accident and Emergency Admissions


### controlledKeywords
Expand Down Expand Up @@ -293,9 +298,9 @@ Please indicate if the dataset is representative of the patient pathway and any

If known, what is the typical time span that a patient appears in the dataset (follow up period). In a prospective cohort study, after baseline information is collected, participants are followed “longitudinally” i.e. new information is collected about them for a period of time afterward. This is known as the “follow up period”. What is the typical time span of follow up, e.g. 1 year, 5 years? If there are multiple cohorts in the dataset with varying follow up periods, please provide the longest follow up period.

| title | guidance | is_list | required | type |
|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------|
| Follow-up | If known, please indicate the typical time span that a patient appears in the dataset (follow up period).<br>-**0 - 6 MONTHS**: Data typically available for a patient over a 0-6 month period.<br>-**6 - 12 MONTHS**: Data typically available for a patient over a 6-12 month period.<br>-**1 - 10 YEARS**: Data typically available for a patient over a 1-10 year period.<br>-**> 10 YEARS**: Data typically available for a patient for over a 10 year period.<br>-**CONTINUOUS**: .......... <br>-**UNKNOWN**: Timespan is Unknown.<br>-**OTHER**: Data available for a patient over another time period. | False | False | ["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] |
| title | guidance | is_list | required | type |
|:----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------|
| Follow-up | If known, please indicate the typical time span that a patient appears in the dataset (follow up period).<br>-**0 - 6 MONTHS**: Data typically available for a patient over a 0-6 month period.<br>-**6 - 12 MONTHS**: Data typically available for a patient over a 6-12 month period.<br>-**1 - 10 YEARS**: Data typically available for a patient over a 1-10 year period.<br>-**> 10 YEARS**: Data typically available for a patient for over a 10 year period.<br>-**CONTINUOUS**: Data for patients is being regularly added to and updated.<br>-**UNKNOWN**: Timespan is Unknown.<br>-**OTHER**: Data available for a patient over another time period. | False | False | ["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] |



Expand Down Expand Up @@ -335,9 +340,9 @@ None

Please indicate the purpose(s) that the dataset was collected.

| title | guidance | is_list | required | type |
|:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------|
| Purpose of dataset collection | - **Research cohort**: Data collected for a defined group of people.<br>- **Study**: Data collected for a specific research study.<br>- **Disease registry**: Data collected as part of a disease registry.<br>- **Trial**: Data collected for as part of a clinical trial.<br>- **Care**: Data collected as part of routine clinical care.<br>- **Audit**: Data collected as part of an audit programme.<br>- **Administrative**: Data collected for administrative and management information purposes.<br>- **Financial**: Data collected either for payments or for billing.<br>- **Statutory**: ...........<br>- **Other**: Data collected for other purpose. | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
| title | guidance | is_list | required | type |
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------|
| Purpose of dataset collection | - **Research cohort**: Data collected for a defined group of people.<br>- **Study**: Data collected for a specific research study.<br>- **Disease registry**: Data collected as part of a disease registry.<br>- **Trial**: Data collected for as part of a clinical trial.<br>- **Care**: Data collected as part of routine clinical care.<br>- **Audit**: Data collected as part of an audit programme.<br>- **Administrative**: Data collected for administrative and management information purposes.<br>- **Financial**: Data collected either for payments or for billing.<br>- **Statutory**: Data collected in compliance with statutory requirements.<br>- **Other**: Data collected for other purpose. | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] |



Expand Down
Loading
Loading