{"openapi":"3.0.0","info":{"version":"v1.0.48-alpha","title":"Health Research Data Catalogue API","description":"\n## Overview\nUse this API to retrieve metadata information suitable for publication in a health research data catalogue. \n\nYou can:\n* get a list of data sets\n* get data set details \n\nYou cannot currently use this API to:\n* retrieve data sets as a bulk transfer\n* retrieve data set feeds\n\nYou can get the following metadata information for each data set:\n* overarching characteristics such as: publisher, keywords, coverage, provenance, access, format, standards, summary observations and data utility\n\nThe API conforms to the [HDR UK Dataset Metadata Schema Standard v2.0.2](https://hdruk.github.io/schemata/schema/dataset/2.0.2/dataset.schema.json) created to enable sharing of information with the UK-wide 'federated' health research data catalogue.\n\n### API scope\nCurrent scope is limited to metadata information about national health-related data sets (such as description, size of the population contained within that data set and the legal basis for access) that can help researchers and innovators decide whether a data set could be useful to their research and help them to make further health discoveries.\n\n## Who can use this API\nThis API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. You must do this before you can go live (see ‘Onboarding’ below).\n\n## Related APIs\nThere are no related APIs.\n\n## API status and roadmap\nThis API is initially for use by Health Data Research (HDR) UK developers with other use cases to follow later.\n\nThis API is [in production](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses), meaning:\n- we do not make routine breaking changes, if it cannot be avoided, for example, for security reasons, we will give advance notice\n\nTo see our roadmap, or to suggest, comment or vote on features for this API, see our [interactive product backlog](https://nhs-digital-api-management.featureupvote.com/?order=popular&filter=all&tag=health-research-data-api#controls). \n\n## Service level\nThis API is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays.\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#basic-rest-apis). \n\n## Network access\n\nThis API is available on the internet and, indirectly, on the [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network). \n\nFor more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).\n\n## Security and authorisation\n\nThis API is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate and authorise the calling application and we do not authenticate or authorise the end user.\n\nAlthough we don't authenticate or authorise the end user, for some APIs we do require the calling application to do it 'locally'. For other APIs we don't require the end user to be authenticated or authorised, or even to be present.\n\nWe support the following security patterns for application-restricted APIs:\n- [Application-restricted RESTful API - API key authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-api-key-authentication)\n\nFor more details, see [application-restricted APIs](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis).\n\n## Environments and testing\n| Purpose | Base URL |\n| ---------------------------------------|-----------------------------------------------------|\n| Sandbox | `https://sandbox.api.service.nhs.uk/health-research-data-catalogue`|\n| Integration test | `https://int.api.service.nhs.uk/health-research-data-catalogue` |\n| Production | `https://api.service.nhs.uk/health-research-data-catalogue` |\n\n### Sandbox testing\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing):\n* is for early developer testing\n* only covers a limited set of scenarios\n* is open-access, so does not allow you to test authorisation\n\nFor more details on sandbox testing, or to try out the sandbox using our \\\"Try this API\\\" feature, see the documentation for each endpoint.\n\n### Integration testing\nOur [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing): \n- is for formal integration testing.\n- includes application authentication\n\nIt also includes ready-to-use metadata information about national health-related data sets test data.\n\nFor more details see [integration testing with our RESTful APIs](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis).\n\n## Onboarding\nYou need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead.\n\nAs part of this process, you need to demonstrate your technical conformance to the requirements for this API. \n\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding). \n\n
\n
\n
\n
\n \n \"\"\n \n
\n
\n
\n

To get started, sign in or create a developer account, then select 'product onboarding'.

\n
\n
\n
\n\n## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\n\n* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action\n* 400 to 499 if it failed because of a client error by your application\n* 500 to 599 if it failed because of an error on our server\n\nErrors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.\n","contact":{"name":"Health Research Data Catalogue API Support","url":"https://digital.nhs.uk/developer/help-and-support","email":"api.management@nhs.net"}},"servers":[{"url":"https://sandbox.api.service.nhs.uk/health-research-data-catalogue","description":"Sandbox environment"},{"url":"https://int.api.service.nhs.uk/health-research-data-catalogue","description":"Integration test environment."},{"url":"https://api.service.nhs.uk/health-research-data-catalogue","description":"Production environment."}],"x-spec-publication":{"try-this-api":{"disabled":false},"operation-order":[{"operations":[{"method":"GET","path":"/datasets"},{"method":"GET","path":"/datasets/{id}"}]}]},"paths":{"/datasets":{"get":{"summary":"Get a list of data sets","operationId":"get-datasets-list","description":"\n## Overview\nUse this endpoint to get a summary list of published data sets.\n\n## Summary data set metadata returned\n\nThe summary data set metadata returned by this search includes:\n* schema conformance\n* data set persistent identifier\n* data set name\n* data set description\n* data set version\n* self continuation link\n* data set metadata creation date\n* data set metadata modification date\n* source of the metadata\n\n## Sandbox test scenarios\nYou can test the following scenario in our sandbox environment:\n\n| Scenario | Request | Response |\n| ---------------------------------- | -------------------------------------------------------------------- | ------------------------------------------ |\n| Published summary data sets exist | No filters applied | HTTP Status 200 with summary list of published data sets in response body |\n\n\nYou can try out the sandbox using the 'Try this API' feature on this page.\n","parameters":[{"in":"header","name":"apikey","description":"API key to authenticate with.","schema":{"type":"string"},"required":true},{"in":"header","name":"X-Correlation-ID","required":false,"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},{"in":"header","name":"X-Request-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n","schema":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","example":"60E0B220-8136-4CA5-AE46-1D97EF59D068"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Container object for all summary dataset resources that match the request.","required":["total","items"],"properties":{"total":{"type":"integer","description":"The total number of resources that match the request.","minimum":1},"items":{"type":"array","description":"Repeats all summary dataset resources (items) that match the request.","items":{"type":"object","required":["@schema","persistentId","name","description","version","self","issued","modified","source"],"properties":{"@schema":{"type":"string","format":"uri","description":"JSON Schema specification that summary dataset resource (item) conforms to.","example":"https://hdruk.github.io/schemata/schema/dataset/2.0.2/dataset.schema.json"},"persistentId":{"type":"string","description":"Data set persistent identifier that is common across all data set revisions.","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}$","minLength":36,"maxLength":36,"example":"226fb3f1-4471-400a-8c39-2b66d46a39b6"},"name":{"type":"string","description":"Data set name.","example":"Civil Registration - Deaths"},"description":{"type":"string","description":"Data set description.","example":"Deaths registration data (all deaths in England and Wales) collected from The Registrar General for England and Wales. Record-level patient dataset, where a record represents one death registration."},"version":{"type":"string","description":"Data set version.","pattern":"^([0-9]+)\\.([0-9]+)\\.([0-9]+)$","example":"1.1.0"},"self":{"type":"string","description":"Self continuation link of a search result.","example":"https://api.service.nhs.uk/health-research-data-catalogue/datasets/dd5f0174-575f-4f4c-a4fc-b406aab953d9"},"issued":{"type":"string","description":"Data set metadata creation date.","format":"date-time","example":"2020-08-05T14:35:59+00:00"},"modified":{"type":"string","description":"Data set metadata modification date.","format":"date-time","example":"2021-01-28T14:15:46+00:00"},"source":{"type":"string","description":"The source of the data set.","example":"Other"}}}}}},"example":{"total":"7","items":[{"@schema":"https://hdruk.github.io/schemata/schema/dataset/2.0.2/dataset.schema.json","persistentId":"tt6gh174-575f-4f4c-a4fc-b406aabj9766","name":"Hospital Episode Statistics Admitted Patient Care","description":"Hospital Episode Statistics (HES) is a database containing details of all admissions, A and E attendances and outpatient appointments at NHS hospitals in England. Records in the HES Admitted Patient Care (APC) database are called ‘hospital episodes’, and each hospital episode relates to a period of care for a patient under a single consultant within one hospital provider. A stay in hospital from admission to discharge is called a ‘spell’ and can be made up of one or more episodes of care. HES APC looks at completed episodes, called Finished Admission Episodes (FAEs), which is the first episode in a spell of care, and Finished Consultant Episodes (FCEs), which is a continuous period of care under one consultant. Initially this data is collected during a patient's time at hospital as part of the Commissioning Data Set (CDS). This is submitted to NHS Digital for processing and is returned to healthcare providers as the Secondary Uses Service (SUS) data set and includes information relating to payment for activity undertaken. It allows hospitals to be paid for the care they deliver. This same data can also be processed and used for non-clinical purposes, such as research and planning health services. Because these uses are not to do with direct patient care, they are called 'secondary uses'. This is the HES data set. HES data covers all NHS Clinical Commissioning Groups (CCGs) in England, including: private patients treated in NHS hospitals patients resident outside of England care delivered by treatment centres (including those in the independent sector) funded by the NHS Each HES record contains a wide range of information about an individual patient admitted to an NHS hospital, including: clinical information about diagnoses and operations patient information, such as age group, gender and ethnicity administrative information, such as dates and methods of admission and discharge geographical information such as where patients are treated and the area where they live We apply a strict statistical disclosure control in accordance with the NHS Digital protocol, to all published HES data. This suppresses small numbers to stop people identifying themselves and others, to ensure that patient confidentiality is maintained. https://digital.nhs.uk/data-and-information/publications/statistical/hospital-admitted-patient-care-activity","version":"2.0.0","self":"https://hdr.dev.dataproducts.nhs.uk/datasets/tt6gh174-575f-4f4c-a4fc-b406aabj9766","issued":"2021-06-18T13:59:28.735000+00:00","modified":"2022-07-27T16:53:20.845000+00:00","source":""},{"@schema":"https://hdruk.github.io/schemata/schema/dataset/2.0.2/dataset.schema.json","persistentId":"tt6gh174-575f-4f4c-a4fc-b406aabj9767","name":"GPES Data for Pandemic Planning and Research (COVID-19)","description":"Coronavirus (COVID-19) has led to increased demand on general practices, including an increasing number of requests to provide patient data to inform planning and support vital research on the cause, effects, treatments and outcomes for patients of the virus. To support the response to the coronavirus outbreak, NHS Digital has been legally directed to collect and analyse healthcare information about patients, including from their GP record, for the duration of the coronavirus emergency period, under the COVID-19 Public Health Directions 2020 (COVID-19 Direction). All GP practices in England are legally required to share data with NHS Digital for this purpose under the Health and Social Care Act 2012. More information about this requirement is contained in the Data Provision Notice issued by NHS Digital to GP practices. This collection will reduce burden on general practices, allowing them to focus on patient care and support the coronavirus response.\n\nthis is a new paragraph.","version":"2.0.0","self":"https://hdr.dev.dataproducts.nhs.uk/datasets/tt6gh174-575f-4f4c-a4fc-b406aabj9767","issued":"2021-06-16T18:52:18.812000+00:00","modified":"2022-07-27T16:41:58.662000+00:00","source":""},{"@schema":"https://hdruk.github.io/schemata/schema/dataset/2.0.2/dataset.schema.json","persistentId":"tt6gh174-575f-4f4c-a4fc-b406aabj9768","name":"Medicines dispensed in Primary Care (NHSBSA data)","description":"NHS Digital has established a monthly collection of patient-level data about medicines dispensed and claimed for in community settings (predominantly community pharmacy). The data is taken from electronic and paper prescriptions submitted to the NHS Business Services Authority (NHSBSA) for reimbursement each month. The data comprises prescriptions for medicines that are dispensed or supplied by community pharmacists, appliance contractors and dispensing doctors and prescriptions submitted by prescribing doctors in England for medicines personally administered in England.","version":"1.0.0","self":"https://hdr.dev.dataproducts.nhs.uk/datasets/tt6gh174-575f-4f4c-a4fc-b406aabj9768","issued":"2021-06-17T15:17:27.327000+00:00","modified":"2022-07-18T08:28:18.387000+00:00","source":""},{"@schema":"https://hdruk.github.io/schemata/schema/dataset/2.0.2/dataset.schema.json","persistentId":"tt6gh174-575f-4f4c-a4fc-b406aabj9764","name":"Community Services Data Set","description":"Providers of publicly-funded community services are legally mandated to collect and submit community health data, as set out by the Health and Social Care Act 2012. The Community Services Data Set (CSDS) expands the scope of the Children and Young People's Health Services Data Set (CYPHS) data set, by removing the 0-18 age restriction. The CSDS supersedes the CYPHS data set, to allow adult community data to be submitted. The structure and content of the CSDS remains the same as the CYPHS data set. The Community Information Data Set (CIDS) has been retired, to remove the need for a separate local collection and reduce burden on providers. Reports from the CSDS are available to download from the Community Services Data Set reports webpage.\n\n• personal and demographic\n\n• breastfeeding and nutrition\n\n• care event and screening activity","version":"2.0.0","self":"https://hdr.dev.dataproducts.nhs.uk/datasets/tt6gh174-575f-4f4c-a4fc-b406aabj9764","issued":"2021-07-21T15:01:53.062000+00:00","modified":"2022-08-04T13:12:31.855000+00:00","source":""},{"@schema":"https://hdruk.github.io/schemata/schema/dataset/2.0.2/dataset.schema.json","persistentId":"tt6gh174-575f-4f4c-a4fc-b406aabj9765","name":"Civil Registration - Deaths","description":"Deaths registration data (all deaths in England and Wales) collected from The Registrar General for England and Wales. Record-level patient data set, where a record represents one death registration. The data are collected at source from Local Registry offices at the point of death registration. The data are collated nationally by the Register General before being passed to the Office for National Statistics (ONS), for use in statistics and coding. Coding includes such things cause of death coding using the International Classifications of Diseases (ICD) coding system, attributing socio-economic code classifications based on occupation. ONS maintains its own version of the data set for its use in statistics. The Civil Registration of Deaths data contains 14 million unique registrations since 1993 onwards, increasing yearly. Average 500,000 - 600,000 new death registrations yearly. Records cover all deaths registered in England & Wales. ICD coding is 9th and 10th. https://digital.nhs.uk/services/data-access-request-service-dars.\n\nTimescales 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.","version":"1.0.2","self":"https://hdr.dev.dataproducts.nhs.uk/datasets/tt6gh174-575f-4f4c-a4fc-b406aabj9765","issued":"2022-07-12T11:34:05.538000+00:00","modified":"2022-08-04T15:56:42.204000+00:00","source":""},{"@schema":"https://hdruk.github.io/schemata/schema/dataset/2.0.2/dataset.schema.json","persistentId":"tt6gh174-575f-4f4c-a4fc-b406aabj9769","name":"Pillar 2 - Covid-19 UK Non-hospital Antigen Testing Results","description":"COVID-19 Key Worker Testing Results data is required by NHS Digital to support COVID-19 requests for linkage, analysis and dissemination to other organisations who require the data in a timely manner. These requests are often urgent and in support of direct care and service monitoring, planning and research. These are all functions that NHS Digital have been asked to deliver as a national resource in response to COVID-19, through the recent direction from the SoS. Antigen test results relating to subjects tested within the following: • Drive through test centre • Home test The Key Worker Testing results relate to a subject who has been tested. This may be a key worker or a symptomatic household member. The dataset will be composed of: • Patient identity and contact details • Testing centre and laboratory details • Test results • Test kit types (manufacturer) • Key worker indicator and employer organisation The data cover UK and is collected under SofS Covid Direction under s254 of the HSCA 2012 and s255 requests from devolved administrations for Scotland, Northern Ireland and Wales. Original scope was Key workers but this has now been expanded to include all pillar 2 antigen testing, which is Commercial Antigen testing for citizens. Covers npex.npex, npex.randox, Legacy, deloitte and BSA flows. Covers England, NI, Scotland and Wales. \\[Originally it was just some Welsh patient data if they were tested in England, Scotland, NI etc, but scope has changed\\].\n\nTimescales 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](https://digital.nhs.uk/services/data-access-request-service-dars/data-access-request-service-dars-process)","version":"1.2.3","self":"https://hdr.dev.dataproducts.nhs.uk/datasets/CV19-12345","issued":"2022-07-12T11:34:04.498000+00:00","modified":"2022-07-27T16:58:29.500000+00:00","source":""},{"@schema":"https://hdruk.github.io/schemata/schema/dataset/2.0.2/dataset.schema.json","persistentId":"tt6gh174-575f-4f4c-a4fc-b406aabj9769","name":"Pillar 2 - Covid-19 UK Non-hospital Antigen Testing Results","description":"COVID-19 Key Worker Testing Results data is required by NHS Digital to support COVID-19 requests for linkage, analysis and dissemination to other organisations who require the data in a timely manner. These requests are often urgent and in support of direct care and service monitoring, planning and research. These are all functions that NHS Digital have been asked to deliver as a national resource in response to COVID-19, through the recent direction from the SoS. Antigen test results relating to subjects tested within the following: • Drive through test centre • Home test The Key Worker Testing results relate to a subject who has been tested. This may be a key worker or a symptomatic household member. The dataset will be composed of: • Patient identity and contact details • Testing centre and laboratory details • Test results • Test kit types (manufacturer) • Key worker indicator and employer organisation The data cover UK and is collected under SofS Covid Direction under s254 of the HSCA 2012 and s255 requests from devolved administrations for Scotland, Northern Ireland and Wales. Original scope was Key workers but this has now been expanded to include all pillar 2 antigen testing, which is Commercial Antigen testing for citizens. Covers npex.npex, npex.randox, Legacy, deloitte and BSA flows. Covers England, NI, Scotland and Wales. \\[Originally it was just some Welsh patient data if they were tested in England, Scotland, NI etc, but scope has changed\\].\n\nTimescales 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](https://digital.nhs.uk/services/data-access-request-service-dars/data-access-request-service-dars-process)","version":"1.0.2","self":"https://hdr.dev.dataproducts.nhs.uk/datasets/CV19-67890","issued":"2022-07-12T11:34:05.259000+00:00","modified":"2022-07-27T16:59:38.784000+00:00","source":""}]}}}},"4XX":{"description":"An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | --------------------------------------------- |\n| 401 | ACCESS_DENIED | Access token missing, invalid or expired, or calling application not configured for this operation. |\n| 404 | RESOURCE_NOT_FOUND | No dataset resources found. |\n| 404 | INVALID_ENDPOINT_PATH | Invalid endpoint path. | \n| 429 | TOO_MANY_REQUESTS | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n","content":{"application/fhir+json":{"schema":{"type":"object","description":"Outcome of an operation that does not result in a resource or bundle being returned, for example an error or an async/batch submission.\nThere are a number of possible error codes that can be returned along with a more detailed description in the `display` field.\n","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"FHIR error code.","example":"invalid","enum":["invalid","structure","required","value","invariant","security","login","unknown","expired","forbidden","suppressed","processing","not-supported","duplicate","multiple-matches","not-found","deleted","too-long","code-invalid","extension","too-costly","business-rule","conflict","transient","lock-error","no-store","exception","timeout","incomplete","throttled","informational"]},"details":{"type":"object","description":"Internal error code.","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","description":"URI of the coding system specification.","example":"https://fhir.nhs.uk/R4/CodeSystem/Spine-ErrorOrWarningCode"},"version":{"type":"string","description":"Version of the coding system in use.","example":"1"},"code":{"type":"string","description":"Symbol in syntax defined by the system.","example":"INVALID_VALUE"},"display":{"type":"string","description":"Representation defined by the system.","example":"Provided value is invalid"}}}}}},"diagnostics":{"type":"string","description":"Additional diagnostic information about the issue. This information is subject to change."}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"structure","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"ACCESS_DENIED","display":"access has been denied to process this request"}]}}]}}}},"5XX":{"description":"\nA 5xx status code means the server has a problem. For more details on the most common 5xx status codes and their meanings see the [HTTP status codes](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes).\n"}}}},"/datasets/{id}":{"get":{"summary":"Get data set details","operationId":"get-datasets-id","description":"\n## Overview\nUse this endpoint to get data set details for a given data set persistent identifier.\n\n## Sandbox test scenarios\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| ----------------------------- | -------------------------------------------------------------------- | ------------------------------------------ |\n| Data set exists | `id`=`dd5f0174-575f-4f4c-a4fc-b406aab953d9` | HTTP Status 200 with data set metadata in response body |\n| Data set does not exist | `id`= any other valid UUID | HTTP Status 404 with problem description |\n\n\nYou can try out the sandbox using the 'Try this API' feature on this page.\n","parameters":[{"in":"header","name":"apikey","description":"API key to authenticate with.","schema":{"type":"string"},"required":true},{"in":"header","name":"X-Correlation-ID","required":false,"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},{"in":"header","name":"X-Request-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n","schema":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","example":"60E0B220-8136-4CA5-AE46-1D97EF59D068"}},{"in":"path","name":"id","description":"The persistent identifier of the data set.","schema":{"type":"string","format":"uuid","example":"dd5f0174-575f-4f4c-a4fc-b406aab953d9"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"HDR UK Dataset Metadata Schema.","required":["identifier","version","revisions","issued","modified","summary","accessibility"],"additionalProperties":false,"properties":{"identifier":{"description":"System data set identifier (logical identifier of the dataset resource assigned by the Central Metastore). This is not the Dataset persistent identifier that is common across all dataset resource revisions.","anyOf":[{"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}$","minLength":36,"maxLength":36,"example":"226fb3f1-4471-400a-8c39-2b66d46a39b6"},{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}]},"version":{"type":"string","description":"Data set metadata version.","pattern":"^([0-9]+)\\.([0-9]+)\\.([0-9]+)$","example":"1.1.0"},"revisions":{"description":"Data set Revisions. Includes the Semantic Version of the data set and URL endpoint to obtain the version.","type":"array","items":{"allOf":[{"required":["version","url"],"additionalProperties":false,"properties":{"version":{"type":"string","pattern":"^([0-9]+)\\.([0-9]+)\\.([0-9]+)$","example":"1.1.0"},"url":{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}}}]}},"issued":{"description":"Data set Metadata Creation Date.","type":"string","format":"date-time","example":"2020-08-05T14:35:59+00:00"},"modified":{"description":"Data set Metadata Modification Date.","type":"string","format":"date-time","example":"2021-01-28T14:15:46+00:00"},"summary":{"description":"Summary metadata must be completed by Data Custodians onboarding. metadata into the Innovation Gateway MVP.","required":["title","abstract","publisher","contactPoint","keywords"],"additionalProperties":false,"properties":{"title":{"description":"Title of the data set limited to 80 characters. The title is a short description of the data set that is unique across the Gateway. It can be prefixed with an organisation name or identifier to differentiate it from other data sets within the Gateway.","example":"North West London COVID-19 Patient Level Situation Report","allOf":[{"type":"string","minLength":2,"maxLength":80}]},"abstract":{"description":"The data set Abstract provides a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract allows the reader to determine the scope of the data collection and accurately summarise its content.","example":"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.","allOf":[{"type":"string","minLength":5,"maxLength":255}]},"publisher":{"description":"Data set publisher is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most cases this is the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this is different i.e. Tissue Directory is an HDR UK Gateway organisation but coordinates activities across a number of data publishers such as Cambridge Blood and Stem Cell Biobank.","allOf":[{"type":"object","required":["name","contactPoint"],"description":"Organisation metadata describes the publishing organisation for purposes of discovery and identification.","properties":{"identifier":{"description":"The Grid.ac identifier (see https://www.grid.ac/institutes) for the organisation.","allOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}]},"name":{"description":"Name of the organisation.","allOf":[{"type":"string","minLength":2,"maxLength":80}]},"logo":{"description":"A logo associated with the Gateway Organisation. The following formats are accepted .jpg, .png or .svg.","allOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}]},"description":{"description":"URL that describes the organisation.","allOf":[{"type":"string","minLength":2,"maxLength":3000}]},"contactPoint":{"description":"Organisation contact point(s).","anyOf":[{"type":"string","format":"email"},{"type":"array","items":{"allOf":[{"type":"string","format":"email"}]}}]},"memberOf":{"description":"Indicates if the organisation is an Alliance Member or a Hub.","allOf":[{"type":"string","enum":["HUB","ALLIANCE","OTHER","NCS"]}]},"accessRights":{"description":"The URL of a webpage where the data access request process and/or guidance is provided. Can support multiple access processes i.e. industry vs academic.","anyOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"},{"type":"array","items":{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}}]},"deliveryLeadTime":{"description":"Indication of the typical processing times based on the types of requests typically received. Note: This value is used as default access request duration for all data sets submitted by the organisation. However, there is opportunity to overwrite this value for each data set.","allOf":[{"type":"string","enum":["LESS 1 WEEK","1-2 WEEKS","2-4 WEEKS","1-2 MONTHS","2-6 MONTHS","MORE 6 MONTHS","VARIABLE","NOT APPLICABLE","OTHER"]}]},"accessService":{"example":"https://cnfl.extge.co.uk/display/GERE/Research+Environment+User+Guide","description":"Brief description of the data access services that are available including: environment that is currently available to researchers; additional consultancy and services; any indication of costs associated. If no environment is currently available, accessService metata indicates the current plans and timelines; when and how data will be made available to researchers. Note: This value is used as default access environment for all data sets submitted by the organisation. However, there is opportunity to overwrite this value for each data set.","allOf":[{"type":"string","minLength":2,"maxLength":5000}]},"accessRequestCost":{"description":"Link(s) to a webpage or a short description detailing the commercial model for processing data access requests for the organisation (if available) which Indicates the commercial model or cost (in GBP) for processing each data access request by the data custodian.","anyOf":[{"type":"string","minLength":2,"maxLength":1000},{"type":"array","items":{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}}]},"dataUseLimitation":{"description":"An indication of consent permissions for data sets and/or materials. Relates to the purposes for which data sets and/or material might be removed, stored or used. Existing data-sharing arrangements such as the HDR UK HUB data sharing agreement or the NIHR HIC data sharing agreement are indicated within access rights. This value is used as terms for all data sets submitted by the organisation. However, there is opportunity to overwrite this value for each data set.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","enum":["GENERAL RESEARCH USE","COMMERCIAL RESEARCH USE","GENETIC STUDIES ONLY","NO GENERAL METHODS RESEARCH","NO RESTRICTION","GEOGRAPHICAL RESTRICTIONS","INSTITUTION SPECIFIC RESTRICTIONS","NOT FOR PROFIT USE","PROJECT SPECIFIC RESTRICTIONS","RESEARCH SPECIFIC RESTRICTIONS","USER SPECIFIC RESTRICTION","RESEARCH USE ONLY","NO LINKAGE"]}]},"uniqueItems":true,"minItems":1}]},"dataUseRequirements":{"description":"Indicates if there are any additional conditions set for use. Multiple requirements may be provided. These restrictions are documented in access rights information.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","enum":["COLLABORATION REQUIRED","PROJECT SPECIFIC RESTRICTIONS","ETHICS APPROVAL REQUIRED","INSTITUTION SPECIFIC RESTRICTIONS","GEOGRAPHICAL RESTRICTIONS","PUBLICATION MORATORIUM","PUBLICATION REQUIRED","RETURN TO DATABASE OR RESOURCE","TIME LIMIT ON USE","DISCLOSURE CONTROL","NOT FOR PROFIT USE","USER SPECIFIC RESTRICTION"]}]},"uniqueItems":true,"minItems":1}]}}}]},"contactPoint":{"type":"string","default":"Defaulted to the contact point of the primary organisation of the user however, can be overridden for specific data sets","example":"SAILDatabank@swansea.ac.uk","description":"Dedicated email address used to coordinate data access requests with the publisher.","allOf":[{"type":"string","format":"email"}]},"keywords":{"description":"Provides relevant and specific keywords that can improve the SEO of your data set as a comma separated list. A standardised list of keywords and synonyms across data sets is being compliled to make filtering easier for users.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","minLength":2,"maxLength":80}]},"uniqueItems":true,"minItems":1}]},"alternateIdentifiers":{"description":"Alternate data set identifiers or local identifiers.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","minLength":2,"maxLength":1000}]},"uniqueItems":true,"minItems":1}]},"doiName":{"description":"All data sets will be attributed a DOI when available.","allOf":[{"type":"string","pattern":"^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$"}],"example":["10.3399/bjgp17X692645"]}}},"documentation":{"description":"Documentation can include a rich text description of the data set or links to media such as documents, images, presentations, videos or links to data dictionaries, profiles or dashboards. Permission to distribute any additional media has been confirmed.","additionalProperties":false,"properties":{"description":{"description":"A free-text description of the record.","allOf":[{"type":"string","minLength":2,"maxLength":3000}]},"associatedMedia":{"example":"PDF Document that describes study protocol","description":"Additional context that can be useful for researchers wanting to understand more about the data set and its relevance to their research question. Content may appear in the following formats: .jpg, .png or .svg, .pdf, .xslx or .docx. ","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}]},"uniqueItems":true,"minItems":1}]},"isPartOf":{"type":"string","default":"NOT APPLICABLE","example":"Hospital Episodes Statistics data sets (A&E, APC, OP, AC MSDS).","description":"Indicates if the data set is part of a group or family.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"anyOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"},{"type":"string","minLength":2,"maxLength":80},{"type":"string","enum":["NOT APPLICABLE"]}]},"uniqueItems":true,"minItems":1}]}}},"coverage":{"description":"Coverage information includes attributes for geographical and temporal coverage, cohort details etc. to enable a deeper understanding of the data set content so that researchers can make decisions about the relevance of the underlying data.","additionalProperties":false,"properties":{"spatial":{"description":"The geographical area covered by the data set. More information can be found in gazetteers such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.","example":"https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"anyOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}]}}]},"typicalAgeRange":{"description":"Indicates the age range in whole years of participants in the data set. Range has the following format ‘[min age] – [max age]’ where both the minimum and maximum are whole numbers (integers).","allOf":[{"type":"string","pattern":"(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])-(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])"}]},"physicalSampleAvailability":{"example":"BONE MARROW","description":"Availability of physical samples associated with the data set. Indicates the types of samples that are available. Multiple responses may be provided. “AVAILABILITY TO BE CONFIRMED” indicates that samples are not yet available. “NOT AVAILABLE” indicates that samples are not available.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"type":"string","enum":["NOT AVAILABLE","BONE MARROW","CANCER CELL LINES","CORE BIOPSY","CDNA OR MRNA","DNA","FAECES","IMMORTALIZED CELL LINES","MICRORNA","PERIPHERAL BLOOD CELLS","PLASMA","PM TISSUE","PRIMARY CELLS","RNA","SALIVA","SERUM","SWABS","TISSUE","URINE","WHOLE BLOOD","AVAILABILITY TO BE CONFIRMED","OTHER"]},"uniqueItems":true,"minItems":1}]},"followup":{"type":"string","default":"UNKNOWN","description":"Where available, typical time span that a patient appears in the data set (follow up period).","allOf":[{"type":"string","enum":["0 - 6 MONTHS","6 - 12 MONTHS","1 - 10 YEARS","> 10 YEARS","UNKNOWN","CONTINUOUS","OTHER"]}]},"pathway":{"description":"Indicates if the data set is representative of the patient pathway and any limitations the data set may have with respect to pathway coverage. This could include if the data set is from a single speciality or area, a single tier of care, linked across two tiers (e.g. primary and secondary care), or an integrated care record covering the whole patient pathway.","allOf":[{"type":"string","minLength":2,"maxLength":3000}]}}},"provenance":{"description":"Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.","required":["temporal"],"additionalProperties":false,"properties":{"origin":{"allOf":[{"additionalProperties":false,"properties":{"purpose":{"description":"Indicates why the data set was collected.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","enum":["STUDY","DISEASE REGISTRY","TRIAL","CARE","AUDIT","ADMINISTRATIVE","FINANCIAL","STATUTORY","OTHER"]}]},"uniqueItems":true,"minItems":1}]},"source":{"description":"Source of the data extraction.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","enum":["EPR","ELECTRONIC SURVEY","LIMS","OTHER INFORMATION SYSTEM","PAPER BASED","FREETEXT NLP","MACHINE GENERATED","OTHER"]}]},"uniqueItems":true,"minItems":1}]},"collectionSituation":{"description":"Data collection setting. Multiple responses may be provided.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"type":"string","enum":["CLINIC","PRIMARY CARE","ACCIDENT AND EMERGENCY","OUTPATIENTS","IN-PATIENTS","SERVICES","COMMUNITY","HOME","PRIVATE","PHARMACY","SOCIAL CARE","LOCAL AUTHORITY","NATIONAL GOVERNMENT","OTHER"]},"uniqueItems":true,"minItems":1}]}}}]},"temporal":{"allOf":[{"required":["accrualPeriodicity","timeLag","startDate"],"additionalProperties":false,"properties":{"accrualPeriodicity":{"type":"string","default":"","description":"Frequency of distribution release. If a data set is distributed regularly then a distribution release periodicity from the constrained list is used which indicates the next release date. When the release date becomes historical, a new release date can be calculated based on the publishing periodicity. STATIC is used where a data set has been published and will remain static along with an explicit distribution release date. If a data set is released on an irregular basis or “on-demand” it is categorised as IRREGULAR and the release date is null. If a data set can be published in real-time or near-real-time it is categorised as CONTINUOUS and the release date is null. For more information see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/.","allOf":[{"type":"string","enum":["STATIC","IRREGULAR","CONTINUOUS","BIENNIAL","ANNUAL","BIANNUAL","QUARTERLY","BIMONTHLY","MONTHLY","BIWEEKLY","WEEKLY","SEMIWEEKLY","DAILY","OTHER"]}]},"distributionReleaseDate":{"description":"Date of the latest release of the data set. If this is a regular release i.e. quarterly, or this is a static data set this is completed alongside Periodicity. If this is Irregular or Continuously released this is left blank. Periodicity and release date can be used to determine when the next release is expected. E.g. if the release date is documented as 01/01/2020 and it is now 20/04/2020 and there is a quarterly release schedule, the latest release will be calculated as 01/04/2020.","anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}]},"startDate":{"description":"The start of the time period that the data set provides coverage for. If there are multiple cohorts in the data set with varying start dates, the earliest date is provided and more information is included in the description or the media attribute.","anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}]},"endDate":{"description":"The end of the time period that the data set provides coverage for. If there are multiple cohorts in the data set with varying end dates, the latest date is used and the description or the media attribute provides more information.","anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"},{"type":"string","enum":["CONTINUOUS"]}]},"timeLag":{"description":"Indicates the typical time-lag between an event and the data for that event appearing in the data set.","allOf":[{"type":"string","enum":["LESS 1 WEEK","1-2 WEEKS","2-4 WEEKS","1-2 MONTHS","2-6 MONTHS","MORE 6 MONTHS","VARIABLE","NO TIMELAG","NOT APPLICABLE","OTHER"]}]}}}]}}},"accessibility":{"description":"Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.","required":["access"],"additionalProperties":false,"properties":{"usage":{"description":"Information about how the data can be used and how it is currently being used.","additionalProperties":false,"properties":{"dataUseLimitation":{"description":"Provides an indication of consent permissions for data sets and/or materials, and relates to the purposes for which data sets and/or material might be removed, stored or used. NOTE: we have extended the DUO to include a value for NO LINKAGE.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","enum":["GENERAL RESEARCH USE","COMMERCIAL RESEARCH USE","GENETIC STUDIES ONLY","NO GENERAL METHODS RESEARCH","NO RESTRICTION","GEOGRAPHICAL RESTRICTIONS","INSTITUTION SPECIFIC RESTRICTIONS","NOT FOR PROFIT USE","PROJECT SPECIFIC RESTRICTIONS","RESEARCH SPECIFIC RESTRICTIONS","USER SPECIFIC RESTRICTION","RESEARCH USE ONLY","NO LINKAGE"]}]},"uniqueItems":true,"minItems":1}]},"dataUseRequirements":{"description":"Indicates if there are any additional conditions set for use if any, multiple requirements may be provided. These restrictions are documented in access rights information.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","enum":["COLLABORATION REQUIRED","PROJECT SPECIFIC RESTRICTIONS","ETHICS APPROVAL REQUIRED","INSTITUTION SPECIFIC RESTRICTIONS","GEOGRAPHICAL RESTRICTIONS","PUBLICATION MORATORIUM","PUBLICATION REQUIRED","RETURN TO DATABASE OR RESOURCE","TIME LIMIT ON USE","DISCLOSURE CONTROL","NOT FOR PROFIT USE","USER SPECIFIC RESTRICTION"]}]},"uniqueItems":true,"minItems":1}]},"resourceCreator":{"description":"Text that is included as part of any citation that credits the data set. This is typically just the name of the publisher and never includes employee details.","anyOf":[{"type":"string","minLength":2,"maxLength":1000},{"type":"array","items":{"type":"string","minLength":2,"maxLength":1000}}]},"investigations":{"description":"Investigations.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}]}}]},"isReferencedBy":{"description":"Keystone paper and list of known citations associated with the data set. Multiple entries may be provided.","anyOf":[{"type":"string","pattern":"^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$"},{"type":"array","items":{"allOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}]}}]}}},"access":{"description":"This section includes information about data access.","required":["accessRights","jurisdiction","dataController"],"additionalProperties":false,"properties":{"accessRights":{"description":"Access rights.","anyOf":[{"type":"string","pattern":"^In Progress$"},{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"},{"type":"array","items":{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}}]},"accessService":{"example":"https://cnfl.extge.co.uk/display/GERE/Research+Environment+User+Guide","description":"Provides a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, indicates the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all data sets submitted by the organisation. However, there will be the opportunity to overwrite this value for each data set.","allOf":[{"type":"string","minLength":2,"maxLength":5000}]},"accessRequestCost":{"description":"Provides link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian.","anyOf":[{"type":"string","minLength":2,"maxLength":5000},{"type":"array","items":{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}}]},"deliveryLeadTime":{"description":"Provides an indication of the typical processing times based on the types of requests typically received.","allOf":[{"type":"string","enum":["LESS 1 WEEK","1-2 WEEKS","2-4 WEEKS","1-2 MONTHS","2-6 MONTHS","MORE 6 MONTHS","VARIABLE","NOT APPLICABLE","OTHER"]}]},"jurisdiction":{"type":"string","default":"GB-ENG","description":"Country code from ISO 3166-1 country codes and the associated ISO 3166-2 for regions, cities, states etc. for the country/state under whose laws the data subjects’ data is collected, processed and stored.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","pattern":"^[A-Z]{2}(-[A-Z]{2,3})?$"}]}}]},"dataController":{"description":"Data Controller means a person/entity who (either alone or jointly or in common with other persons/entities) determines the purposes for which and the way any Data Subject data, specifically personal data or are to be processed.","allOf":[{"type":"string","minLength":2,"maxLength":5000}]},"dataProcessor":{"description":"A Data Processor, in relation to any Data Subject data, specifically personal data, means any person/entity (other than an employee of the data controller) who processes the data on behalf of the data controller.","allOf":[{"type":"string","minLength":2,"maxLength":5000}]}}},"formatAndStandards":{"description":"This metadata includes technical attributes for language vocabularies, sizes etc. and gives researchers information about the processing of the underlying data.","additionalProperties":false,"required":["vocabularyEncodingScheme","conformsTo","language","format"],"properties":{"vocabularyEncodingScheme":{"type":"string","default":"LOCAL","description":"Relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the data set. Local standards, are made explicit. More than one vocabulary may be provided.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","enum":["LOCAL","OPCS4","READ","SNOMED CT","SNOMED RT","DM PLUS D","DM+D","NHS NATIONAL CODES","NHS SCOTLAND NATIONAL CODES","NHS WALES NATIONAL CODES","ODS","LOINC","ICD10","ICD10CM","ICD10PCS","ICD9CM","ICD9","ICDO3","AMT","APC","ATC","CIEL","HPO","CPT4","DPD","DRG","HEMONC","JMDC","KCD7","MULTUM","NAACCR","NDC","NDFRT","OXMIS","RXNORM","RXNORM EXTENSION","SPL","OTHER"]}]},"minItems":0}]},"conformsTo":{"type":"string","default":"LOCAL","description":"Standardised data models that the data set has been stored in or transformed to, such as OMOP or FHIR. Data that is only available in a local format, is made explicit.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","enum":["HL7 FHIR","HL7 V2","HL7 CDA","HL7 CCOW","LOINC","DICOM","I2B2","IHE","OMOP","OPENEHR","SENTINEL","PCORNET","CDISC","NHS DATA DICTIONARY","NHS SCOTLAND DATA DICTIONARY","NHS WALES DATA DICTIONARY","LOCAL","OTHER"]}]}}]},"language":{"type":"string","description":"Lists all the languages in which the data set metadata and underlying data is made available.","default":"en","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn",false,"nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}]},"minItems":1}]},"format":{"description":"Multiple available formats may be specified. For more information see https://www.iana.org/assignments/media-types/media-types.xhtml","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","minLength":1}]},"minItems":1}]}}}}},"enrichmentAndLinkage":{"description":"Enrichment and Linkage includes information about related data sets that may have previously been linked, as well as indicating if there is the opportunity to link to other data sets in the future. This metadata indicates to researchers where a data set has been enriched and/or derivations, scores and existing tools are available.","additionalProperties":false,"properties":{"qualifiedRelation":{"description":"An indication of other data sets that have previously been linked to this data set and their availability. ","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"anyOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"},{"type":"string","minLength":2,"maxLength":80}]}}]},"derivation":{"description":"Indicates if derived data sets or predefined extracts are available and the type of derivation available.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","minLength":5,"maxLength":255}]}}]},"tools":{"description":"URL of any analysis tools or models that have been created for this data set and are available for further use. Multiple tools may be provided.","anyOf":[{"type":"string","pattern":"([^,]+)"},{"type":"array","items":{"allOf":[{"type":"string","format":"uri","example":"https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6"}]},"minItems":0}]}}},"observations":{"description":"\n\nMultiple observations about the data set may be provided. Examples: \n\n| Statistical Population | Population Size | Measured Property | Observation Date | Population Description |\n|------------------------| ---------------- | ----------------- | ---------------- | ---------------------- |\n| Persons | 32937 | Count | 2017 | Individuals appearing in the data set between April - Sept 2017 |\n| Events | 14900000 | Count | 15/01/2021 | Number of unique death registrations since 1993 in England and Wales |\n| Findings | 17,891 | Count | 2020-09-03 | Cancer Germline - Number of genomes |\n","type":"array","items":{"allOf":[{"required":["observedNode","measuredValue","observationDate","measuredProperty"],"additionalProperties":false,"properties":{"observedNode":{"example":"PERSONS","description":"Supports statistical populations codes for an observation.","allOf":[{"type":"string","enum":["PERSONS","EVENTS","FINDINGS"]}]},"measuredValue":{"description":"Provides the population size associated with the population type the data set i.e. 1000 people in a study, or 87 images (MRI) of Knee Usage Note: Used with Statistical Population, which specifies the type of the population in the data set.","type":"integer"},"disambiguatingDescription":{"description":"Detailed description of the population scope of the data set. May be represented in SNOMED CT format.","allOf":[{"type":"string","minLength":5,"maxLength":255}]},"observationDate":{"type":"string","default":"release date","description":"Date that the observation was made. Some data sets may be continuously updated and the number of records will change regularly, so the observation date provides users with the date that the analysis or query was run to generate the particular observation. Multiple observations can be made i.e. an observation of cumulative COVID positive cases by specimen on the 1/1/2021 could be 2M. On the 8/1/2021 a new observation could be 2.1M.","anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}]},"measuredProperty":{"type":"string","default":"COUNT","description":"The default is \"COUNT\".","allOf":[{"type":"string","enum":["COUNT","Count","count"]}]}}}]}}}},"example":{"identifier":"80cbda88-dc12-4191-9a8e-f8cf2fdc29e8","version":"1.0.2","revisions":[{"version":"1.0.2","url":"https://internal-dev.api.service.nhs.uk/health-research-data-catalogue/datasetrevisions/80cbda88-dc12-4191-9a8e-f8cf2fdc29e8"}],"issued":"2022-07-12T11:34:05.538000+00:00","modified":"2022-08-04T15:56:42.204000+00:00","summary":{"title":"Civil Registration - Deaths","abstract":"Deaths registration data (all deaths in England and Wales) collected from The Registrar General for England and Wales. Record-level person data set, where a record represents one death registration.","publisher":{"name":"NHS DIGITAL","memberOf":"ALLIANCE","contactPoint":"enquiries@nhsdigital.nhs.uk"},"contactPoint":"enquiries@nhsdigital.nhs.uk","keywords":["Wales Deaths, Welsh Deaths, Deaths, GRO, Deceased, English Deaths, Registered D"]},"documentation":{"description":"Deaths registration data (all deaths in England and Wales) collected from The Registrar General for England and Wales. Record-level patient data set, where a record represents one death registration. The data are collected at source from Local Registry offices at the point of death registration. The data are collated nationally by the Register General before being passed to the Office for National Statistics (ONS), for use in statistics and coding. Coding includes such things cause of death coding using the International Classifications of Diseases (ICD) coding system, attributing socio-economic code classifications based on occupation. ONS maintains its own version of the data set for its use in statistics. The Civil Registration of Deaths data contains 14 million unique registrations since 1993 onwards, increasing yearly. Average 500,000 - 600,000 new death registrations yearly. Records cover all deaths registered in England & Wales. ICD coding is 9th and 10th. https://digital.nhs.uk/services/data-access-request-service-dars.\n\nTimescales 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":"https://www.ons.gov.uk/peoplepopulationandcommunity/birthsdeathsandmarriages/deaths, https://digital.nhs.uk/coronavirus/coronavirus-data-services-updates/mortality-data-review","isPartOf":"NOT APPLICABLE"},"coverage":{"followup":"OTHER","spatial":["https://www.geonames.org/6269131/england.html","https://www.geonames.org/2634895/wales.html"],"physicalSampleAvailability":["NOT AVAILABLE"],"pathway":"NOT APPLICABLE","typicalAgeRange":"0-150"},"provenance":{"temporal":{"endDate":"2022-08-31","timeLag":"1-2 WEEKS","accrualPeriodicity":"CONTINUOUS","startDate":"1993-01-01"},"origin":{"purpose":["ADMINISTRATIVE"],"source":["OTHER"],"collectionSituation":["OTHER"]}},"accessibility":{"formatAndStandards":{"language":["en"],"vocabularyEncodingScheme":["OTHER","ICD10","NHS NATIONAL CODES","ODS","ICD9"],"format":["CSV","Text"],"conformsTo":["CDISC","NHS DATA DICTIONARY"]},"usage":{"dataUseLimitation":"No Restriction","resourceCreator":["NHS Digital"],"dataUseRequirements":["INSTITUTION SPECIFIC RESTRICTIONS","PROJECT SPECIFIC RESTRICTIONS","TIME LIMIT ON USE","ETHICS APPROVAL REQUIRED","USER SPECIFIC RESTRICTION"],"investigations":["https://digital.nhs.uk/services/data-access-request-service-dars/register-of-approved-data-releases"]},"access":{"dataController":"Department of Health and Social Care","jurisdiction":["GB-EAW"],"dataProcessor":"NHS Digital","accessService":"Death registrations data are available via a range of services which can be applied for through the Data Access Request Service (DARS). This includes via an extract, through the Data Access Environment (DAE) which also underpins the Trusted Research Environment. 2-6 MONTHS. PLEASE NOTE WE WILL ONLY PAUSE THE ELAPSED TIME WHEN WE REQUIRE FURTHER DETAIL OR APPROVALS FROM AN EXTERNAL PROVIDER ARE REQUIRED.","accessRights":["https://digital.nhs.uk/services/data-access-request-service-dars"],"accessRequestCost":"https://digital.nhs.uk/services/data-access-request-service-dars/data-access-request-service-dars-charges","deliveryLeadTime":"OTHER"}},"enrichmentAndLinkage":{"tools":["https://digital.nhs.uk/about-nhs-digital/our-work/keeping-patient-data-safe/gdpr/gdpr-register/gdpr-information-for-the-national-back-office/birth-and-death-registration-indexes-gdpr-information"],"qualifiedRelation":["https://digital.nhs.uk/services/data-access-request-service-dars/register-of-approved-data-releases"],"derivation":["Data will be minimised as appropriate relative to the data access application"]},"observations":[{"observedNode":"EVENTS","measuredValue":14900000,"disambiguatingDescription":"Number of unique death registrations since 1993 in england and Wales","observationDate":"2021-01-15","measuredProperty":"Count"}]}}}},"4XX":{"description":"An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | --------------------------------------------- |\n| 401 | ACCESS_DENIED | Access token missing, invalid or expired, or calling application not configured for this operation. |\n| 404 | RESOURCE_NOT_FOUND | No dataset resources found. |\n| 404 | INVALID_ENDPOINT_PATH | Invalid endpoint path. | \n| 429 | TOO_MANY_REQUESTS | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n","content":{"application/fhir+json":{"schema":{"type":"object","description":"Outcome of an operation that does not result in a resource or bundle being returned, for example an error or an async/batch submission.\nThere are a number of possible error codes that can be returned along with a more detailed description in the `display` field.\n","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"FHIR error code.","example":"invalid","enum":["invalid","structure","required","value","invariant","security","login","unknown","expired","forbidden","suppressed","processing","not-supported","duplicate","multiple-matches","not-found","deleted","too-long","code-invalid","extension","too-costly","business-rule","conflict","transient","lock-error","no-store","exception","timeout","incomplete","throttled","informational"]},"details":{"type":"object","description":"Internal error code.","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","description":"URI of the coding system specification.","example":"https://fhir.nhs.uk/R4/CodeSystem/Spine-ErrorOrWarningCode"},"version":{"type":"string","description":"Version of the coding system in use.","example":"1"},"code":{"type":"string","description":"Symbol in syntax defined by the system.","example":"INVALID_VALUE"},"display":{"type":"string","description":"Representation defined by the system.","example":"Provided value is invalid"}}}}}},"diagnostics":{"type":"string","description":"Additional diagnostic information about the issue. This information is subject to change."}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"structure","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"ACCESS_DENIED","display":"access has been denied to process this request"}]}}]}}}},"5XX":{"description":"\nA 5xx status code means the server has a problem. For more details on the most common 5xx status codes and their meanings see the [HTTP status codes](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes).\n"}}}}},"components":{"parameters":{"CorrelationID":{"in":"header","name":"X-Correlation-ID","required":false,"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},"RequestID":{"in":"header","name":"X-Request-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n","schema":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","example":"60E0B220-8136-4CA5-AE46-1D97EF59D068"}},"ApiKey":{"in":"header","name":"apikey","description":"API key to authenticate with.","schema":{"type":"string"},"required":true}}}}