update documentation

NHSDigital · Nov 15, 2024 · 459cf5e · 459cf5e
1 parent 6d2de1e
commit 459cf5e
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/specification/record-locator/producer.yaml b/specification/record-locator/producer.yaml
@@ -418,6 +418,7 @@ paths:
       parameters:
         - $ref: "#/components/parameters/subject"
         - $ref: "#/components/parameters/type"
+        - $ref: "#/components/parameters/category"
         - $ref: "#/components/parameters/nextPageToken"
         - $ref: "#/components/parameters/odsCode"
         - $ref: "#/components/parameters/odsCodeExtension"
@@ -2059,6 +2060,8 @@ components:
           $ref: "#/components/schemas/RequestQuerySubject"
         type:
           $ref: "#/components/schemas/RequestQueryType"
+        category:
+          $ref: "#/components/schemas/RequestQueryCategory"
         next-page-token:
           $ref: "#/components/schemas/NextPageToken"
     RequestQuerySubject:
@@ -2068,6 +2071,9 @@ components:
     RequestQueryType:
       type: string
       example: "http://snomed.info/sct|736253002"
+    RequestQueryCategory:
+        type: string
+        example: "http://snomed.info/sct|103693007"
     NextPageToken:
       type: string
     RequestHeaderOdsCode:
@@ -2162,6 +2168,33 @@ components:
         invalid:
           summary: Unknown
           value: http://snomed.info/sct|410970009
+    category:
+      name: category
+      in: query
+      schema:
+        $ref: "#/components/schemas/RequestQueryCategory"
+      examples:
+        none:
+          summary: None
+          value: ""
+        SNOMED_CODES_CARE_PLAN:
+          summary: Care plan
+          value: http://snomed.info/sct|734163000
+        SNOMED_CODES_OBSERVATIONS:
+          summary: Observations
+          value: http://snomed.info/sct|1102421000000108
+        SNOMED_CODES_CLINICAL_NOTE:
+          summary: Clinical note
+          value: http://snomed.info/sct|823651000000106
+        SNOMED_CODES_DIAGNOSTIC_STUDIES_REPORT:
+          summary: Diagnostic studies report
+          value: http://snomed.info/sct|721981007
+        SNOMED_CODES_DIAGNOSTIC_PROCEDURE:
+          summary: Diagnostic procedure
+          value: http://snomed.info/sct|103693007
+        invalid:
+          summary: Unknown
+          value: http://snomed.info/sct|410970009
     nextPageToken:
       name: next-page-token
       in: query