/
AR7 Metadata Schema

AR7 Metadata Schema

First the current output of a JSON Schema Specification of the IPCC v1.0.1(AR7) is as follows (ps currently this is work in progress - some of the required fields are not specified as yet):

{ "$schema" : "http://json-schema.org/draft-07/schema", "$id" : "https://github.com/MetadataWorks/Schemata/ClimateScience/schema/descriptive.metadata.v2d.schema", "type" : "object", "title" : "IPCC Dataset", "description" : "IPCC descriptive metadata specification v1.1.0", "definitions" : { "dataModel" : { "required" : [ "summary", "accessible" ], "additionalProperties" : false, "$id" : "#/definitions/dataModel", "type" : "object", "properties" : { "accessibility" : { "id" : "#/properties/accessibility", "title" : "Accessibility", "description" : "Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets. This section includes information about how the data can be used and how it is currently being used.", "$ref" : "#/definitions/accessibility" }, "coverage" : { "id" : "#/properties/coverage", "title" : "Coverage", "description" : "This information includes attributes for geographical and temporal coverage, cohort details etc. to enable a deeper understanding of the dataset content so that researchers can make decisions about the relevance of the underlying data.", "$ref" : "#/definitions/coverage" }, "dataStatus" : { "id" : "#/properties/dataStatus", "title" : "Data Status", "description" : "This section allows data custodians to indicate the status of the data (and define a data access URL if applicable) so that researchers understand how to access the data.", "$ref" : "#/definitions/dataStatus" }, "documentation" : { "id" : "#/properties/documentation", "title" : "Documentation", "description" : "Documentation can include a rich text description of the dataset or links to media such as documents, images, presentations, videos or links to data dictionaries, profiles or dashboards.", "$ref" : "#/definitions/documentation" }, "enrichment&Linkage" : { "id" : "#/properties/enrichment&Linkage", "title" : "Enrichment & Linkage", "description" : "This section includes information about related datasets that may have previously been linked, as well as indicating if there is the opportunity to link to other datasets in the future. If a dataset has been enriched and/or derivations, scores and existing tools are available this section allows providers to indicate this to researchers.", "$ref" : "#/definitions/enrichment&Linkage" }, "provenance" : { "id" : "#/properties/provenance", "title" : "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.\n\nhttps://www.w3.org/2001/sw/wiki/PROV", "$ref" : "#/definitions/provenance" }, "structuralMetadata" : { "id" : "#/properties/structuralMetadata", "title" : "Structural Metadata", "description" : "We recommend that sites provide a data dictionary of structural metadata that includes the following information (please see the <a href=\"https://metadata.atlassian.net/wiki/spaces/IDSD/pages/1854474061/STRUCTURAL+METADATA\" class=\"light\" target=\"onboardingCompletionGuidance\">Structural Metadata Completion Guidance</a> for full details including examples).", "$ref" : "#/definitions/structuralMetadata" }, "summary" : { "id" : "#/properties/summary", "title" : "Summary", "description" : "Summary metadata must be completed by Data Custodians onboarding metadata.", "$ref" : "#/definitions/summary" } } }, "accessibility" : { "$id" : "#/definitions/accessibility", "type" : "object", "title" : "Accessibility", "$comment" : "dataClass", "description" : "Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets. This section includes information about how the data can be used and how it is currently being used.", "properties" : { "access" : { "$id" : "#/accessibility/access", "title" : "Access", "description" : "Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets. This section includes information about data access.", "$ref" : "#/definitions/access" }, "usage" : { "$id" : "#/accessibility/usage", "title" : "Usage", "description" : "Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets. This section includes information about how the data can be used and how it is currently being used.", "$ref" : "#/definitions/usage" } } }, "coverage" : { "$id" : "#/definitions/coverage", "type" : "object", "title" : "Coverage", "$comment" : "dataClass", "description" : "This information includes attributes for geographical and temporal coverage, cohort details etc. to enable a deeper understanding of the dataset content so that researchers can make decisions about the relevance of the underlying data.", "properties" : { "geographicBoundingBox" : { "$id" : "#/coverage/geographicBoundingBox", "title" : "Geographic Bounding Box", "description" : "The geographic bounding box describes the spatial coverage in terms of a square as specified by the longitude and latitude values of the lower left and upper right corners.\nPlease enter the four values in terms of degrees North or East, with longitudes given relative to the prime meridian (yielding values between -180E and 180E).\nNote that a \"north up\" area is described so that generally the upper right longitude will be greater than the lower left longitude.\n\nref: https://www.w3.org/TR/vocab-dcat-3/#Property:location_bbox", "$ref" : "#/definitions/geographicBoundingBox" }, "endDate" : { "$id" : "#/coverage/endDate", "title" : "End Date", "$comment" : "dataElement", "description" : "The end of the time period that the dataset provides coverage for. <br><br>If the dataset is “Continuous” and has no known end date, please leave blank. <br><br>If there are multiple cohorts in the dataset with varying end dates, please provide the latest date and use the description or the media attribute to provide more information.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:period_end_date", "allOf" : [ { "$ref" : "#/definitions/xs:date" } ] }, "spatialAggregation" : { "$id" : "#/coverage/spatialAggregation", "title" : "Spatial Aggregation", "$comment" : "dataElement", "description" : "A statement describing the type of spatial aggregation used in the dataset (e.g. region, area, grid, etc.).", "allOf" : [ { "$ref" : "#/definitions/shortdescription" } ] }, "spatialResolution" : { "$id" : "#/coverage/spatialResolution", "title" : "Spatial Resolution", "$comment" : "dataElement", "description" : "A statement of the amount of detail provided to sufficiently assess fitness for purpose. Precision can be expressed as a distance, or expressed without unit of measure specifying spatial resolution by means of an \"equivalent scale\" with a fraction (e.g., 1:1,000, 1:1,000,000) or alternatively specifying the angular distance.<br><br>Where the spatial resolution of the dataset is not the original resolution of the data (e.g., the resolution at which a climate model was run), you can note that in the description.\n\nmaybe : https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial_resolution", "allOf" : [ { "$ref" : "#/definitions/shortdescription" } ] }, "startDate" : { "$id" : "#/coverage/startDate", "title" : "Start Date", "$comment" : "dataElement", "description" : "The start of the time period that the dataset provides coverage for. <br><br>If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:period_start_date", "allOf" : [ { "$ref" : "#/definitions/xs:date" } ] }, "temporalResolution" : { "$id" : "#/coverage/temporalResolution", "title" : "Temporal Resolution", "$comment" : "dataElement", "description" : "Minimum time period resolvable in the dataset distribution.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal_resolution", "allOf" : [ { "$ref" : "#/definitions/temporalresolution" } ] } } }, "dataStatus" : { "$id" : "#/definitions/dataStatus", "type" : "object", "title" : "Data Status", "$comment" : "dataClass", "description" : "This section allows data custodians to indicate the status of the data (and define a data access URL if applicable) so that researchers understand how to access the data.", "properties" : { "dataAccess" : { "$id" : "#/dataStatus/dataAccess", "title" : "Data Access", "$comment" : "dataElement", "description" : "A URL of the resource that gives access to the dataset. E.g. landing page, download link, service desk request. If the URL is an email address, you need to prefix it like this: mailto:name@sample.co.uk.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url", "allOf" : [ { "$ref" : "#/definitions/url" } ] }, "dataStatus" : { "$id" : "#/dataStatus/dataStatus", "title" : "Data Status", "$comment" : "dataElement", "description" : "Please select the data status that best describes the environment researchers will use to access the data.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_status", "allOf" : [ { "$ref" : "#/definitions/datastatus" } ] } } }, "documentation" : { "$id" : "#/definitions/documentation", "type" : "object", "title" : "Documentation", "$comment" : "dataClass", "description" : "Documentation can include a rich text description of the dataset or links to media such as documents, images, presentations, videos or links to data dictionaries, profiles or dashboards.", "properties" : { "associatedMedia" : { "$id" : "#/documentation/associatedMedia", "title" : "Associated Media", "$comment" : "dataElement", "description" : "Please provide any media associated with the dataset using a valid URI for the content. This is an opportunity to provide additional context that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question.<br><br>The following formats will be previewed .jpg, .png or .svg, .pdf, .xslx or .docx. Other formats can be used as url links.<br><br>Note: media asset can be hosted by the organisation or uploaded\n\nhttps://schema.org/associatedMedia", "allOf" : [ { "$ref" : "#/definitions/url" } ] }, "description" : { "$id" : "#/documentation/description", "title" : "Description", "$comment" : "dataElement", "description" : "An HTML account of the data that provides context and scope of the data, limited to 10000 characters, and/or a resolvable URL that describes the dataset.<br><br>Additional information can be recorded and included using media.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:record_description", "allOf" : [ { "$ref" : "#/definitions/longdescription" } ] }, "isPartOf" : { "$id" : "#/documentation/isPartOf", "title" : "Is Part Of", "$comment" : "dataElement", "description" : "Please complete only if the dataset is part of a group or collection of datasets.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_relation", "allOf" : [ { "$ref" : "#/definitions/shortdescription" } ] } } }, "enrichment&Linkage" : { "$id" : "#/definitions/enrichment&Linkage", "type" : "object", "title" : "Enrichment & Linkage", "$comment" : "dataClass", "description" : "This section includes information about related datasets that may have previously been linked, as well as indicating if there is the opportunity to link to other datasets in the future. If a dataset has been enriched and/or derivations, scores and existing tools are available this section allows providers to indicate this to researchers.", "properties" : { "qualifiedRelation" : { "$id" : "#/enrichment&Linkage/qualifiedRelation", "title" : "Qualified Relation", "$comment" : "dataElement", "description" : "If applicable, please provide the DOI of any related datasets i.e. input to, output from, linked, referencing, referenced by. If no DOI is available for the data, please use a url, or the title of the dataset.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:relationship_relation", "allOf" : [ { "$ref" : "#/definitions/linkeddatasets" } ] }, "tools" : { "$id" : "#/enrichment&Linkage/tools", "title" : "Tools", "$comment" : "dataElement", "description" : "Please provide the URL (e.g Github) of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided.", "allOf" : [ { "$ref" : "#/definitions/url" } ] } } }, "provenance" : { "$id" : "#/definitions/provenance", "type" : "object", "title" : "Provenance", "$comment" : "dataClass", "description" : "Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.\n\nhttps://www.w3.org/2001/sw/wiki/PROV", "properties" : { "description(Provenance)" : { "$id" : "#/provenance/description(Provenance)", "title" : "Description (Provenance)", "$comment" : "dataElement", "description" : "Please indicate the purpose(s) that the dataset was collected.", "allOf" : [ { "$ref" : "#/definitions/shortdescription" } ] }, "source" : { "$id" : "#/provenance/source", "title" : "Source", "$comment" : "dataElement", "description" : "Please indicate the source of the data extraction.", "allOf" : [ { "$ref" : "#/definitions/provenanceorigin" } ] } } }, "structuralMetadata" : { "$id" : "#/definitions/structuralMetadata", "type" : "object", "title" : "Structural Metadata", "$comment" : "dataClass", "description" : "We recommend that sites provide a data dictionary of structural metadata that includes the following information (please see the <a href=\"https://metadata.atlassian.net/wiki/spaces/IDSD/pages/1854474061/STRUCTURAL+METADATA\" class=\"light\" target=\"onboardingCompletionGuidance\">Structural Metadata Completion Guidance</a> for full details including examples).", "properties" : { "structuralMetadata" : { "$id" : "#/structuralMetadata/structuralMetadata", "title" : "Structural Metadata", "$comment" : "dataElement", "description" : "Structural Metadata", "allOf" : [ { "$ref" : "#/definitions/xs:string" } ] } } }, "summary" : { "$id" : "#/definitions/summary", "type" : "object", "title" : "Summary", "$comment" : "dataClass", "description" : "Summary metadata must be completed by Data Custodians onboarding metadata.", "properties" : { "publisher" : { "$id" : "#/summary/publisher", "title" : "Publisher", "description" : "This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata.", "$ref" : "#/definitions/publisher" }, "abstract" : { "$id" : "#/summary/abstract", "title" : "Abstract", "$comment" : "dataElement", "description" : "Provide a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract should allow the reader to determine the scope of the data collection and accurately summarise its content. <br>The optimal length is one paragraph (limited to 255 characters) and effective abstracts should avoid long sentences and abbreviations where possible.\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_description", "allOf" : [ { "$ref" : "#/definitions/abstract" } ] }, "alternateIdentifier" : { "$id" : "#/summary/alternateIdentifier", "title" : "Alternate Identifier", "$comment" : "dataElement", "description" : "An identifier or identifiers other than the primary Identifier applied to the resource being registered.<br>This may be any alphanumeric string which is unique within its domain of issue.\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier\nhttp://purl.org/dc/terms/identifier", "allOf" : [ { "$ref" : "#/definitions/alternateid" } ] }, "contactPoint" : { "$id" : "#/summary/contactPoint", "title" : "Contact Point", "$comment" : "dataElement", "description" : "Please provide a valid email address that can be used to coordinate data enquiries with the publisher.<br><br>Organisations are expected to provide a dedicated email address associated with the data access request process for their organisation.<br><br>This will then be used as a default contact point for all datasets submitted by the organisation. However, there will be the opportunity to overwrite his value for each dataset.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point", "allOf" : [ { "$ref" : "#/definitions/email" } ] }, "doiName" : { "$id" : "#/summary/doiName", "title" : "DOI Name", "$comment" : "dataElement", "description" : "All IPCC DDC registered datasets should either have a Digital Object Identifier (DOI) or be working towards obtaining one. If a DOI is available and has been minted through another system/organisation, please provide the DOI. If there is not a DOI the IPCC DDC can mint a DOI for your dataset.", "allOf" : [ { "$ref" : "#/definitions/doi" } ] }, "keywords" : { "$id" : "#/summary/keywords", "title" : "Keywords", "$comment" : "dataElement", "description" : "Please provide relevant and specific keywords that can improve the SEO of your dataset. <br>IPCC could encourage users to at a minimum provide tags for: assessment report (AR[x]), Working Group, Chapter, Figure, Input, Final, Intermediate.\n\n\"https://www.w3.org/TR/vocab-dcat-3/#Property:resource_keyword\"", "allOf" : [ { "$ref" : "#/definitions/shortdescription" } ] }, "publicationDate" : { "$id" : "#/summary/publicationDate", "title" : "Publication Date", "$comment" : "dataElement", "description" : "Please provide the date on which this dataset was or will be published.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_release_date\nor\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date", "allOf" : [ { "$ref" : "#/definitions/xs:date" } ] }, "title" : { "$id" : "#/summary/title", "title" : "Title", "$comment" : "dataElement", "description" : "The title should provide a short description of the dataset and be unique across the IPCC DDC. If your title is not unique, please add a prefix with your organisation name or identifier to differentiate it from other datasets within the IPCC DDC. Please avoid acronyms wherever possible. <br><br>Good titles should summarise the content of the dataset and if relevant, the region the dataset covers and ideally will be 80 characters or under.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_title", "allOf" : [ { "$ref" : "#/definitions/title" } ] } } }, "access" : { "$id" : "#/definitions/access", "title" : "access", "$comment" : "dataType", "enum" : [ { "Proprietary" : "" }, { "Sensitive" : "" }, { "Unpublished" : "" }, { "Unknown" : "" } ] }, "usage" : { "$id" : "#/definitions/usage", "type" : "object", "title" : "Usage", "$comment" : "dataClass", "description" : "Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets. This section includes information about how the data can be used and how it is currently being used.", "properties" : { "isReferencedBy" : { "$id" : "#/usage/isReferencedBy", "title" : "Is Referenced By", "$comment" : "dataElement", "description" : "Please provide the keystone paper associated with the dataset. Also include a list of known citations, if available, and should be links to existing resources where the dataset has been used or referenced.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_is_referenced_by", "allOf" : [ { "$ref" : "#/definitions/url" } ] }, "license" : { "$id" : "#/usage/license", "title" : "License", "$comment" : "dataElement", "description" : "Legal document under which the distribution of data is made available.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_license", "allOf" : [ { "$ref" : "#/definitions/url" } ] }, "references" : { "$id" : "#/usage/references", "title" : "References", "$comment" : "dataElement", "description" : "A related resource that is referenced, cited, or otherwise pointed to by the described resource.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_relation", "allOf" : [ { "$ref" : "#/definitions/url" } ] }, "resourceCreator" : { "$id" : "#/usage/resourceCreator", "title" : "Resource Creator", "$comment" : "dataElement", "description" : "The main researchers involved in producing the data, or the authors of the publication, in priority order. To supply multiple creators, repeat this property.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_creator", "allOf" : [ { "$ref" : "#/definitions/creator" } ] } } }, "geographicBoundingBox" : { "$id" : "#/definitions/geographicBoundingBox", "type" : "object", "title" : "Geographic Bounding Box", "$comment" : "dataClass", "description" : "The geographic bounding box describes the spatial coverage in terms of a square as specified by the longitude and latitude values of the lower left and upper right corners.\nPlease enter the four values in terms of degrees North or East, with longitudes given relative to the prime meridian (yielding values between -180E and 180E).\nNote that a \"north up\" area is described so that generally the upper right longitude will be greater than the lower left longitude.\n\nref: https://www.w3.org/TR/vocab-dcat-3/#Property:location_bbox", "properties" : { "lowerLeftLatitude" : { "$id" : "#/geographicBoundingBox/lowerLeftLatitude", "title" : "Lower Left Latitude", "$comment" : "dataElement", "description" : "The geographic bounding box describes a \"north up\" area. The lower left latitude will be smaller than the upper right latitude.\n\nsee https://opengeospatial.github.io/ogc-geosparql/geosparql11/geo.ttl#wktLiteral", "allOf" : [ { "$ref" : "#/definitions/bbox_lat" } ] }, "lowerLeftLongitude" : { "$id" : "#/geographicBoundingBox/lowerLeftLongitude", "title" : "Lower Left Longitude", "$comment" : "dataElement", "description" : "The geographic bounding box describes a \"north up\" area. Generally the lower left longitude will be smaller than the upper right longitude. However when the area crosses the 180° meridian, the value of the lower left longitude will be greater than the value of the upper right longitude.", "allOf" : [ { "$ref" : "#/definitions/bbox_long" } ] }, "upperRightLatitude" : { "$id" : "#/geographicBoundingBox/upperRightLatitude", "title" : "Upper Right Latitude", "$comment" : "dataElement", "description" : "The geographic bounding box describes a \"north up\" area. Upper right latitude will be greater than the lower left latitude.", "allOf" : [ { "$ref" : "#/definitions/bbox_lat" } ] }, "upperRightLongitude" : { "$id" : "#/geographicBoundingBox/upperRightLongitude", "title" : "Upper Right Longitude", "$comment" : "dataElement", "description" : "The geographic bounding box describes a \"north up\" area. Generally the upper right longitude will be greater than the lower left longitude. However when the area crosses the 180° meridian, the value of the lower left longitude will be greater than the value of the upper right longitude.", "allOf" : [ { "$ref" : "#/definitions/bbox_long" } ] } } }, "publisher" : { "$id" : "#/definitions/publisher", "type" : "object", "title" : "Publisher", "$comment" : "dataClass", "description" : "This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata.", "properties" : { "contactPoint" : { "$id" : "#/publisher/contactPoint", "title" : "Contact Point", "$comment" : "dataElement", "description" : "Please provide a valid email address that can be used to coordinate data enquiries with the publisher.<br><br>Organisations are expected to provide a dedicated email address associated with the data access request process for their organisation.<br><br>This will then be used as a default contact point for all datasets submitted by the organisation. However, there will be the opportunity to overwrite his value for each dataset.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point", "allOf" : [ { "$ref" : "#/definitions/email" } ] }, "description" : { "$id" : "#/publisher/description", "title" : "Description", "$comment" : "dataElement", "description" : "An HTML account of the data that provides context and scope of the data, limited to 10000 characters, and/or a resolvable URL that describes the dataset.<br><br>Additional information can be recorded and included using media.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:record_description", "allOf" : [ { "$ref" : "#/definitions/longdescription" } ] }, "identifier" : { "$id" : "#/publisher/identifier", "title" : "Identifier", "$comment" : "dataElement", "description" : "Please provide an identifier for your organisation.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier", "allOf" : [ { "$ref" : "#/definitions/url" } ] }, "logo" : { "$id" : "#/publisher/logo", "title" : "Logo", "$comment" : "dataElement", "description" : "Please provide a logo associated with the Organisation using a valid URL. The following formats will be accepted .jpg, .png or .svg.", "allOf" : [ { "$ref" : "#/definitions/url" } ] }, "name" : { "$id" : "#/publisher/name", "title" : "Name", "$comment" : "dataElement", "description" : "Please provide the name of the publisher.\n\nhttps://www.w3.org/TR/vocab-dcat-3/#Property:resource_publisher", "allOf" : [ { "$ref" : "#/definitions/shortdescription" } ] } } }, "100characters" : { "$id" : "#/definitions/100characters", "title" : "100characters", "$comment" : "dataType", "pattern" : "x ==~ /^.{5,100}$/" }, "130characters" : { "$id" : "#/definitions/130characters", "title" : "130characters", "$comment" : "dataType", "pattern" : "x ==~ /^.{2,130}$/" }, "80characters" : { "$id" : "#/definitions/80characters", "title" : "80characters", "$comment" : "dataType", "pattern" : "x ==~ /^.{2,80}$/" }, "abstract" : { "$id" : "#/definitions/abstract", "title" : "abstract", "$comment" : "dataType", "pattern" : "x ==~ /^.{5,255}$/" }, "abstracttext" : { "$id" : "#/definitions/abstracttext", "title" : "abstractText", "$comment" : "dataType", "description" : "Text with min 5 and max 255 characters.", "pattern" : "x ==~ /^.{5,255}$/" }, "accesslevel" : { "$id" : "#/definitions/accesslevel", "title" : "accessLevel", "$comment" : "dataType", "enum" : [ { "Access Level 0" : "ONS Safe Room Only" }, { "Access Level 1" : "Safe Room / SafePod Only" }, { "Access Level 2" : "Safe Room / SafePod / AOC Office" }, { "Access Level 3" : "Safe Room / SafePod / AOC Office & Remote" } ] }, "accessrequestduration" : { "$id" : "#/definitions/accessrequestduration", "title" : "accessRequestDuration", "$comment" : "dataType", "description" : "Character strings in XML.", "enum" : [ { "LESS 1 WEEK" : "Access request process typically processed in less than a week " }, { "1-2 WEEKS" : "Access request process typically processed in one to two weeks" }, { "2-4 WEEKS" : "Access request process typically processed in two to four weeks" }, { "1-2 MONTHS" : "Access request process typically processed in one to two months" }, { "2-6 MONTHS" : "Access request process typically processed in two to six months" }, { "MORE 6 MONTHS" : "Access request process typically processed in more than six months" }, { "VARIABLE" : "Access request lead time is variable" }, { "NOT APPLICABLE" : "Access request process duration is not applicable" }, { "OTHER" : "If the typical timeframe does not fit into the broad ranges i.e. lightweight application vs linked data application, please choose “Other” and indicate the typical timeframe within the description for the dataset." } ] }, "agerange" : { "$id" : "#/definitions/agerange", "title" : "ageRange", "$comment" : "dataType", "pattern" : "x ==~ /(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])/" }, "alternateid" : { "$id" : "#/definitions/alternateid", "title" : "alternateId", "$comment" : "dataType", "pattern" : "x ==~ /^.{2,180}$/" }, "availability" : { "$id" : "#/definitions/availability", "title" : "availability", "$comment" : "dataType", "enum" : [ { "Public" : "" }, { "Private" : "" } ] }, "availabilityrisk" : { "$id" : "#/definitions/availabilityrisk", "title" : "availabilityRisk", "$comment" : "dataType", "enum" : [ { "High Risk" : "if data was unavailable this would impact our ability to deliver core functions." }, { "Medium" : "unavailability would not impact core functions but could impact delivery of non-essential support services." }, { "Low risk" : "No student or staff impact, other processes could be put in place if work had to be halted, no significant risk of harm." } ] }, "bbox_lat" : { "$id" : "#/definitions/bbox_lat", "title" : "bbox_lat", "$comment" : "dataType" }, "bbox_long" : { "$id" : "#/definitions/bbox_long", "title" : "bbox_long", "$comment" : "dataType" }, "boolean" : { "$id" : "#/definitions/boolean", "title" : "boolean", "$comment" : "dataType" }, "caresetting" : { "$id" : "#/definitions/caresetting", "title" : "careSetting", "$comment" : "dataType", "enum" : [ { "Community_health" : "Community health" }, { "Dentistry" : "Dentistry" }, { "GP_/_Primary_care" : "GP / Primary care" }, { "Hospital" : "Hospital" }, { "Maternity" : "Maternity" }, { "Mental_health" : "Mental health" }, { "Pharmacy" : "Pharmacy" }, { "Social_care" : "Social care" }, { "Transport_/_Infrastructure" : "Transport / Infrastructure" }, { "Urgent_and_Emergency_Care" : "Urgent and Emergency Care" }, { "Ambulance" : "Ambulance (Urgent and Emergency Care)" }, { "Home" : "Home" }, { "Military" : "Military" }, { "Prison" : "Prison" }, { "School" : "School" }, { "Care_home" : "Care home" }, { "Walk_in_centre" : "Walk in centre" } ] }, "chars40" : { "$id" : "#/definitions/chars40", "title" : "chars40", "$comment" : "dataType", "description" : "Text with max 40 characters", "pattern" : "x ==~ /^.{1,40}$/" }, "chars80" : { "$id" : "#/definitions/chars80", "title" : "chars80", "$comment" : "dataType", "description" : "Text with min 2 and max 80 characters", "pattern" : "x ==~ /^.{2,80}$/" }, "classification" : { "$id" : "#/definitions/classification", "title" : "classification", "$comment" : "dataType", "enum" : [ { "IP and Commercially Sensitive" : "Data which has a high commercial value or requires security due to contractual requirements" }, { "Personal" : "Data that includes personal identifiers and therefore falls under the General Data Protection Regulations (GDPR)." } ] }, "collectionlevel" : { "$id" : "#/definitions/collectionlevel", "title" : "collectionLevel", "$comment" : "dataType", "description" : "List denoting Data collection level.", "enum" : [ { "aggregate" : "Aggregate level" }, { "record" : "Record level" }, { "other" : "Other" } ] }, "conditionsofaccess" : { "$id" : "#/definitions/conditionsofaccess", "title" : "conditionsOfAccess", "$comment" : "dataType", "enum" : [ { "Standard access conditions for the use of data in the SRS" : "" }, { "Access needs approval" : "" }, { "Restricted access" : "" } ] }, "conditionsofuse" : { "$id" : "#/definitions/conditionsofuse", "title" : "conditionsOfUse", "$comment" : "dataType", "enum" : [ { "Standard conditions for the use of data in the SRS" : "" }, { "Special statistical disclosure rules" : "" }, { "Publication output approval required" : "" }, { "Disclaimers required on output" : "" } ] }, "confidentialityrisk" : { "$id" : "#/definitions/confidentialityrisk", "title" : "confidentialityRisk", "$comment" : "dataType", "enum" : [ { "High risk" : "" }, { "Medium risk" : "" }, { "Low risk" : "" } ] }, "controlledvocabulary" : { "$id" : "#/definitions/controlledvocabulary", "title" : "controlledVocabulary", "$comment" : "dataType", "enum" : [ { "LOCAL" : "Local Coding Standard" }, { "AMT" : "https://www.digitalhealth.gov.au/about-the-agency/tenders-and-offers/community-pharmacy-software-industry-partnership-offer/Webinar%20-%20Australian%20Medicines%20Terminology%20(AMT)%20and%20Implementation%20Options%2001032017.pdf" }, { "APC" : "https://www.acep.org/administration/reimbursement/reimbursement-faqs/apc-ambulatory-payment-classifications-faq/" }, { "ATC" : "https://www.whocc.no/atc_ddd_index/" }, { "CIEL" : "https://github.com/OpenConceptLab/ocl_web/wiki/CIEL" }, { "CPT4" : "https://www.cms.gov/Regulations-and-Guidance/Legislation/CLIA/Downloads/SubjecttoCLIA.pdf" }, { "DM+D" : "https://digital.nhs.uk/data-and-information/information-standards/information-standards-and-data-collections-including-extractions/publications-and-notifications/standards-and-collections/scci0052-dictionary-of-medicines-and-devices-dm-d" }, { "DPD" : "https://health-products.canada.ca/dpd-bdpp/index-eng.jsp" }, { "DRG" : "http://www.euro.who.int/__data/assets/pdf_file/0004/162265/e96538.pdf" }, { "HEMONC" : "https://hemonc.org/wiki/Main_Page" }, { "HPO" : "https://hpo.jax.org/app/" }, { "ICD10" : "https://www.who.int/classifications/icd/icdonlineversions/en/" }, { "ICD10CM" : "https://www.cdc.gov/nchs/icd/icd10cm.htm" }, { "ICD10PCS" : "https://ec.europa.eu/eip/ageing/standards/healthcare/e-health/icd-10-pcs_en" }, { "ICD9" : "https://www.cdc.gov/nchs/icd/icd9.htm" }, { "ICD9CM" : "https://www.cdc.gov/nchs/icd/icd9cm.htm" }, { "ICDO3" : "https://www.who.int/classifications/icd/adaptations/oncology/en/" }, { "ICPC-2" : "https://www.who.int/standards/classifications/other-classifications/international-classification-of-primary-care" }, { "ICPC-3" : "https://www.icpc-3.info/" }, { "JMDC" : "https://www.jmdc.co.jp/en/" }, { "KCD7" : "https://forums.ohdsi.org/t/adding-kcd7-code-korean-icd-10-to-the-omop-vocabulary/7576" }, { "LOINC" : "https://loinc.org/" }, { "MULTUM" : "https://www.cerner.com/solutions/drug-database" }, { "NAACCR" : "https://www.naaccr.org/" }, { "NDC" : "https://www.fda.gov/drugs/drug-approvals-and-databases/national-drug-code-directory" }, { "NDFRT" : "https://www.nlm.nih.gov/research/umls/sourcereleasedocs/current/NDFRT/index.html" }, { "NHS NATIONAL CODES" : "https://www.datadictionary.nhs.uk/" }, { "NHS SCOTLAND NATIONAL CODES" : "https://www.ndc.scot.nhs.uk/Data-Dictionary/" }, { "NHS WALES NATIONAL CODES" : "http://www.datadictionary.wales.nhs.uk/" }, { "ODS" : "https://digital.nhs.uk/services/organisation-data-service" }, { "OPCS4" : "https://www.datadictionary.nhs.uk/web_site_content/supporting_information/clinical_coding/opcs_classification_of_interventions_and_procedures.asp" }, { "OXMIS" : "https://oxrisk.com/oxmis/" }, { "READ" : "https://digital.nhs.uk/services/terminology-and-classifications/read-codes" }, { "RXNORM" : "https://www.nlm.nih.gov/research/umls/rxnorm/index.html" }, { "RXNORM EXTENSION" : "https://www.nlm.nih.gov/research/umls/rxnorm/index.html" }, { "SNOMED CT" : "http://www.snomed.org/" }, { "SNOMED RT" : "https://confluence.ihtsdotools.org/display/DOCGLOSS/SNOMED+RT" }, { "SPL" : "https://www.fda.gov/industry/fda-resources-data-standards/structured-product-labeling-resources" }, { "OTHER" : "Please indicate if there is another standard that you are using." } ] }, "cqcservicetype" : { "$id" : "#/definitions/cqcservicetype", "title" : "cqcServiceType", "$comment" : "dataType", "enum" : [ { "ACS" : "Healthcare services : Acute services" }, { "HBC" : "Healthcare services : Hyperbaric chamber services" }, { "HPS" : "Healthcare services : Hospice services" }, { "LTC" : "Healthcare services : Long-term conditions services" }, { "MLS" : "Healthcare services : Hospital services for people with mental health needs, and/or learning disabilities, and/or problems with substance misuse" }, { "PHS" : "Healthcare services : Prison healthcare services" }, { "RHS" : "Healthcare services : Rehabilitation services" }, { "RSM" : "Healthcare services : Residential substance misuse treatment/ rehabilitation services" }, { "CHC" : "Community or integrated healthcare : Community healthcare services" }, { "DCS" : "Community or integrated healthcare : Doctors consultation services" }, { "DTS" : "Community or integrated healthcare : Doctors treatment services" }, { "DEN" : "Community or integrated healthcare : Dental services" }, { "DSS" : "Community or integrated healthcare : Diagnostic and/or screening services" }, { "LDC" : "Community or integrated healthcare : Community-based services for people with a learning disability" }, { "MBS" : "Community or integrated healthcare : Mobile doctors services" }, { "MHC" : "Community or integrated healthcare : Community-based services for people with mental health needs" }, { "SMC" : "Community or integrated healthcare : Community-based services for people who misuse substances" }, { "UCS" : "Community or integrated healthcare : Urgent care services" }, { "CHN" : "Residential social care : Care home services with nursing" }, { "CHS" : "Residential social care : Care home services without nursing" }, { "SPC" : "Residential social care : Specialist college services" }, { "DCC" : "Community social care : Domiciliary care services including those provided for children" }, { "EXC" : "Community social care : Extra care housing services" }, { "SHL" : "Community social care : Shared Lives (formerly known as Adult Placement)" }, { "SLS" : "Community social care : Supported living services" }, { "AMB" : "Miscellaneous healthcare : Ambulance services" } ] }, "creator" : { "$id" : "#/definitions/creator", "title" : "creator", "$comment" : "dataType", "pattern" : "x ==~ /^.{2,1000}$/" }, "dataType1" : { "$id" : "#/definitions/dataType1", "title" : "Data Type1", "$comment" : "dataType" }, "dataType2" : { "$id" : "#/definitions/dataType2", "title" : "Data Type2", "$comment" : "dataType" }, "dataType3" : { "$id" : "#/definitions/dataType3", "title" : "Data Type3", "$comment" : "dataType" }, "datalocation" : { "$id" : "#/definitions/datalocation", "title" : "dataLocation", "$comment" : "dataType", "enum" : [ { "physical" : "Physical" }, { "electronic" : "Electronic" } ] }, "datastatus" : { "$id" : "#/definitions/datastatus", "title" : "dataStatus", "$comment" : "dataType" }, "datatype" : { "$id" : "#/definitions/datatype", "title" : "dataType", "$comment" : "dataType", "enum" : [ { "IPE" : "Implementation and Process Evaluation" }, { "RCT" : "Randomised Control Trial" }, { "QED" : "Quasi-Experimental Design" }, { "OTH" : "Other" } ] }, "datauselimitation" : { "$id" : "#/definitions/datauselimitation", "title" : "dataUseLimitation", "$comment" : "dataType", "description" : "Term information (see https://www.ebi.ac.uk/ols/ontologies/duo/terms?iri=http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000001)\nDUO preferred label\ndata use limitation\n\nalternative term\nconsent code\n\ndefinition\nA data item that is used to indicate consent permissions for datasets and/or materials, and relates to the purposes for which datasets and/or material might be removed, stored or used.\n\nid\nDUO:0000001", "enum" : [ { "GENERAL RESEARCH USE" : "This data use limitation indicates that use is allowed for general research use for any research purpose" }, { "GENETIC STUDIES ONLY" : "This data use limitation indicates that use is limited to genetic studies only (i.e., no phenotype-only research)" }, { "NO GENERAL METHODS RESEARCH" : "This data use limitation indicates that use includes methods development research(e.g., development of software or algorithms) only within the bounds of other use limitations." }, { "NO LINKAGE" : "This data use limitation indicates there is a restriction on linking to any other datasets" }, { "NO RESTRICTION" : "This data use limitation indicates there is no restriction on use." }, { "RESEARCH SPECIFIC RESTRICTIONS" : "This data use limitation indicates that use is limited to studies of a certain research type." }, { "RESEARCH USE ONLY" : "This data use limitation indicates that use is limited to research purposes (e.g., does not include its use in clinical care)." } ] }, "datauselimitations" : { "$id" : "#/definitions/datauselimitations", "title" : "dataUseLimitations", "$comment" : "dataType", "enum" : [ { "COMMERCIAL RESEARCH USE" : "This data use limitation indicates that use is allowed for general research use for any commercial research purposes" }, { "GENERAL RESEARCH USE" : "This data use limitation indicates that use is allowed for general research use for any research purpose" }, { "GENETIC STUDIES ONLY" : "This data use limitation indicates that use is limited to genetic studies only (i.e., no phenotype-only research)" }, { "GEOGRAPHICAL RESTRICTIONS" : "This requirement indicates that use is limited to within a specific geographic region." }, { "INSTITUTION SPECIFIC RESTRICTIONS" : "This requirement indicates that use is limited to use within an approved institution." }, { "NO GENERAL METHODS RESEARCH" : "This data use limitation indicates that use includes methods development research(e.g., development of software or algorithms) only within the bounds of other use limitations." }, { "NO LINKAGE" : "This data use limitation indicates there is a restriction on linking to any other datasets" }, { "NO RESTRICTION" : "This data use limitation indicates there is no restriction on use." }, { "NOT FOR PROFIT USE" : "This requirement indicates that use of the data is limited to not-for-profit use, non-commercial use." }, { "PROJECT SPECIFIC RESTRICTIONS" : "This requirement indicates that use is limited to use by approved projects." }, { "RESEARCH SPECIFIC RESTRICTIONS" : "This data use limitation indicates that use is limited to studies of a certain research type." }, { "RESEARCH USE ONLY" : "This data use limitation indicates that use is limited to research purposes (e.g., does not include its use in clinical care)." }, { "USER SPECIFIC RESTRICTION" : "This requirement indicates that use is limited to use by approved users." } ] }, "datauserequirements" : { "$id" : "#/definitions/datauserequirements", "title" : "dataUseRequirements", "$comment" : "dataType", "enum" : [ { "COLLABORATION REQUIRED" : "This requirement indicates that the requestor must agree to collaboration with the primary study investigator(s)." }, { "DISCLOSURE CONTROL" : "This requirement indicates that use must be disclosed in accordance with the data custodians policy" }, { "ETHICS APPROVAL REQUIRED" : "This requirement indicates that the requestor must provide documentation of local IRB/ERB approval." }, { "PUBLICATION MORATORIUM" : "This requirement indicates that requestor agrees not to publish results of studies until a specific date" }, { "PUBLICATION REQUIRED" : "This requirement indicates that requestor agrees to make results of studies using the data available to the larger scientific community." }, { "RETURN TO DATABASE OR RESOURCE" : "This requirement indicates that the requestor must return derived/enriched data to the database/resource." }, { "TIME LIMIT ON USE" : "This requirement indicates that use is approved for a specific number of months." }, { "NO REQUIREMENTS" : "No additional data use requirements." } ] }, "datavolume" : { "$id" : "#/definitions/datavolume", "title" : "dataVolume", "$comment" : "dataType", "description" : "TODO", "pattern" : "// value is number of \nx ==~ /\\d+(\\.\\d+)?/" }, "data_storage_type" : { "$id" : "#/definitions/data_storage_type", "title" : "data_storage_type", "$comment" : "dataType", "enum" : [ { "Observations" : "" }, { "Model Output" : "" } ] }, "date" : { "$id" : "#/definitions/date", "title" : "date", "$comment" : "dataType" }, "description" : { "$id" : "#/definitions/description", "title" : "description", "$comment" : "dataType", "description" : "//Regular expression to validate min, max character limit : min 2, max 3000", "pattern" : "x ==~ /^.{2,3000}$/" }, "descriptiontext" : { "$id" : "#/definitions/descriptiontext", "title" : "descriptionText", "$comment" : "dataType", "description" : "Text with min 2 and max 3000 characters", "pattern" : "x ==~ /^.{2,3000}$/" }, "documentationType" : { "$id" : "#/definitions/documentationType", "title" : "Documentation Type", "$comment" : "dataType", "enum" : [ { "Custom document" : "" }, { "More information" : "" }, { "ISN" : "" }, { "Requirement specification" : "" }, { "Implementation guidance" : "" } ] }, "doi" : { "$id" : "#/definitions/doi", "title" : "doi", "$comment" : "dataType" }, "email" : { "$id" : "#/definitions/email", "title" : "email", "$comment" : "dataType", "pattern" : "x ==~ /[^\\s]+@[^\\s]+\\.[^\\s]+/" }, "emailorurl" : { "$id" : "#/definitions/emailorurl", "title" : "emailOrUrl", "$comment" : "dataType", "description" : "The entry can be either an email or a URL.", "pattern" : "x ==~ /((([A-Za-z]{3,9}:(?:\\/\\/)?)(?:[\\-;\\:&=\\+\\$,\\w.]+@)?[A-Za-z0-9.\\-]+|(?:www.|[\\-;\\:&=\\+\\$,\\w.]+@)[A-Za-z0-9.\\-]+)((?:\\/[\\+~%\\/.\\w\\-_]*)?\\??(?:[\\-\\+=&;%@.\\w_]*)#?(?:[.!\\/\\\\w]*))?)/" }, "estimateddatasetsize" : { "$id" : "#/definitions/estimateddatasetsize", "title" : "estimatedDatasetSize", "$comment" : "dataType", "enum" : [ { "<25 MB" : "" }, { "25MB-10GB" : "" }, { "10GB-500GB" : "" }, { "500GB - 1TB" : "" }, { "1-5TB" : "" }, { ">5TB" : "" } ] }, "followup" : { "$id" : "#/definitions/followup", "title" : "followup", "$comment" : "dataType", "enum" : [ { "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" }, { "UNKNOWN" : "Timespan is Unknown" }, { "OTHER" : "Data available for a patient over another time period" } ] }, "format" : { "$id" : "#/definitions/format", "title" : "format", "$comment" : "dataType", "description" : "// see https://www.iana.org/assignments/media-types/media-types.xhtml" }, "frequency" : { "$id" : "#/definitions/frequency", "title" : "frequency", "$comment" : "dataType", "description" : "List of frequencies for a Data collection or extraction.", "enum" : [ { "annual" : "Dataset publication or collection occurs once a year." }, { "biannual" : "Dataset publication or collection occurs twice a year." }, { "biennial" : "Dataset publication or collection occurs every two years." }, { "bimonthly" : "Dataset publication or collection occurs every two months." }, { "biweekly" : "Dataset publication or collection occurs every two weeks." }, { "continuous" : "Dataset publication or collection occurs without interruption." }, { "daily" : "Dataset publication or collection occurs once a day." }, { "irregular" : "Dataset publication or collection occurs at uneven intervals." }, { "monthly" : "Dataset publication or collection occurs once a month." }, { "other" : "Dataset publication or collection occurs at other interval." }, { "quarterly" : "Dataset publication or collection occurs every three months." }, { "semiweekly" : "Dataset publication or collection occurs twice a week." }, { "static" : "Dataset publication or collection occurs once." }, { "weekly" : "Dataset publication or collection occurs once a week." } ] }, "geographiclevels" : { "$id" : "#/definitions/geographiclevels", "title" : "geographicLevels", "$comment" : "dataType" }, "integrityrisk" : { "$id" : "#/definitions/integrityrisk", "title" : "integrityRisk", "$comment" : "dataType", "enum" : [ { "High Risk" : "Accuracy and completeness of data must be maintained to meet statutory/contractual obligations." }, { "Medium" : "Some delay in updating the information would not cause significant issues." }, { "Low risk" : "Data that is historical in nature and does not require regular updating." } ] }, "isocountrycode" : { "$id" : "#/definitions/isocountrycode", "title" : "IsoCountryCode", "$comment" : "dataType" }, "ispartof" : { "$id" : "#/definitions/ispartof", "title" : "isPartOf", "$comment" : "dataType", "description" : "any of:\n* url\n* chars80\n* fixed text \"NOT APPLICABLE\"" }, "isreferencedby" : { "$id" : "#/definitions/isreferencedby", "title" : "isReferencedBy", "$comment" : "dataType", "description" : "any of:\n* doi\n* chars80", "pattern" : "x ==~ /^.{2,80}$/" }, "is_archived" : { "$id" : "#/definitions/is_archived", "title" : "is_archived", "$comment" : "dataType", "enum" : [ { "Yes" : "" }, { "No" : "" } ] }, "is_derived" : { "$id" : "#/definitions/is_derived", "title" : "is_derived", "$comment" : "dataType", "enum" : [ { "Yes" : "" }, { "No" : "" } ] }, "keystage" : { "$id" : "#/definitions/keystage", "title" : "keyStage", "$comment" : "dataType", "enum" : [ { "EY" : "Early Years" }, { "1" : "Key Stage 1" }, { "2" : "Key Stage 2" }, { "3" : "Key Stage 3" }, { "4" : "Key Stage 4" }, { "5" : "Key Stage 5" }, { "NA" : "Not applicable" } ] }, "language" : { "$id" : "#/definitions/language", "title" : "language", "$comment" : "dataType" }, "legalauthority" : { "$id" : "#/definitions/legalauthority", "title" : "legalAuthority", "$comment" : "dataType", "enum" : [ { "section_250" : "Section 250 of the Health and Social Care Act 2012" }, { "section_259" : "Section 259 of the Health and Social Care Act 2012" }, { "nhs_standard_contract" : "NHS standard contract" }, { "social_care_assured_suppliers" : "Social care assured suppliers" }, { "other" : "Other legal basis" } ] }, "linkeddatasets" : { "$id" : "#/definitions/linkeddatasets", "title" : "linkedDatasets", "$comment" : "dataType", "pattern" : "x ==~ /((([A-Za-z]{3,9}:(?:\\/\\/)?)(?:[\\-;:&=\\+\\$,\\w]+@)?[A-Za-z0-9.\\-]+(:[0-9]+)?|(?:www.|[\\-;:&=\\+\\$,\\w]+@)[A-Za-z0-9.\\-]+)((?:\\/[\\+~%\\/.\\w_\\-]*)?\\??(?:[\\-\\+=&;%@.\\w_]*)#?(?:[\\w]*))?)|ALL|NA/" }, "longdescription" : { "$id" : "#/definitions/longdescription", "title" : "longDescription", "$comment" : "dataType", "pattern" : "x ==~ /.{2,10000}/" }, "markdown" : { "$id" : "#/definitions/markdown", "title" : "Markdown", "$comment" : "dataType", "description" : "A text markup format that is usually translated to HTML for web pages. More details here: https://daringfireball.net/projects/markdown/" }, "membership" : { "$id" : "#/definitions/membership", "title" : "membership", "$comment" : "dataType", "description" : "Character strings in XML.", "enum" : [ { "ALLIANCE" : "https://ukhealthdata.org/" }, { "HUB" : "https://www.hdruk.ac.uk/infrastructure/the-hubs/" }, { "NCS" : "https://www.hdruk.ac.uk/covid-19/covid-19-national-core-studies/" }, { "OTHER" : "Other organisation affiliated with HDR UK" } ] }, "money" : { "$id" : "#/definitions/money", "title" : "money", "$comment" : "dataType", "description" : "Monetary amount.", "pattern" : "// value is an amount in £ sterling with no pence e.g. £1234.\nx ==~ /\\£\\d+$/" }, "mustshouldcould" : { "$id" : "#/definitions/mustshouldcould", "title" : "MustShouldCould", "$comment" : "dataType", "enum" : [ { "Must" : "" }, { "Should" : "" }, { "Could" : "" } ] }, "namedlink" : { "$id" : "#/definitions/namedlink", "title" : "namedLink", "$comment" : "dataType" }, "number" : { "$id" : "#/definitions/number", "title" : "Number", "$comment" : "dataType" }, "periodicity" : { "$id" : "#/definitions/periodicity", "title" : "periodicity", "$comment" : "dataType", "description" : "Character strings in XML.", "enum" : [ { "STATIC" : "Dataset published once." }, { "IRREGULAR" : "Dataset published at uneven intervals." }, { "CONTINUOUS" : "Dataset published without interruption." }, { "BIENNIAL" : "Dataset published every two years." }, { "ANNUAL" : "Dataset published occurs once a year." }, { "BIANNUAL" : "Dataset published twice a year" }, { "QUARTERLY" : "Dataset published every three months." }, { "BIMONTHLY" : "Dataset published every two months." }, { "MONTHLY" : "Dataset published once a month." }, { "BIWEEKLY" : "Dataset published every two weeks." }, { "WEEKLY" : "Dataset published once a week." }, { "SEMIWEEKLY" : "Dataset published twice a week." }, { "DAILY" : "Dataset published once a day." }, { "OTHER" : "Dataset published using other interval" } ] }, "phenotypicsex" : { "$id" : "#/definitions/phenotypicsex", "title" : "phenotypicSex", "$comment" : "dataType", "enum" : [ { "1" : "Male" }, { "2" : "Female" } ] }, "physicalsampleavailability" : { "$id" : "#/definitions/physicalsampleavailability", "title" : "physicalsampleAvailability", "$comment" : "dataType", "description" : "Character strings in XML.", "enum" : [ { "AVAILABILITY TO BE CONFIRMED" : "Availability of samples is currently being confirmed" }, { "BONE MARROW" : "Bone marrow samples associated with the data are available" }, { "CANCER CELL LINES" : "Cancer cell line samples associated with the data are available" }, { "CDNA/MRNA" : "CDNA/MRNA samples associated with the data are available" }, { "CORE BIOPSY" : "Core biopsy samples associated with the data are available" }, { "DNA" : "DNA samples associated with the data are available" }, { "FAECES" : "Faeces samples associated with the data are available" }, { "IMMORTALIZED CELL LINES" : "Immortalized cell line samples associated with the data are available" }, { "MICRORNA" : "MicroRNA samples associated with the data are available " }, { "NOT AVAILABLE" : "Samples associated with the dataset are not available" }, { "PERIPHERAL BLOOD CELLS" : "Peripheral blood cell samples associated with the data are available" }, { "PLASMA" : "Plasma samples associated with the data are available" }, { "PM TISSUE" : "PM Tissue samples associated with the data are available" }, { "PRIMARY CELLS" : "Primary cell samples associated with the data are available" }, { "RNA" : "RNA samples associated with the data are available" }, { "SALIVA" : "Saliva samples associated with the data are available" }, { "SERUM" : "Serum samples associated with the data are available" }, { "SWABS" : "Swab samples associated with the data are available" }, { "TISSUE" : "Tissue samples associated with the data are available" }, { "URINE" : "Urine samples associated with the data are available" }, { "WHOLE BLOOD" : "Whole blood samples associated with the data are available" }, { "OTHER" : "Other types of samples available" } ] }, "platform" : { "$id" : "#/definitions/platform", "title" : "platform", "$comment" : "dataType", "description" : "List of platforms.", "enum" : [ { "cap" : "Clinical Audit Platform (CAP)" }, { "gpes" : "General Practice Extraction Service (GPES)" }, { "cqrs" : "Calculating Quality Reporting Service (CQRS)" }, { "dcf" : "Data Collection Framework online platform (DCF)" }, { "dlp" : "Data Landing Platform (DLP)" }, { "gpitss" : "General Practice IT System Suppliers" }, { "nhseefm" : "NHS England Estates and Facilities Management" }, { "phe" : "Public Health England (PHE)" }, { "fdp" : "Federated Data Platform (FDP)" } ] }, "provenanceorigin" : { "$id" : "#/definitions/provenanceorigin", "title" : "provenanceOrigin", "$comment" : "dataType", "pattern" : "x ==~ /^.{2,3000}$/" }, "public_access" : { "$id" : "#/definitions/public_access", "title" : "public_access", "$comment" : "dataType", "enum" : [ { "URL" : "" }, { "File Transfer (FTP)" : "" }, { "Other" : "" } ] }, "publishing_status" : { "$id" : "#/definitions/publishing_status", "title" : "publishing_status", "$comment" : "dataType", "enum" : [ { "Complete" : "" }, { "Ongoing" : "" }, { "Planned" : "" }, { "Under Development" : "" }, { "Deprecated" : "" } ] }, "purpose" : { "$id" : "#/definitions/purpose", "title" : "purpose", "$comment" : "dataType" }, "registration_status" : { "$id" : "#/definitions/registration_status", "title" : "registration_status", "$comment" : "dataType", "enum" : [ { "ISO-incomplete" : "An Administered Item with the “Incomplete” status shall indicate that the Submitter? wishes to make the community that uses this metadata register aware of the existence of an? Administered Item in their local domain." }, { "ISO-candidate" : "An Administered Item with the “Candidate” status shall indicate that it has been? proposed for progression through the registration levels." }, { "ISO-recorded" : "An Administered Item with the “Recorded” status shall mean that all mandatory metadata attributes have been completed, and all associated constraints are to be enforced." }, { "ISO-qualified" : "An Administered Item with the “Qualified” status shall mean that the Administration Item had a “Recorded” registration status and the Registration Authority has confirmed that the mandatory metadata attributes are complete and conform to applicable quality requirements" }, { "ISO-standard" : "An Administered Item with the “Standard” status indicates that the Administration Item had a “Qualified” registration status and the Registration Authority confirms that the Administered Item is of sufficient quality and of broad interest for use in the community that uses this metadata register." }, { "ISO-preferred standard" : "An Administered Item with the “Preferred Standard” status means that the Registration Authority confirms that the Administered Item is preferred for use in the community that uses this metadata register." }, { "ISO-retired" : "An Administered Item with the “Retired” status indicates that the Registration Authority has determined the Administered Item is no longer recommended for use in the community that uses this metadata register" }, { "ISO-superseded" : "n Administered Item with the “Superseded” status indicates that the Registration Authority has determined the Administered Item is no longer recommended for use in the community that uses this metadata register. A “Superseded” Administered Item may be used but the successor Administered Item is the preferred for use. Such Administered Items are retained in the metadata register archival storage facility for historic reference purposes. “Superseded” Administered Items should include a reference to replacement Administered Items when appropriate." }, { "ISO-historical" : "An Administered Item with the “Historical” status shall indicate that the Submitter wishes to make the community that uses this metadata register aware of the existence of an item that was used in the past and has not been used recently" }, { "ISO-application" : "An Administered Item with the “Application” status shall mean that the Registration Authority wishes to make the community that uses this metadata register aware of the existence of an Administered Item in their local domain that is used by an application system. This item may be very well described" }, { "DSAS-Initial (approval) In development" : "" }, { "DSAS-Final (approval) In development" : "" }, { "DSAS-Withdrawn/Closed" : "" }, { "DSAS-Implementation Live/In progress" : "" }, { "DSAS-Maintenance Live/In progress" : "" }, { "DSAS-Review Live/In progress" : "" }, { "DSAS-Deprecate" : "" }, { "DSAS-Retire" : "" }, { "HL7-Normative" : "This content was approved by the ANSI standards process icon in a previous version (see Normative status note). It has been subject to review and production implementation in a wide variety of environments. The content is considered to be stable and has been 'locked', subjecting it to FHIR Inter-version Compatibility Rules. While changes are possible, they are expected to be infrequent and are tightly constrained." }, { "HL7-Trial use" : "This content has been well reviewed and is considered by the authors to be ready for use in production systems. It has been subjected to ballot and approved as an official standard. However, it has not yet seen widespread use in production across the full spectrum of environments it is intended to be used in. In some cases, there may be documented known issues that require implementation experience to determine appropriate resolutions for. Future versions of FHIR may make significant changes to Trial Use content that are not compatible with previously published content." }, { "HL7-Draft" : "This portion of the specification is not considered to be complete enough or sufficiently reviewed to be safe for implementation. It may have known issues or still be in the \"\"in development\"\" stage. It is included in the publication as a place-holder, to solicit feedback from the implementation community and/or to give implementers some insight as to functionality likely to be included in future versions of the specification. Content at this level should only be implemented by the brave or desperate and is very much \"\"use at your own risk\"\". The content that is Draft that will usually be elevated to Trial Use once review and correction is complete after it has been subjected to ballot. Some resources with a standards status of 'draft' have an FMM level of 1 or 2 - this means that the committee responsible for them is ready for them to be tested and balloting, but that balloting has not yet occurred. Draft resources cannot have a FMM level greater than 2." }, { "HL7-Informative" : "This portion of the specification is provided for implementer assistance and does not make rules that implementers are required to follow. Typical examples of this content in the FHIR specification are tables of contents, registries, examples, and implementer advice" }, { "HL7-Deprecated" : "This portion of the specification is outdated and may be withdrawn in a future version. Implementers who already support it should continue to do so for backward compatibility. Implementers should avoid adding new uses of this portion of the specification. The specification should include guidance on what implementers should use instead of the deprecated portion" } ] }, "releaseDate" : { "$id" : "#/definitions/releaseDate", "title" : "Release date", "$comment" : "dataType" }, "reviewoutcome" : { "$id" : "#/definitions/reviewoutcome", "title" : "reviewOutcome", "$comment" : "dataType", "enum" : [ { "approve" : "Approve" }, { "reject" : "Reject" }, { "revise" : "Revise" } ] }, "roleType" : { "$id" : "#/definitions/roleType", "title" : "Role Type", "$comment" : "dataType", "description" : "A role type of the concept, link or resource being referred to. For example adopter, user etc.. This can also support type of the resource such as Training, or example", "enum" : [ { "Example" : "Role of a resource" }, { "Developer" : "Role of a body such as an organisation" }, { "Contributor" : "Role of a body such as an organisation" }, { "Adopter" : "Role of a body such as an organisation" }, { "Pilot member" : "Role of a body such as an organisation" }, { "Reviewer" : "Role of a body such as an organisation" }, { "Advisor" : "Role of a body such as an organisation" }, { "Consulted" : "Role of a body such as an organisation" }, { "User" : "Role of a body such as an organisation" }, { "Supplier" : "Role of a body such as an organisation" }, { "Customer" : "Role of a body such as an organisation" }, { "Stakeholder" : "Role of a body such as an organisation" }, { "Member" : "Role of a body such as an organisation" }, { "Case study" : "Role of a resource" }, { "Learning" : "Role of a resource" }, { "Documentation" : "Role of a resource" }, { "Data" : "Role of a resource" }, { "Information" : "Role of a resource" }, { "Knowledge" : "Role of a resource" } ] }, "schoolphase" : { "$id" : "#/definitions/schoolphase", "title" : "schoolPhase", "$comment" : "dataType", "enum" : [ { "EY" : "Early Years" }, { "PR" : "Primary" }, { "SC" : "Secondary" }, { "P16" : "Post-16" } ] }, "semver" : { "$id" : "#/definitions/semver", "title" : "semver", "$comment" : "dataType", "description" : "A representation of semver used to describe a version.", "pattern" : "// value is semver e.g. 1.1.0\nx ==~ /(?<major>\\d+).(?<minor>\\d+).(?<revision>\\d+)-(?<build>\\d+)/" }, "setting" : { "$id" : "#/definitions/setting", "title" : "setting", "$comment" : "dataType", "description" : "Character strings in XML.", "enum" : [ { "ACCIDENT AND EMERGENCY" : "Accident emergency department " }, { "CLINIC" : "Specific clinic such as antenatal clinic" }, { "COMMUNITY" : "Community settings" }, { "HOME" : "Home setting" }, { "IN-PATIENTS" : "In-patient care" }, { "OUTPATIENTS" : "Outpatient care" }, { "PHARMACY" : "Pharmacy" }, { "PRIMARY CARE" : "General Medical Practitioner Practice" }, { "PRIVATE" : "Private Medical Clinic" }, { "SERVICES" : "Services such as drug misuse or blood transfusion" }, { "OTHER" : "Other Setting" } ] }, "shortabstracttext" : { "$id" : "#/definitions/shortabstracttext", "title" : "shortAbstractText", "$comment" : "dataType", "description" : "//Regular expression (regex) to validate and constrain title between 3 and 255 characters", "pattern" : "x ==~ /^.{3,255}$/" }, "shortdescription" : { "$id" : "#/definitions/shortdescription", "title" : "shortDescription", "$comment" : "dataType", "pattern" : "x ==~ /^.{2,80}$/" }, "short_description" : { "$id" : "#/definitions/short_description", "title" : "short_description", "$comment" : "dataType", "pattern" : "x ==~ /^.{2,80}$/" }, "source" : { "$id" : "#/definitions/source", "title" : "source", "$comment" : "dataType" }, "spatial-point" : { "$id" : "#/definitions/spatial-point", "title" : "spatial-point", "$comment" : "dataType", "pattern" : "x = /^-?[0-9]{0,3}[.]?[0-9]+$/" }, "spatialcoverage" : { "$id" : "#/definitions/spatialcoverage", "title" : "spatialCoverage", "$comment" : "dataType" }, "srssafesetting" : { "$id" : "#/definitions/srssafesetting", "title" : "srsSafeSetting", "$comment" : "dataType", "enum" : [ { "Safe Rooms, SafePods" : "Access through ONS Safe Rooms, SafePods" }, { "Assured Organisational Connectivity – office based" : "Access through Assured Organisational Connection" }, { "Assured Organisational Connectivity – remote access" : "Access through temporary Assured Organisational Connection via remote access" }, { "Safe Rooms" : "Access through Safe Rooms only" } ] }, "stage" : { "$id" : "#/definitions/stage", "title" : "stage", "$comment" : "dataType", "enum" : [ { "draft" : "Draft resource prepared for general feedback before testing phase" }, { "alpha" : "Resource prepared to identify and test assumptions during alpha" }, { "beta" : "Resource prepared to test implementation and integration in beta" }, { "implementation" : "Resource prepared for final release and implementation" }, { "maintenance" : "Maintenance resource prepared to iterate and improve" }, { "deprecated" : "Deprecated resources are no longer recommended for use, such as historical versions" }, { "retired" : "Retired resources should not be used and are no longer supported. They are only available for archival purposes only." } ] }, "standardiseddatamodels" : { "$id" : "#/definitions/standardiseddatamodels", "title" : "standardisedDataModels", "$comment" : "dataType", "enum" : [ { "LOCAL" : "In-house developed data model" }, { "CDISC" : "https://www.cdisc.org/standards/data-exchange/odm" }, { "DICOM" : "https://www.dicomstandard.org/" }, { "HL7 CCOW" : "https://www.hl7.org/implement/standards/product_section.cfm?section=16" }, { "HL7 CDA" : "https://www.hl7.org/implement/standards/product_section.cfm?section=10" }, { "HL7 FHIR" : "https://www.hl7.org/fhir/" }, { "HL7 V2" : "https://www.hl7.org/implement/standards/product_section.cfm?section=13" }, { "I2B2" : "https://www.i2b2.org/" }, { "IHE" : "https://www.ihe.net/resources/profiles/" }, { "NHS DATA DICTIONARY" : "https://www.datadictionary.nhs.uk/" }, { "NHS SCOTLAND DATA DICTIONARY" : "https://www.ndc.scot.nhs.uk/Data-Dictionary/" }, { "NHS WALES DATA DICTIONARY" : "http://www.datadictiona" }, { "OMOP" : "https://www.ohdsi.org/data-standardization/the-common-data-model/" }, { "OPENEHR" : "https://www.openehr.org/" }, { "PCORNET" : "https://pcornet.org/data-driven-common-model/" }, { "SENTINEL" : "https://www.sentinelinitiative.org/sentinel/data/distributed-database-common-data-model" }, { "OTHER" : "Other standardised data model" } ] }, "standardtype" : { "$id" : "#/definitions/standardtype", "title" : "standardType", "$comment" : "dataType", "enum" : [ { "record_standards" : "record standards" }, { "data_definitions_and_terminologies" : "data definitions and terminologies" }, { "technical_standards_and_specifications" : "technical standards and specifications." }, { "information_codes_of_practice" : "information codes of practice" } ] }, "status" : { "$id" : "#/definitions/status", "title" : "status", "$comment" : "dataType", "enum" : [ { "proposed" : "proposed" }, { "draft_in_progress" : "draft standard in progress" }, { "awaiting_approval" : "awaiting approval" }, { "on_hold" : "on hold" }, { "cancelled" : "cancelled" }, { "in_development" : "in development" }, { "active" : "active" }, { "deprecated" : "deprecated" }, { "retired" : "retired" } ] }, "string" : { "$id" : "#/definitions/string", "title" : "String", "$comment" : "dataType" }, "style" : { "$id" : "#/definitions/style", "title" : "Style", "$comment" : "dataType", "description" : "NHS Design system styles", "enum" : [ { "text" : "" }, { "expander" : "" }, { "detail" : "" }, { "do" : "" }, { "dont" : "" }, { "warning" : "" }, { "care card" : "" }, { "data" : "" } ] }, "temporalfrequency" : { "$id" : "#/definitions/temporalfrequency", "title" : "temporalFrequency", "$comment" : "dataType" }, "temporalresolution" : { "$id" : "#/definitions/temporalresolution", "title" : "temporalResolution", "$comment" : "dataType" }, "text" : { "$id" : "#/definitions/text", "title" : "text", "$comment" : "dataType" }, "timelag" : { "$id" : "#/definitions/timelag", "title" : "timeLag", "$comment" : "dataType", "description" : "The typical time lag between an event and the data for that event appearing in the dataset", "enum" : [ { "NO TIMELAG" : "No time lag" }, { "LESS 1 WEEK" : "Typical time lag of less than a week" }, { "1-2 WEEKS" : "Typical time lag of one to two weeks" }, { "2-4 WEEKS" : "Typical time lag of two to four weeks" }, { "1-2 MONTHS" : "Typical time lag of one to two months" }, { "2-6 MONTHS" : "Typical time lag of two to six months" }, { "6 MONTHS PLUS" : "Typical time lag of more than six months" }, { "VARIABLE" : "Variable time lag" }, { "NOT APPLICABLE" : "Not Applicable i.e. static dataset" }, { "OTHER" : "Other time lag" } ] }, "title" : { "$id" : "#/definitions/title", "title" : "title", "$comment" : "dataType", "pattern" : "x ==~ /^.{2,180}$/" }, "topic" : { "$id" : "#/definitions/topic", "title" : "topic", "$comment" : "dataType", "enum" : [ { "Access_to_records" : "Access to records" }, { "Appointment_/_scheduling" : "Appointment / scheduling" }, { "Artificial_intelligence" : "Artificial intelligence" }, { "Clinical_decision_support" : "Clinical decision support" }, { "Continuity_of_care" : "Continuity of care" }, { "Cyber_security" : "Cyber security" }, { "Demographics" : "Demographics" }, { "Dispensing" : "Dispensing" }, { "Information_governance" : "Information governance" }, { "Key_care_information" : "Key care information" }, { "Messaging" : "Messaging" }, { "Patient_communication" : "Patient communication" }, { "Prescribing" : "Prescribing" }, { "Reference_data" : "Reference data" }, { "Referrals" : "Referrals" }, { "Security" : "Security" }, { "Tests_and_diagnostics" : "Tests and diagnostics" }, { "Vaccination" : "Vaccination" }, { "Workforce" : "Workforce" }, { "Accessibility" : "Accessibility" }, { "Adult" : "Adult" }, { "Age" : "Age" }, { "British" : "British" }, { "Care" : "Care" }, { "European" : "European" }, { "Child" : "Child" }, { "GS1" : "GS1" }, { "International" : "International" }, { "Authentication" : "Authentication" }, { "Equality" : "Equality" }, { "Finance" : "Finance" }, { "Government" : "Government" }, { "Health" : "Health" }, { "HL7" : "HL7" }, { "Interoperability" : "Interoperability" }, { "Location" : "Location" }, { "Metadata" : "Metadata" }, { "Open" : "Open" }, { "Organisation" : "Organisation" }, { "Service" : "Service" }, { "Web" : "Web" }, { "W3C" : "W3C" }, { "Clinical_safety" : "Clinical safety" }, { "Date_and_Time" : "Date and Time" }, { "Care_records" : "Care records" }, { "Data_definitions_and_terminologies" : "Data definitions and terminologies" }, { "Information_codes_of_practice" : "Information codes of practice" } ] }, "trialtype" : { "$id" : "#/definitions/trialtype", "title" : "trialType", "$comment" : "dataType", "enum" : [ { "Efficacy" : "Efficacy" }, { "Effectiveness" : "Effectiveness" }, { "Pilot" : "Pilot" }, { "Scale_up" : "Scale-up" }, { "Other" : "Other" }, { "NA" : "Not applicable" } ] }, "url" : { "$id" : "#/definitions/url", "title" : "url", "$comment" : "dataType", "pattern" : "x ==~ /((([A-Za-z]{3,9}:(?:\\/\\/)?)(?:[\\-;:&=\\+\\$,\\w]+@)?[A-Za-z0-9.\\-]+(:[0-9]+)?|(?:www.|[\\-;:&=\\+\\$,\\w]+@)[A-Za-z0-9.\\-]+)((?:\\/[\\+~%\\/.\\w_\\-]*)?\\??(?:[\\-\\+=&;%@.\\w_]*)#?(?:[\\w]*))?)/" }, "varchar" : { "$id" : "#/definitions/varchar", "title" : "varchar", "$comment" : "dataType" }, "xs:date" : { "$id" : "#/definitions/xs:date", "title" : "xs:date", "$comment" : "dataType" }, "xs:language" : { "$id" : "#/definitions/xs:language", "title" : "xs:language", "$comment" : "dataType", "description" : "See assets for full enumerations." }, "xs:string" : { "$id" : "#/definitions/xs:string", "title" : "xs:string", "$comment" : "dataType", "description" : "Character strings in XML." }, "yesno" : { "$id" : "#/definitions/yesno", "title" : "yesNo", "$comment" : "dataType", "enum" : [ { "Yes" : "" }, { "No" : "" } ] } } }

 

Related content

AR7 IPCC DRAFT Metadata Completion Guidance
AR7 IPCC DRAFT Metadata Completion Guidance
More like this
AR7 DATA DICTIONARY (OR STRUCTURAL METADATA)
AR7 DATA DICTIONARY (OR STRUCTURAL METADATA)
More like this
Completing the Descriptive Metadata fields for WG2
Completing the Descriptive Metadata fields for WG2
More like this
(8) Structural Metadata
(8) Structural Metadata
More like this