RELEASE: 1.25.2

docs/HDRUK/4.0.0.example.json

@@ -0,0 +1,180 @@
+{
+    "identifier": null,
+    "version": "1.1.0",
+    "revisions": [
+        {
+            "version": "6.0.0",
+            "url": null
+        }
+    ],
+    "issued": "2024-10-24T00:00:00.000Z",
+    "modified": "2024-10-24T00:00:00.000Z",
+    "summary": {
+        "title": "North West London COVID-19 Patient Level Situation Report",
+        "abstract": "CPRD Aurum contains primary care data contributed by General Practitioner (GP) practices using EMIS Web® including patient registration information and all care events that GPs have chosen to record as part of their usual medical practice.",
+        "dataCustodian": {
+            "identifier": "30f16703-28bc-4f45-9ce5-625d2d3db27d",
+            "name": "Health Data Research UK",
+            "logo": null,
+            "description": null,
+            "contactPoint": "test@test.co.uk",
+            "memberOf": null
+        },
+        "populationSize": 1000,
+        "keywords": [
+            "Outpatient Care",
+            "Socioeconomic Deprivation",
+            "Infant Morbidity",
+            "Learning disability",
+            "Primary Care Prescription",
+            "Accident and Emergency Admissions"
+        ],
+        "doiName": null,
+        "contactPoint": "gateway@hdruk.ac.uk",
+        "datasetAliases": null
+    },
+    "documentation": {
+        "description": "CPRD Aurum contains primary care data contributed by General Practitioner (GP) practices using EMIS Web® including patient registration information and all care events that GPs have chosen to record as part of their usual medical practice.",
+        "associatedMedia": null,
+        "inPipeline": null
+    },
+    "coverage": {
+        "spatial": "United Kingdom",
+        "typicalAgeRangeMin": 0,
+        "typicalAgeRangeMax": 0,
+        "datasetCompleteness": null,
+        "materialType": null,
+        "followUp": null,
+        "pathway": null
+    },
+    "provenance": {
+        "origin": {
+            "purpose": null,
+            "datasetType": [
+                {
+                    "name": "Health and disease",
+                    "subTypes": []
+                }
+            ],
+            "source": null,
+            "collectionSource": null,
+            "imageContrast": null
+        },
+        "temporal": {
+            "publishingFrequency": "Continuous",
+            "distributionReleaseDate": null,
+            "startDate": "2024-10-24T00:00:00.000Z",
+            "endDate": null,
+            "timeLag": "Not applicable"
+        }
+    },
+    "accessibility": {
+        "usage": {
+            "dataUseLimitation": null,
+            "dataUseRequirements": null,
+            "resourceCreator": null
+        },
+        "access": {
+            "accessRights": "In Progress",
+            "accessServiceCategory": null,
+            "accessService": null,
+            "accessRequestCost": null,
+            "deliveryLeadTime": null,
+            "jurisdiction": null,
+            "dataController": null,
+            "dataProcessor": null
+        },
+        "formatAndStandards": {
+            "vocabularyEncodingScheme": [
+                "LOCAL",
+                "ICD10"
+            ],
+            "conformsTo": [
+                "LOCAL",
+                "NHS DATA DICTIONARY"
+            ],
+            "language": [
+                "en"
+            ],
+            "format": [
+                "text/tab-separated-values",
+                "application/sql",
+                "text/csv",
+                "image/diacom-rle"
+            ]
+        }
+    },
+    "enrichmentAndLinkage": {
+        "derivedFrom": [
+            {
+                "pid": null,
+                "title": null,
+                "url": null
+            }
+        ],
+        "isPartOf": [
+            {
+                "pid": null,
+                "title": null,
+                "url": null
+            }
+        ],
+        "linkableDatasets": [
+            {
+                "pid": null,
+                "title": null,
+                "url": null
+            }
+        ],
+        "similarToDatasets": [
+            {
+                "pid": null,
+                "title": null,
+                "url": null
+            }
+        ],
+        "investigations": null,
+        "tools": null,
+        "publicationAboutDataset": [
+            "10.1093/ije/dyab028"
+        ],
+        "publicationUsingDataset": [
+            "10.1001/jamapediatrics.2016.3633"
+        ]
+    },
+    "observations": [
+        {
+            "observedNode": "Persons",
+            "measuredValue": 1000,
+            "disambiguatingDescription": null,
+            "observationDate": "2024-10-24",
+            "measuredProperty": "Count"
+        }
+    ],
+    "structuralMetadata": null,
+    "demographicFrequency": {
+        "age": [
+            {
+                "bin": "30-34 years",
+                "count": 1000
+            }
+        ],
+        "ethnicity": [
+            {
+                "bin": "Black or Black British - Any other Black background",
+                "count": 1000
+            }
+        ],
+        "disease": [
+            {
+                "diseaseCode": "J45",
+                "diseaseCodeVocabulary": "ICD10",
+                "count": 1000
+            }
+        ]
+    },
+    "omics": {
+        "assay": null,
+        "platform": null
+    }
+}

hdr_schemata/models/HDRUK/3.0.0/schema.json

@@ -443,7 +443,7 @@
                                           "type": "null"
                                     }
                               ],
-                              "default": "UNKNOWN",
+                              "default": "Unknown",
                               "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).-0 - 6 MONTHS: Data typically available for a patient over a 0-6 month period.-6 - 12 MONTHS: Data typically available for a patient over a 6-12 month period.-1 - 10 YEARS: Data typically available for a patient over a 1-10 year period.-> 10 YEARS: Data typically available for a patient for over a 10 year period.-CONTINUOUS: Data for patients is being regularly added to and updated.-UNKNOWN: Timespan is Unknown.-OTHER: Data available for a patient over another time period.",
                               "title": "Follow-up"

hdr_schemata/models/HDRUK/4.0.0/schema.json

@@ -443,7 +443,7 @@
                                           "type": "null"
                                     }
                               ],
-                              "default": "UNKNOWN",
+                              "default": "Unknown",
                               "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**: 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.",
                               "title": "Follow-up"

hdr_schemata/models/HDRUK/v3_0_0/Coverage.py

@@ -42,7 +42,7 @@ class Config:
     )
 
     followUp: Optional[FollowupV2] = Field(
-        "UNKNOWN",
+        "Unknown",
         **an.followUp.__dict__,
         json_schema_extra={"guidance": an.followUp.guidance}
     )