Skip to content

Commit

Permalink
Merge pull request #3 from HDRUK/GAT-4307
Browse files Browse the repository at this point in the history
Update docs to reflect GWDM v2 and HDRUK v3
  • Loading branch information
BSnelling authored Jun 24, 2024
2 parents f069594 + 82505fb commit 3c2581f
Show file tree
Hide file tree
Showing 9 changed files with 946 additions and 655 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
*__pycache__*
*__pycache__*
.ipynb_checkpoints
612 changes: 329 additions & 283 deletions Tutorial.ipynb

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions docs/creating-a-dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,14 @@ Navigate (on the Gateway) to `Integrations > API Management > Manage API`, and s
"2.1.0",
"2.0.2",
"2.2.1",
"2.2.0"
"2.2.0",
"3.0.0"
],
"GWDM": [
"1.0",
"1.1",
"1.2"
"1.2",
"2.0"
],
"SchemaOrg": [
"default",
Expand Down
239 changes: 142 additions & 97 deletions docs/creating-metadata.md

Large diffs are not rendered by default.

166 changes: 166 additions & 0 deletions docs/example-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -2764,6 +2764,172 @@ The change log for this schema can be found at:
}
```

### HDR v3.0.0

```json
{
"identifier": "https://web.www.healthdatagateway.org/19525c5f-92ee-41b6-bb79-673624b27bdd",
"version": "3.0.0",
"issued": "2021-05-10T00:00:00.000Z",
"modified": "2021-05-10T00:00:00.000Z",
"revisions": [],
"summary": {
"title": "Improving Access to Psychological Therapies Data Set",
"abstract": "Patient-level data set that captures information about people in contact with services commissioned as part of the adult Improving Access to Psychological Services (IAPT) programme.",
"contactPoint": "[email protected]",
"keywords": " Depression,Anxiety,CBT,Counselling,Talking theraphy,Cognitive,National Core Study,NCS",
"alternateIdentifiers": null,
"doiName": null,
"populationSize": -1,
"dataProvider": {
"identifier": "https://web.www.healthdatagateway.org/5f86cd34980f41c6f02261f4",
"name": "NHS DIGITAL",
"logo": null,
"description": null,
"contactPoint": null,
"memberOf": "ALLIANCE"
}
},
"documentation": {
"description": "Collecting information about people in contact with adult psychological therapy services in England. The IAPT data set was developed with the IAPT programme as a patient level, output based, secondary uses data set which aims to deliver robust, comprehensive, nationally consistent and comparable information for patients accessing NHS-funded IAPT services in England. This national data set has been collected since April 2012 and is a mandatory submission for all NHS funded care, including care delivered by independent sector healthcare providers. Data collection on patients with depression and anxiety disorders that are offered psychological therapies, so that we can improve the delivery of care for these conditions.\n\nProviders of NHS-funded IAPT services are required to submit data to NHS Digital on a monthly basis.\n\nAs a secondary uses data set the IAPT data set re-uses clinical and operational data for purposes other than direct patient care. It defines the data items, definitions and associated value sets extracted or derived from local information systems and sent to NHS Digital for analysis purposes. Timescales for dissemination can be found under 'Our Service Levels' at the following link: https://digital.nhs.uk/services/data-access-request-service-dars/data-access-request-service-dars-process",
"associatedMedia": null,
"inPipeline": null
},
"coverage": {
"spatial": "United Kingdom,England",
"followup": "0 - 6 MONTHS",
"pathway": null,
"gender": null,
"typicalAgeRangeMin": 18,
"typicalAgeRangeMax": 150,
"datasetCompleteness": null,
"materialType": [
"None/not available"
]
},
"provenance": {
"origin": {
"purpose": [
"Other",
"Administrative"
],
"source": [
"EPR"
],
"datasetType": "Health and disease",
"datasetSubType": "Not applicable",
"collectionSource": null,
"imageContrast": null
},
"temporal": {
"distributionReleaseDate": null,
"startDate": "2012-04-01",
"endDate": null,
"timeLag": "2-6 months",
"publishingFrequency": "Monthly"
}
},
"accessibility": {
"usage": {
"dataUseLimitation": [
"No restriction"
],
"dataUseRequirements": null,
"resourceCreator": null
},
"access": {
"accessRights": "https://digital.nhs.uk/services/data-access-request-service-dars",
"accessService": "Once your DARS application has been approved, data will be made available either by secure file transfer or through the Data Access Environment (DAE). BL\n\nSecure file transfer: https://digital.nhs.uk/services/transfer-data-securely\n\nDAE: https://digital.nhs.uk/services/data-access-environment-dae",
"accessRequestCost": "https://digital.nhs.uk/services/data-access-request-service-dars/data-access-request-service-dars-charges",
"deliveryLeadTime": null,
"jurisdiction": "GB-ENG",
"dataProcessor": null,
"dataController": "NHS DIGITAL",
"accessServiceCategory": null,
"accessMode": "New project"
},
"formatAndStandards": {
"vocabularyEncodingScheme": [
"ODS",
"SNOMED CT",
"NHS NATIONAL CODES",
"ICD10"
],
"conformsTo": [
"NHS DATA DICTIONARY"
],
"language": "en",
"format": "CSV"
}
},
"enrichmentAndLinkage": {
"tools": null,
"derivedFrom": null,
"isPartOf": null,
"linkableDatasets": null,
"similarToDatasets": null,
"publicationAboutDataset": null,
"investigations": null,
"publicationUsingDataset": null
},
"observations": [
{
"observedNode": "Event",
"measuredValue": 114125,
"measuredProperty": "COUNT",
"observationDate": "2021-02-25",
"disambiguatingDescription": "In December 2020 there were 114,125 referrals made into IAPT services in England."
},
{
"observedNode": "Event",
"measuredValue": 81578,
"measuredProperty": "COUNT",
"observationDate": "2021-02-25",
"disambiguatingDescription": "In December 2020, 81,578 referrals into IAPT services in England started a course of treatment."
},
{
"observedNode": "Event",
"measuredValue": 48331,
"measuredProperty": "COUNT",
"observationDate": "2021-02-25",
"disambiguatingDescription": "In December 2020, 48,331 referrals into IAPT services in England completed a course of treatment."
}
],
"structuralMetadata": {
"tables": [
{
"name": "IAPT.iapt.Rep_Referral",
"description": "IAPT.iapt.Rep_Referral",
"columns": [
{
"name": "Count of number of Non-guided Self Help (Computer) sessions (derived)",
"description": "Count of number of Non-guided Self Help (Computer) sessions (derived)",
"dataType": "Number",
"sensitive": false,
"values": null
}
]
},
{
"name": "IAPT.iapt.Rep_Referral",
"description": "IAPT.iapt.Rep_Referral",
"columns": [
{
"name": "Pseudonymised Service Request Identifier",
"description": "A request for the provision of care services to a PATIENT.",
"dataType": "String",
"sensitive": false,
"values": null
}
]
}
],
"syntheticDataWebLink": null
}
}

```

### BioSchema

This example payload (`{"metadata":<json>}`) will validate (return status `200`) against TRASER (translation service) endpoint:
Expand Down
Loading

0 comments on commit 3c2581f

Please sign in to comment.