Skip to content
Open
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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ Run `python create_json_schema.py`. This will modify the contents of `hdr_schema
pip install -e .
```

You will also have to update the json templates. From the repo folder run `python create_example.py`

### Update docs

Finally, update the Markdown docs with:
Expand Down
339 changes: 168 additions & 171 deletions docs/HDRUK/4.0.0.example.json
Original file line number Diff line number Diff line change
@@ -1,180 +1,177 @@
{
"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": []
}
"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\u00ae 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\u00ae 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": null,
"typicalAgeRangeMax": null,
"datasetCompleteness": null,
"materialType": null,
"followUp": null,
"pathway": null
},
"provenance": {
"origin": {
"purpose": null,
"datasetType": [
"Health and disease"
],
"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
}
],
"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"
"linkableDatasets": [
{
"pid": null,
"title": null,
"url": null
}
],
"conformsTo": [
"LOCAL",
"NHS DATA DICTIONARY"
"similarToDatasets": [
{
"pid": null,
"title": null,
"url": null
}
],
"language": [
"en"
"investigations": null,
"tools": null,
"publicationAboutDataset": [
"10.1093/ije/dyab028"
],
"format": [
"text/tab-separated-values",
"application/sql",
"text/csv",
"image/diacom-rle"
"publicationUsingDataset": [
"10.1001/jamapediatrics.2016.3633"
]
}
},
"enrichmentAndLinkage": {
"derivedFrom": [
},
"observations": [
{
"pid": null,
"title": null,
"url": null
"observedNode": "Persons",
"measuredValue": 1000,
"disambiguatingDescription": null,
"observationDate": "2024-10-24",
"measuredProperty": "Count"
}
],
"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
}
],
"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
}
}
Loading