NRL-518 Add documentation for content validation

axelkrastek1-nhs · axelkrastek1-nhs · commit 7b7f2bd985ff · 2024-12-04T15:07:36.000Z
diff --git a/swagger/producer-static/narrative.yaml b/swagger/producer-static/narrative.yaml
@@ -276,7 +276,12 @@ paths:
           ]
           ```
         * `content` MUST have at least one entry.
-        * `content[].format[]` SHOULD indicate whether the data is structured or not, e.g.
+        * `content` MUST include an `attachment` entry.
+        * `content` MUST include a `format` entry.
+        * `content` MUST include the content stability extension (https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability).
+        * `content[].attachment` MUST include a `url` to the document.
+        * `content[].attachment` MUST include a `contentType` and be a valid MIME type, specifically `application/pdf` for documents or `text/html` for contact details.
+        * `content[].format[]` MUST indicate whether the data is structured or not, e.g.
           ```
           "format": [
             {

Original file line number	Diff line number	Diff line change
`@@ -276,7 +276,12 @@ paths:`
`276`	`276`	`]`
`277`	`277`	```
`278`	`278`	* `content` MUST have at least one entry.
`279`		- * `content[].format[]` SHOULD indicate whether the data is structured or not, e.g.
	`279`	+ * `content` MUST include an `attachment` entry.
	`280`	+ * `content` MUST include a `format` entry.
	`281`	+ * `content` MUST include the content stability extension (https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability).
	`282`	+ * `content[].attachment` MUST include a `url` to the document.
	`283`	+ * `content[].attachment` MUST include a `contentType` and be a valid MIME type, specifically `application/pdf` for documents or `text/html` for contact details.
	`284`	+ * `content[].format[]` MUST indicate whether the data is structured or not, e.g.
`280`	`285`	```
`281`	`286`	`"format": [`
`282`	`287`	`{`