Detailed Specification for Content JSON Structure - NHS Health V2 API

Good Day :blush:

I have some queries regarding NHS Health A-Z API

Upon review of the website API documentation/Schema’s, we noticed that the schema information provided is rather sparse, only outlining required fields and types.

We’re trying to gain more detailed insight into the schema itself and, in particular, how it relates to the content visible on the NHS A-Z website.

Our product ingests the JSON documents and re-renders them into our own format, aiming to replicate the NHS A-Z website’s content as closely as possible. To achieve this, we need clarity on the JSON data and its relationship with the website content.

Some specific points we need insight into include:

  1. Details on Named Types : For example, markdown, expander, reveal, toptasks, urgent, section heading, etc. How do these types function, and what role do they play in structuring the content?
  2. Content Duplication : For example, in the Allergic Rhinitis document, there are three identical “Question” entries (e.g., “how to clean your nose…” with the same text and content). It would help to understand when and why sections are repeated to avoid unnecessary duplication in our output.
  3. @type Values for mainEntityOfPage : We would appreciate a comprehensive list of potential @type values and how they are applied in the documents.

Attached is the schema documentation available on the site. As you’ll see, it lacks detailed explanations or guidance beyond noting whether a value is required or text-based.

We’ve observed that the schema provided for e-RS/FHIR API is somewhat more informative compared to the NHS Health A-Z schemas on the website. Having a similarly detailed specification for NHS Health A-Z would help us significantly in aligning our work with the intended structure and logic of the data.

Your help in obtaining this information would be greatly appreciated and crucial for us to align our output with the NHS A-Z content :blush:

Many Thanks,
Jacoline

Thanks for your query, we are currently looking into how we can best meet your questions and will get back to you as soon as we can.