Skip to content

Commit 4d59006

Browse files
James Taylormiiisterjim
authored andcommitted
NPA-1711_add_include_param_for_patient
1 parent 09687e6 commit 4d59006

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

specification/validated-relationships-service-api.yaml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ paths:
144144
- $ref: "#/components/parameters/BearerAuthorisation"
145145
- $ref: "#/components/parameters/RelatedPersonIdentifier"
146146
- $ref: "#/components/parameters/PatientIdentifier"
147+
- $ref: "#/components/parameters/IncludePatient"
147148
- $ref: "#/components/parameters/RequestID"
148149
- $ref: "#/components/parameters/CorrelationID"
149150
responses:
@@ -519,7 +520,16 @@ components:
519520
summary: "NHS number specified without system"
520521
withSystem:
521522
value: "https://fhir.nhs.uk/Id/nhs-number/9000000009"
522-
summary: "System and NHS number specified"
523+
summary: "System and NHS number specified"
524+
IncludePatient:
525+
in: query
526+
name: _include
527+
description: |
528+
Include Patient resources with their respective RelatedPerson in the bundle returned in the response. Further info [here](https://www.hl7.org/fhir/search.html#_include).
529+
required: false
530+
schema:
531+
type: string
532+
example: patient
523533
BearerAuthorisation:
524534
in: header
525535
name: Authorisation

0 commit comments

Comments
 (0)