Skip to content

Commit 29f0f8a

Browse files
authored
SYN-777: Documentation - Add information about "Modularised NHS content" (#131)
* Added more information regarding modularised content * Text update
1 parent 77b842d commit 29f0f8a

1 file changed

Lines changed: 51 additions & 2 deletions

File tree

specification/nhs-website-content-api.yaml

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,60 @@ info:
6060
## Modularised content
6161
The standard content available through our syndication service is based on the full pages on the NHS website. With our modularised content, you can instead choose to use shorter, more specific sections of content (called "modules") from our pages. This means you can show your users only the content that's most relevant to them. You can also use this content more easily in services like apps and voice assistants.
6262
63-
For more details see [Modularised NHS content](https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/modularised-nhs-content#about-our-modularised-content).
63+
### Benefits of our modularised content
64+
65+
1. **More relevant content for users** — Users do not always want or need full pages of content. With our modularised content, you can choose exactly what your users get.
66+
67+
2. **Suitable for a range of services** — Short, specific content modules can be used more easily than full web pages in services like apps, chatbots and voice assistants.
68+
69+
3. **Clinical assurance** — Each module is checked by NHS clinicians before being made available and carries the trusted NHS brand.
70+
71+
### Available labels / health aspects
72+
73+
We create modules by adding labels (health aspects) to sections of content on our web pages. For example, on our medical condition pages we have labels (health aspects) for sections on "Overview", "Symptoms", "Treatments", "Causes" and more. These labels (health aspects) are based on international standards for structured data from [Schema.org](https://schema.org/HealthAspectEnumeration). Before being made available, each module is checked by our clinical team to make sure it remains accurate and safe to use in isolation.
74+
75+
Here are the 31 health aspects that we currently have available for modularisation, in order of frequency of use:
76+
77+
* OverviewHealthAspect
78+
* SymptomsHealthAspect
79+
* TreatmentsHealthAspect
80+
* CausesHealthAspect
81+
* MedicalHelpNonurgentHealthAspect
82+
* SelfCareHealthAspect
83+
* MedicalHelpUrgentHealthAspect
84+
* MedicalHelpEmergencyHealthAspect
85+
* DiagnosisHealthAspect
86+
* PreventionHealthAspect
87+
* SideEffectsHealthAspect
88+
* LivingWithHealthAspect
89+
* SuitabilityHealthAspect
90+
* InteractionsHealthAspect
91+
* UsageOrScheduleHealthAspect
92+
* PregnancyHealthAspect
93+
* RisksOrComplicationsHealthAspect
94+
* PrognosisHealthAspect
95+
* BenefitsHealthAspect
96+
* ContagiousnessHealthAspect
97+
* WhatHappensHealthAspect
98+
* PreparationHealthAspect
99+
* ResultsHealthAspect
100+
* TypesHealthAspect
101+
* ContraindicationsHealthAspect
102+
* GettingAccessHealthAspect
103+
* WarningHealthAspect
104+
* EffectivenessHealthAspect
105+
* HowItWorksHealthAspect
106+
* IngredientsHealthAspect
107+
108+
### Getting modularised content
109+
110+
To get modularised content, you can use the boolean `modules` query parameter in the [conditions/*](#get-/conditions/*) and [medicines/*](#get-/medicines/*) endpoints. This will return the modularised version of the page (if there is one). If the requested page has not been modularised, the full page will be returned.
111+
112+
You can get a list of which pages have (and have not) been modularised and which health aspects they contain by calling the `/manifest/pages/` endpoint.
64113
65114
## API status
66115
This API has moved from the [NHS website developer portal](https://developer.api.nhs.uk/).
67-
It is currently [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).
116+
It is currently [in production](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).
68117
69118
## Service level
70119
This API is a [bronze service](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).

0 commit comments

Comments
 (0)