canonical-data-model-openapi.yaml

openapi: 3.0.1
info:
  title: FDP CDM OpenAPI
  description: Definitions for the FDP CDM
  version: 3.0.1
externalDocs:
  description: Palantir API Documentation
  url: https://www.palantir.com/docs
servers:
- url: https://solutionexchange.federateddataplatform.nhs.uk
paths:
  /api/v2/ontologies/solution-exchange/objects/admission:
    get:
      tags:
      - AdmissionApiService
      operationId: listAdmission
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AdmissionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListAdmissionResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/admission/aggregate:
    post:
      tags:
      - AdmissionApiService
      operationId: computeAdmissionAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/admission/count:
    post:
      tags:
      - AdmissionApiService
      operationId: computeAdmissionCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/admission/search:
    post:
      tags:
      - AdmissionApiService
      operationId: searchAdmission
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchAdmissionResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/admission/{primaryKey}:
    get:
      tags:
      - AdmissionApiService
      operationId: getAdmission
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AdmissionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Admission"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/admission/{primaryKey}/links/patient:
    get:
      tags:
      - AdmissionApiService
      operationId: listAdmissionLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AdmissionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/admission/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - AdmissionApiService
      operationId: getAdmissionLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AdmissionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/appointment:
    get:
      tags:
      - AppointmentApiService
      operationId: listAppointment
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListAppointmentResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/appointment/aggregate:
    post:
      tags:
      - AppointmentApiService
      operationId: computeAppointmentAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/appointment/count:
    post:
      tags:
      - AppointmentApiService
      operationId: computeAppointmentCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/appointment/search:
    post:
      tags:
      - AppointmentApiService
      operationId: searchAppointment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchAppointmentResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/appointment/{primaryKey}:
    get:
      tags:
      - AppointmentApiService
      operationId: getAppointment
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Appointment"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/appointment/{primaryKey}/links/clinicLetters:
    get:
      tags:
      - AppointmentApiService
      operationId: listAppointmentLinkedClinicLetters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicLetterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/appointment/{primaryKey}/links/clinicLetters/{linkedObjectPrimaryKey}
  : get:
      tags:
      - AppointmentApiService
      operationId: getAppointmentLinkedClinicLetters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicLetter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/appointment/{primaryKey}/links/clinicSession:
    get:
      tags:
      - AppointmentApiService
      operationId: listAppointmentLinkedClinicSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/appointment/{primaryKey}/links/clinicSession/{linkedObjectPrimaryKey}
  : get:
      tags:
      - AppointmentApiService
      operationId: getAppointmentLinkedClinicSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicSession"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/appointment/{primaryKey}/links/patient:
    get:
      tags:
      - AppointmentApiService
      operationId: listAppointmentLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/appointment/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - AppointmentApiService
      operationId: getAppointmentLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/appointment/{primaryKey}/links/referral:
    get:
      tags:
      - AppointmentApiService
      operationId: listAppointmentLinkedReferral
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListReferralResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/appointment/{primaryKey}/links/referral/{linkedObjectPrimaryKey}
  : get:
      tags:
      - AppointmentApiService
      operationId: getAppointmentLinkedReferral
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/AppointmentProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/referral"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional:
    get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessional
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/aggregate:
    post:
      tags:
      - CareProfessionalApiService
      operationId: computeCareProfessionalAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/count:
    post:
      tags:
      - CareProfessionalApiService
      operationId: computeCareProfessionalCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/search:
    post:
      tags:
      - CareProfessionalApiService
      operationId: searchCareProfessional
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchCareProfessionalResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}:
    get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CareProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/clinicSessions:
    get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedClinicSessions
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/clinicSessions/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedClinicSessions
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicSession"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/encounters:
    get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedEncounters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEncounterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/encounters/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedEncounters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/encounter"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/outpatientActivities
  : get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListOutpatientActivityResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/outpatientActivities/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/outpatientActivity"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/patientPathways:
    get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientPathwayResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/patientPathways/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patientPathway"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/procedures:
    get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedProcedures
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/procedures/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedProcedures
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedure"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/proceduresAsPrimary
  : get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedProceduresAsPrimary
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/proceduresAsPrimary/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedProceduresAsPrimary
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedure"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/specialty:
    get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSpecialtyResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/specialty"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/staffUnavailabilities
  : get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedStaffUnavailabilities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListStaffUnavailabilityResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/staffUnavailabilities/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedStaffUnavailabilities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/staffUnavailability"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreBookings:
    get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreBookingResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreBookings/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreBooking"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreSessionAllAnaesthetists
  : get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedTheatreSessionAllAnaesthetists
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreSessionAllAnaesthetists/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedTheatreSessionAllAnaesthetists
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreSession"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreSessionsAllConsultants
  : get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedTheatreSessionsAllConsultants
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreSessionsAllConsultants/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedTheatreSessionsAllConsultants
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreSession"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreSessionsAnaesthetist
  : get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedTheatreSessionsAnaesthetist
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreSessionsAnaesthetist/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedTheatreSessionsAnaesthetist
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreSession"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreSessionsConsultant
  : get:
      tags:
      - CareProfessionalApiService
      operationId: listCareProfessionalLinkedTheatreSessionsConsultant
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/careProfessional/{primaryKey}/links/theatreSessionsConsultant/{linkedObjectPrimaryKey}
  : get:
      tags:
      - CareProfessionalApiService
      operationId: getCareProfessionalLinkedTheatreSessionsConsultant
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessionalProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreSession"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicLetter:
    get:
      tags:
      - ClinicLetterApiService
      operationId: listClinicLetter
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicLetterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicLetterResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicLetter/aggregate:
    post:
      tags:
      - ClinicLetterApiService
      operationId: computeClinicLetterAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicLetter/count:
    post:
      tags:
      - ClinicLetterApiService
      operationId: computeClinicLetterCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicLetter/search:
    post:
      tags:
      - ClinicLetterApiService
      operationId: searchClinicLetter
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchClinicLetterResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicLetter/{primaryKey}:
    get:
      tags:
      - ClinicLetterApiService
      operationId: getClinicLetter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicLetterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ClinicLetter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicLetter/{primaryKey}/links/appointment:
    get:
      tags:
      - ClinicLetterApiService
      operationId: listClinicLetterLinkedAppointment
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicLetterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListAppointmentResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicLetter/{primaryKey}/links/appointment/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicLetterApiService
      operationId: getClinicLetterLinkedAppointment
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicLetterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/appointment"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicLetter/{primaryKey}/links/patient:
    get:
      tags:
      - ClinicLetterApiService
      operationId: listClinicLetterLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicLetterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicLetter/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicLetterApiService
      operationId: getClinicLetterLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicLetterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSession:
    get:
      tags:
      - ClinicSessionApiService
      operationId: listClinicSession
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicSessionResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSession/aggregate:
    post:
      tags:
      - ClinicSessionApiService
      operationId: computeClinicSessionAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSession/count:
    post:
      tags:
      - ClinicSessionApiService
      operationId: computeClinicSessionCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSession/search:
    post:
      tags:
      - ClinicSessionApiService
      operationId: searchClinicSession
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchClinicSessionResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSession/{primaryKey}:
    get:
      tags:
      - ClinicSessionApiService
      operationId: getClinicSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ClinicSession"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSession/{primaryKey}/links/appointments:
    get:
      tags:
      - ClinicSessionApiService
      operationId: listClinicSessionLinkedAppointments
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListAppointmentResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicSession/{primaryKey}/links/appointments/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicSessionApiService
      operationId: getClinicSessionLinkedAppointments
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/appointment"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSession/{primaryKey}/links/careProfessional:
    get:
      tags:
      - ClinicSessionApiService
      operationId: listClinicSessionLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicSession/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicSessionApiService
      operationId: getClinicSessionLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSession/{primaryKey}/links/clinicSlots:
    get:
      tags:
      - ClinicSessionApiService
      operationId: listClinicSessionLinkedClinicSlots
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicSlotResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicSession/{primaryKey}/links/clinicSlots/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicSessionApiService
      operationId: getClinicSessionLinkedClinicSlots
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicSlot"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSession/{primaryKey}/links/clinicType:
    get:
      tags:
      - ClinicSessionApiService
      operationId: listClinicSessionLinkedClinicType
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicTypeResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicSession/{primaryKey}/links/clinicType/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicSessionApiService
      operationId: getClinicSessionLinkedClinicType
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicType"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSlot:
    get:
      tags:
      - ClinicSlotApiService
      operationId: listClinicSlot
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSlotProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicSlotResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSlot/aggregate:
    post:
      tags:
      - ClinicSlotApiService
      operationId: computeClinicSlotAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSlot/count:
    post:
      tags:
      - ClinicSlotApiService
      operationId: computeClinicSlotCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSlot/search:
    post:
      tags:
      - ClinicSlotApiService
      operationId: searchClinicSlot
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchClinicSlotResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSlot/{primaryKey}:
    get:
      tags:
      - ClinicSlotApiService
      operationId: getClinicSlot
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSlotProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ClinicSlot"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSlot/{primaryKey}/links/clinicSession:
    get:
      tags:
      - ClinicSlotApiService
      operationId: listClinicSlotLinkedClinicSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSlotProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicSlot/{primaryKey}/links/clinicSession/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicSlotApiService
      operationId: getClinicSlotLinkedClinicSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSlotProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicSession"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicSlot/{primaryKey}/links/ersServices:
    get:
      tags:
      - ClinicSlotApiService
      operationId: listClinicSlotLinkedErsServices
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSlotProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListErsServiceResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicSlot/{primaryKey}/links/ersServices/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicSlotApiService
      operationId: getClinicSlotLinkedErsServices
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSlotProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ersService"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicType:
    get:
      tags:
      - ClinicTypeApiService
      operationId: listClinicType
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicTypeProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicTypeResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicType/aggregate:
    post:
      tags:
      - ClinicTypeApiService
      operationId: computeClinicTypeAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicType/count:
    post:
      tags:
      - ClinicTypeApiService
      operationId: computeClinicTypeCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicType/search:
    post:
      tags:
      - ClinicTypeApiService
      operationId: searchClinicType
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchClinicTypeResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicType/{primaryKey}:
    get:
      tags:
      - ClinicTypeApiService
      operationId: getClinicType
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicTypeProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ClinicType"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicType/{primaryKey}/links/clinicSessions:
    get:
      tags:
      - ClinicTypeApiService
      operationId: listClinicTypeLinkedClinicSessions
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicTypeProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicType/{primaryKey}/links/clinicSessions/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicTypeApiService
      operationId: getClinicTypeLinkedClinicSessions
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicTypeProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicSession"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicType/{primaryKey}/links/ersServices:
    get:
      tags:
      - ClinicTypeApiService
      operationId: listClinicTypeLinkedErsServices
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicTypeProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListErsServiceResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicType/{primaryKey}/links/ersServices/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicTypeApiService
      operationId: getClinicTypeLinkedErsServices
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicTypeProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ersService"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/clinicType/{primaryKey}/links/specialty:
    get:
      tags:
      - ClinicTypeApiService
      operationId: listClinicTypeLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicTypeProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSpecialtyResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/clinicType/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ClinicTypeApiService
      operationId: getClinicTypeLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ClinicTypeProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/specialty"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosis:
    get:
      tags:
      - DiagnosisApiService
      operationId: listDiagnosis
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosisProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListDiagnosisResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosis/aggregate:
    post:
      tags:
      - DiagnosisApiService
      operationId: computeDiagnosisAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosis/count:
    post:
      tags:
      - DiagnosisApiService
      operationId: computeDiagnosisCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosis/search:
    post:
      tags:
      - DiagnosisApiService
      operationId: searchDiagnosis
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchDiagnosisResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosis/{primaryKey}:
    get:
      tags:
      - DiagnosisApiService
      operationId: getDiagnosis
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosisProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Diagnosis"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosis/{primaryKey}/links/patient:
    get:
      tags:
      - DiagnosisApiService
      operationId: listDiagnosisLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosisProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/diagnosis/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - DiagnosisApiService
      operationId: getDiagnosisLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosisProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry:
    get:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: listDiagnosticsWaitlistEntry
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntryProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListDiagnosticsWaitlistEntryResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/aggregate:
    post:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: computeDiagnosticsWaitlistEntryAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/count:
    post:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: computeDiagnosticsWaitlistEntryCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/search:
    post:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: searchDiagnosticsWaitlistEntry
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchDiagnosticsWaitlistEntryResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/{primaryKey}:
    get:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: getDiagnosticsWaitlistEntry
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntryProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DiagnosticsWaitlistEntry"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/{primaryKey}/links/patient:
    get:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: listDiagnosticsWaitlistEntryLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntryProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: getDiagnosticsWaitlistEntryLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntryProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/{primaryKey}/links/patientPathway
  : get:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: listDiagnosticsWaitlistEntryLinkedPatientPathway
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntryProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientPathwayResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey}
  : get:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: getDiagnosticsWaitlistEntryLinkedPatientPathway
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntryProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patientPathway"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/{primaryKey}/links/specialty:
    get:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: listDiagnosticsWaitlistEntryLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntryProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSpecialtyResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/diagnosticsWaitlistEntry/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}
  : get:
      tags:
      - DiagnosticsWaitlistEntryApiService
      operationId: getDiagnosticsWaitlistEntryLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntryProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/specialty"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ealEntry:
    get:
      tags:
      - EalEntryApiService
      operationId: listEalEntry
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EalEntryProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEalEntryResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ealEntry/aggregate:
    post:
      tags:
      - EalEntryApiService
      operationId: computeEalEntryAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ealEntry/count:
    post:
      tags:
      - EalEntryApiService
      operationId: computeEalEntryCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ealEntry/search:
    post:
      tags:
      - EalEntryApiService
      operationId: searchEalEntry
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchEalEntryResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ealEntry/{primaryKey}:
    get:
      tags:
      - EalEntryApiService
      operationId: getEalEntry
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EalEntryProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EalEntry"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ealEntry/{primaryKey}/links/encounter:
    get:
      tags:
      - EalEntryApiService
      operationId: listEalEntryLinkedEncounter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EalEntryProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEncounterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/ealEntry/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EalEntryApiService
      operationId: getEalEntryLinkedEncounter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EalEntryProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/encounter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ealEntry/{primaryKey}/links/patient:
    get:
      tags:
      - EalEntryApiService
      operationId: listEalEntryLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EalEntryProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/ealEntry/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EalEntryApiService
      operationId: getEalEntryLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EalEntryProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ealEntry/{primaryKey}/links/theatreBookings:
    get:
      tags:
      - EalEntryApiService
      operationId: listEalEntryLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EalEntryProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreBookingResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/ealEntry/{primaryKey}/links/theatreBookings/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EalEntryApiService
      operationId: getEalEntryLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EalEntryProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreBooking"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter:
    get:
      tags:
      - EncounterApiService
      operationId: listEncounter
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEncounterResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/aggregate:
    post:
      tags:
      - EncounterApiService
      operationId: computeEncounterAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/count:
    post:
      tags:
      - EncounterApiService
      operationId: computeEncounterCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/search:
    post:
      tags:
      - EncounterApiService
      operationId: searchEncounter
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchEncounterResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}:
    get:
      tags:
      - EncounterApiService
      operationId: getEncounter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Encounter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/careProfessional:
    get:
      tags:
      - EncounterApiService
      operationId: listEncounterLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EncounterApiService
      operationId: getEncounterLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/ealEntry:
    get:
      tags:
      - EncounterApiService
      operationId: listEncounterLinkedEalEntry
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEalEntryResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/ealEntry/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EncounterApiService
      operationId: getEncounterLinkedEalEntry
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ealEntry"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/patient:
    get:
      tags:
      - EncounterApiService
      operationId: listEncounterLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EncounterApiService
      operationId: getEncounterLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/patientPathway:
    get:
      tags:
      - EncounterApiService
      operationId: listEncounterLinkedPatientPathway
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientPathwayResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EncounterApiService
      operationId: getEncounterLinkedPatientPathway
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patientPathway"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/procedureStatuses:
    get:
      tags:
      - EncounterApiService
      operationId: listEncounterLinkedProcedureStatuses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureStatusResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/procedureStatuses/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EncounterApiService
      operationId: getEncounterLinkedProcedureStatuses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedureStatus"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/procedures:
    get:
      tags:
      - EncounterApiService
      operationId: listEncounterLinkedProcedures
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/procedures/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EncounterApiService
      operationId: getEncounterLinkedProcedures
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedure"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/specialty:
    get:
      tags:
      - EncounterApiService
      operationId: listEncounterLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSpecialtyResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EncounterApiService
      operationId: getEncounterLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/specialty"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/theatreBookings:
    get:
      tags:
      - EncounterApiService
      operationId: listEncounterLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreBookingResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/encounter/{primaryKey}/links/theatreBookings/{linkedObjectPrimaryKey}
  : get:
      tags:
      - EncounterApiService
      operationId: getEncounterLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/EncounterProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreBooking"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService:
    get:
      tags:
      - ErsServiceApiService
      operationId: listErsService
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListErsServiceResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService/aggregate:
    post:
      tags:
      - ErsServiceApiService
      operationId: computeErsServiceAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService/count:
    post:
      tags:
      - ErsServiceApiService
      operationId: computeErsServiceCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService/search:
    post:
      tags:
      - ErsServiceApiService
      operationId: searchErsService
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchErsServiceResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}:
    get:
      tags:
      - ErsServiceApiService
      operationId: getErsService
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErsService"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/clinicSlots:
    get:
      tags:
      - ErsServiceApiService
      operationId: listErsServiceLinkedClinicSlots
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicSlotResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/clinicSlots/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ErsServiceApiService
      operationId: getErsServiceLinkedClinicSlots
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicSlot"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/clinicTypes:
    get:
      tags:
      - ErsServiceApiService
      operationId: listErsServiceLinkedClinicTypes
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicTypeResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/clinicTypes/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ErsServiceApiService
      operationId: getErsServiceLinkedClinicTypes
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicType"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/referrals:
    get:
      tags:
      - ErsServiceApiService
      operationId: listErsServiceLinkedReferrals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListReferralResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/referrals/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ErsServiceApiService
      operationId: getErsServiceLinkedReferrals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/referral"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/site:
    get:
      tags:
      - ErsServiceApiService
      operationId: listErsServiceLinkedSite
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSiteResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/site/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ErsServiceApiService
      operationId: getErsServiceLinkedSite
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/site"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/specialties:
    get:
      tags:
      - ErsServiceApiService
      operationId: listErsServiceLinkedSpecialties
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSpecialtyResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/ersService/{primaryKey}/links/specialties/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ErsServiceApiService
      operationId: getErsServiceLinkedSpecialties
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ErsServiceProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/specialty"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity:
    get:
      tags:
      - OutpatientActivityApiService
      operationId: listOutpatientActivity
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListOutpatientActivityResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity/aggregate:
    post:
      tags:
      - OutpatientActivityApiService
      operationId: computeOutpatientActivityAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity/count:
    post:
      tags:
      - OutpatientActivityApiService
      operationId: computeOutpatientActivityCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity/search:
    post:
      tags:
      - OutpatientActivityApiService
      operationId: searchOutpatientActivity
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchOutpatientActivityResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}:
    get:
      tags:
      - OutpatientActivityApiService
      operationId: getOutpatientActivity
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OutpatientActivity"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/careProfessional:
    get:
      tags:
      - OutpatientActivityApiService
      operationId: listOutpatientActivityLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey}
  : get:
      tags:
      - OutpatientActivityApiService
      operationId: getOutpatientActivityLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/patient:
    get:
      tags:
      - OutpatientActivityApiService
      operationId: listOutpatientActivityLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - OutpatientActivityApiService
      operationId: getOutpatientActivityLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/patientPathway:
    get:
      tags:
      - OutpatientActivityApiService
      operationId: listOutpatientActivityLinkedPatientPathway
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientPathwayResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey}
  : get:
      tags:
      - OutpatientActivityApiService
      operationId: getOutpatientActivityLinkedPatientPathway
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patientPathway"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/referral:
    get:
      tags:
      - OutpatientActivityApiService
      operationId: listOutpatientActivityLinkedReferral
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListReferralResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/referral/{linkedObjectPrimaryKey}
  : get:
      tags:
      - OutpatientActivityApiService
      operationId: getOutpatientActivityLinkedReferral
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/referral"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/specialty:
    get:
      tags:
      - OutpatientActivityApiService
      operationId: listOutpatientActivityLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSpecialtyResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/outpatientActivity/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}
  : get:
      tags:
      - OutpatientActivityApiService
      operationId: getOutpatientActivityLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivityProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/specialty"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient:
    get:
      tags:
      - PatientApiService
      operationId: listPatient
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/aggregate:
    post:
      tags:
      - PatientApiService
      operationId: computePatientAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/count:
    post:
      tags:
      - PatientApiService
      operationId: computePatientCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/search:
    post:
      tags:
      - PatientApiService
      operationId: searchPatient
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchPatientResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}:
    get:
      tags:
      - PatientApiService
      operationId: getPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/admissions:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedAdmissions
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListAdmissionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/admissions/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedAdmissions
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/admission"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/appointments:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedAppointments
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListAppointmentResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/appointments/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedAppointments
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/appointment"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/clinicLetters:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedClinicLetters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicLetterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/clinicLetters/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedClinicLetters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicLetter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/diagnoses:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedDiagnoses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListDiagnosisResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/diagnoses/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedDiagnoses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/diagnosis"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/diagnosticsWaitlistEntries:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedDiagnosticsWaitlistEntries
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListDiagnosticsWaitlistEntryResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/diagnosticsWaitlistEntries/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedDiagnosticsWaitlistEntries
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/diagnosticsWaitlistEntry"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/ealEntries:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedEalEntries
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEalEntryResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/ealEntries/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedEalEntries
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ealEntry"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/encounters:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedEncounters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEncounterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/encounters/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedEncounters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/encounter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/outpatientActivities:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListOutpatientActivityResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/outpatientActivities/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/outpatientActivity"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/patientPathways:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientPathwayResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/patientPathways/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patientPathway"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/procedureStatuses:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedProcedureStatuses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureStatusResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/procedureStatuses/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedProcedureStatuses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedureStatus"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/procedures:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedProcedures
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/procedures/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedProcedures
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedure"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/referrals:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedReferrals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListReferralResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/referrals/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedReferrals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/referral"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/testResults:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedTestResults
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTestResultResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/testResults/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedTestResults
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/testResult"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/theatreBookings:
    get:
      tags:
      - PatientApiService
      operationId: listPatientLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreBookingResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patient/{primaryKey}/links/theatreBookings/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientApiService
      operationId: getPatientLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreBooking"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway:
    get:
      tags:
      - PatientPathwayApiService
      operationId: listPatientPathway
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientPathwayResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/aggregate:
    post:
      tags:
      - PatientPathwayApiService
      operationId: computePatientPathwayAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/count:
    post:
      tags:
      - PatientPathwayApiService
      operationId: computePatientPathwayCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/search:
    post:
      tags:
      - PatientPathwayApiService
      operationId: searchPatientPathway
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchPatientPathwayResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}:
    get:
      tags:
      - PatientPathwayApiService
      operationId: getPatientPathway
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PatientPathway"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/careProfessional:
    get:
      tags:
      - PatientPathwayApiService
      operationId: listPatientPathwayLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientPathwayApiService
      operationId: getPatientPathwayLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/diagnosticsWaitlistEntries
  : get:
      tags:
      - PatientPathwayApiService
      operationId: listPatientPathwayLinkedDiagnosticsWaitlistEntries
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListDiagnosticsWaitlistEntryResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/diagnosticsWaitlistEntries/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientPathwayApiService
      operationId: getPatientPathwayLinkedDiagnosticsWaitlistEntries
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/diagnosticsWaitlistEntry"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/encounters:
    get:
      tags:
      - PatientPathwayApiService
      operationId: listPatientPathwayLinkedEncounters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEncounterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/encounters/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientPathwayApiService
      operationId: getPatientPathwayLinkedEncounters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/encounter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/outpatientActivities:
    get:
      tags:
      - PatientPathwayApiService
      operationId: listPatientPathwayLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListOutpatientActivityResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/outpatientActivities/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientPathwayApiService
      operationId: getPatientPathwayLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/outpatientActivity"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/patient:
    get:
      tags:
      - PatientPathwayApiService
      operationId: listPatientPathwayLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientPathwayApiService
      operationId: getPatientPathwayLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/referrals:
    get:
      tags:
      - PatientPathwayApiService
      operationId: listPatientPathwayLinkedReferrals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListReferralResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/referrals/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientPathwayApiService
      operationId: getPatientPathwayLinkedReferrals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/referral"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/site:
    get:
      tags:
      - PatientPathwayApiService
      operationId: listPatientPathwayLinkedSite
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSiteResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/site/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientPathwayApiService
      operationId: getPatientPathwayLinkedSite
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/site"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/specialty:
    get:
      tags:
      - PatientPathwayApiService
      operationId: listPatientPathwayLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSpecialtyResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/patientPathway/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}
  : get:
      tags:
      - PatientPathwayApiService
      operationId: getPatientPathwayLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathwayProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/specialty"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure:
    get:
      tags:
      - ProcedureApiService
      operationId: listProcedure
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/aggregate:
    post:
      tags:
      - ProcedureApiService
      operationId: computeProcedureAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/count:
    post:
      tags:
      - ProcedureApiService
      operationId: computeProcedureCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/search:
    post:
      tags:
      - ProcedureApiService
      operationId: searchProcedure
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchProcedureResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}:
    get:
      tags:
      - ProcedureApiService
      operationId: getProcedure
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Procedure"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/careProfessionalPrimary:
    get:
      tags:
      - ProcedureApiService
      operationId: listProcedureLinkedCareProfessionalPrimary
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/careProfessionalPrimary/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureApiService
      operationId: getProcedureLinkedCareProfessionalPrimary
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/careProfessionals:
    get:
      tags:
      - ProcedureApiService
      operationId: listProcedureLinkedCareProfessionals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/careProfessionals/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureApiService
      operationId: getProcedureLinkedCareProfessionals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/encounter:
    get:
      tags:
      - ProcedureApiService
      operationId: listProcedureLinkedEncounter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEncounterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureApiService
      operationId: getProcedureLinkedEncounter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/encounter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/patient:
    get:
      tags:
      - ProcedureApiService
      operationId: listProcedureLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureApiService
      operationId: getProcedureLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/procedureStatuses:
    get:
      tags:
      - ProcedureApiService
      operationId: listProcedureLinkedProcedureStatuses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureStatusResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/procedureStatuses/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureApiService
      operationId: getProcedureLinkedProcedureStatuses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedureStatus"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/theatreBookings:
    get:
      tags:
      - ProcedureApiService
      operationId: listProcedureLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreBookingResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/theatreBookings/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureApiService
      operationId: getProcedureLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreBooking"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/theatreSession:
    get:
      tags:
      - ProcedureApiService
      operationId: listProcedureLinkedTheatreSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedure/{primaryKey}/links/theatreSession/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureApiService
      operationId: getProcedureLinkedTheatreSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreSession"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureStatus:
    get:
      tags:
      - ProcedureStatusApiService
      operationId: listProcedureStatus
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureStatusResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureStatus/aggregate:
    post:
      tags:
      - ProcedureStatusApiService
      operationId: computeProcedureStatusAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureStatus/count:
    post:
      tags:
      - ProcedureStatusApiService
      operationId: computeProcedureStatusCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureStatus/search:
    post:
      tags:
      - ProcedureStatusApiService
      operationId: searchProcedureStatus
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchProcedureStatusResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureStatus/{primaryKey}:
    get:
      tags:
      - ProcedureStatusApiService
      operationId: getProcedureStatus
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProcedureStatus"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureStatus/{primaryKey}/links/encounter:
    get:
      tags:
      - ProcedureStatusApiService
      operationId: listProcedureStatusLinkedEncounter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEncounterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedureStatus/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureStatusApiService
      operationId: getProcedureStatusLinkedEncounter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/encounter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureStatus/{primaryKey}/links/patient:
    get:
      tags:
      - ProcedureStatusApiService
      operationId: listProcedureStatusLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedureStatus/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureStatusApiService
      operationId: getProcedureStatusLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureStatus/{primaryKey}/links/procedure:
    get:
      tags:
      - ProcedureStatusApiService
      operationId: listProcedureStatusLinkedProcedure
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedureStatus/{primaryKey}/links/procedure/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureStatusApiService
      operationId: getProcedureStatusLinkedProcedure
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedure"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureStatus/{primaryKey}/links/theatreBooking:
    get:
      tags:
      - ProcedureStatusApiService
      operationId: listProcedureStatusLinkedTheatreBooking
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreBookingResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/procedureStatus/{primaryKey}/links/theatreBooking/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ProcedureStatusApiService
      operationId: getProcedureStatusLinkedTheatreBooking
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatusProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreBooking"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureType:
    get:
      tags:
      - ProcedureTypeApiService
      operationId: listProcedureType
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureTypeProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureTypeResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureType/aggregate:
    post:
      tags:
      - ProcedureTypeApiService
      operationId: computeProcedureTypeAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureType/count:
    post:
      tags:
      - ProcedureTypeApiService
      operationId: computeProcedureTypeCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureType/search:
    post:
      tags:
      - ProcedureTypeApiService
      operationId: searchProcedureType
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchProcedureTypeResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/procedureType/{primaryKey}:
    get:
      tags:
      - ProcedureTypeApiService
      operationId: getProcedureType
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureTypeProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProcedureType"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral:
    get:
      tags:
      - ReferralApiService
      operationId: listReferral
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListReferralResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral/aggregate:
    post:
      tags:
      - ReferralApiService
      operationId: computeReferralAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral/count:
    post:
      tags:
      - ReferralApiService
      operationId: computeReferralCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral/search:
    post:
      tags:
      - ReferralApiService
      operationId: searchReferral
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchReferralResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}:
    get:
      tags:
      - ReferralApiService
      operationId: getReferral
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Referral"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/appointments:
    get:
      tags:
      - ReferralApiService
      operationId: listReferralLinkedAppointments
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListAppointmentResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/appointments/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ReferralApiService
      operationId: getReferralLinkedAppointments
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/appointment"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/ersService:
    get:
      tags:
      - ReferralApiService
      operationId: listReferralLinkedErsService
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListErsServiceResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/ersService/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ReferralApiService
      operationId: getReferralLinkedErsService
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ersService"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/outpatientActivities:
    get:
      tags:
      - ReferralApiService
      operationId: listReferralLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListOutpatientActivityResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/outpatientActivities/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ReferralApiService
      operationId: getReferralLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/outpatientActivity"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/patient:
    get:
      tags:
      - ReferralApiService
      operationId: listReferralLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ReferralApiService
      operationId: getReferralLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/patientPathways:
    get:
      tags:
      - ReferralApiService
      operationId: listReferralLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientPathwayResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/referral/{primaryKey}/links/patientPathways/{linkedObjectPrimaryKey}
  : get:
      tags:
      - ReferralApiService
      operationId: getReferralLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/ReferralProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patientPathway"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/site:
    get:
      tags:
      - SiteApiService
      operationId: listSite
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SiteProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSiteResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/site/aggregate:
    post:
      tags:
      - SiteApiService
      operationId: computeSiteAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/site/count:
    post:
      tags:
      - SiteApiService
      operationId: computeSiteCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/site/search:
    post:
      tags:
      - SiteApiService
      operationId: searchSite
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchSiteResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/site/{primaryKey}:
    get:
      tags:
      - SiteApiService
      operationId: getSite
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SiteProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Site"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/site/{primaryKey}/links/ersServices:
    get:
      tags:
      - SiteApiService
      operationId: listSiteLinkedErsServices
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SiteProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListErsServiceResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/site/{primaryKey}/links/ersServices/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SiteApiService
      operationId: getSiteLinkedErsServices
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SiteProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ersService"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/site/{primaryKey}/links/patientPathways:
    get:
      tags:
      - SiteApiService
      operationId: listSiteLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SiteProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientPathwayResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/site/{primaryKey}/links/patientPathways/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SiteApiService
      operationId: getSiteLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SiteProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patientPathway"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty:
    get:
      tags:
      - SpecialtyApiService
      operationId: listSpecialty
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSpecialtyResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/aggregate:
    post:
      tags:
      - SpecialtyApiService
      operationId: computeSpecialtyAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/count:
    post:
      tags:
      - SpecialtyApiService
      operationId: computeSpecialtyCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/search:
    post:
      tags:
      - SpecialtyApiService
      operationId: searchSpecialty
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchSpecialtyResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}:
    get:
      tags:
      - SpecialtyApiService
      operationId: getSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Specialty"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/careProfessionals:
    get:
      tags:
      - SpecialtyApiService
      operationId: listSpecialtyLinkedCareProfessionals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/careProfessionals/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SpecialtyApiService
      operationId: getSpecialtyLinkedCareProfessionals
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/clinicTypes:
    get:
      tags:
      - SpecialtyApiService
      operationId: listSpecialtyLinkedClinicTypes
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListClinicTypeResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/clinicTypes/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SpecialtyApiService
      operationId: getSpecialtyLinkedClinicTypes
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/clinicType"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/diagnosticsWaitlistEntries
  : get:
      tags:
      - SpecialtyApiService
      operationId: listSpecialtyLinkedDiagnosticsWaitlistEntries
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListDiagnosticsWaitlistEntryResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/diagnosticsWaitlistEntries/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SpecialtyApiService
      operationId: getSpecialtyLinkedDiagnosticsWaitlistEntries
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/diagnosticsWaitlistEntry"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/encounters:
    get:
      tags:
      - SpecialtyApiService
      operationId: listSpecialtyLinkedEncounters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEncounterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/encounters/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SpecialtyApiService
      operationId: getSpecialtyLinkedEncounters
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/encounter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/ersServices:
    get:
      tags:
      - SpecialtyApiService
      operationId: listSpecialtyLinkedErsServices
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListErsServiceResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/ersServices/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SpecialtyApiService
      operationId: getSpecialtyLinkedErsServices
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ersService"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/outpatientActivities:
    get:
      tags:
      - SpecialtyApiService
      operationId: listSpecialtyLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListOutpatientActivityResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/outpatientActivities/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SpecialtyApiService
      operationId: getSpecialtyLinkedOutpatientActivities
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/outpatientActivity"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/patientPathways:
    get:
      tags:
      - SpecialtyApiService
      operationId: listSpecialtyLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientPathwayResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/patientPathways/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SpecialtyApiService
      operationId: getSpecialtyLinkedPatientPathways
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patientPathway"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/theatreSessions:
    get:
      tags:
      - SpecialtyApiService
      operationId: listSpecialtyLinkedTheatreSessions
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/specialty/{primaryKey}/links/theatreSessions/{linkedObjectPrimaryKey}
  : get:
      tags:
      - SpecialtyApiService
      operationId: getSpecialtyLinkedTheatreSessions
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/SpecialtyProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreSession"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/staffUnavailability:
    get:
      tags:
      - StaffUnavailabilityApiService
      operationId: listStaffUnavailability
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/StaffUnavailabilityProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListStaffUnavailabilityResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/staffUnavailability/aggregate:
    post:
      tags:
      - StaffUnavailabilityApiService
      operationId: computeStaffUnavailabilityAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/staffUnavailability/count:
    post:
      tags:
      - StaffUnavailabilityApiService
      operationId: computeStaffUnavailabilityCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/staffUnavailability/search:
    post:
      tags:
      - StaffUnavailabilityApiService
      operationId: searchStaffUnavailability
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchStaffUnavailabilityResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/staffUnavailability/{primaryKey}:
    get:
      tags:
      - StaffUnavailabilityApiService
      operationId: getStaffUnavailability
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/StaffUnavailabilityProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/StaffUnavailability"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/staffUnavailability/{primaryKey}/links/careProfessional
  : get:
      tags:
      - StaffUnavailabilityApiService
      operationId: listStaffUnavailabilityLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/StaffUnavailabilityProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/staffUnavailability/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey}
  : get:
      tags:
      - StaffUnavailabilityApiService
      operationId: getStaffUnavailabilityLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/StaffUnavailabilityProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/testResult:
    get:
      tags:
      - TestResultApiService
      operationId: listTestResult
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TestResultProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTestResultResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/testResult/aggregate:
    post:
      tags:
      - TestResultApiService
      operationId: computeTestResultAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/testResult/count:
    post:
      tags:
      - TestResultApiService
      operationId: computeTestResultCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/testResult/search:
    post:
      tags:
      - TestResultApiService
      operationId: searchTestResult
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchTestResultResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/testResult/{primaryKey}:
    get:
      tags:
      - TestResultApiService
      operationId: getTestResult
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TestResultProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TestResult"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/testResult/{primaryKey}/links/patient:
    get:
      tags:
      - TestResultApiService
      operationId: listTestResultLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TestResultProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/testResult/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TestResultApiService
      operationId: getTestResultLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TestResultProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking:
    get:
      tags:
      - TheatreBookingApiService
      operationId: listTheatreBooking
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreBookingResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/aggregate:
    post:
      tags:
      - TheatreBookingApiService
      operationId: computeTheatreBookingAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/count:
    post:
      tags:
      - TheatreBookingApiService
      operationId: computeTheatreBookingCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/search:
    post:
      tags:
      - TheatreBookingApiService
      operationId: searchTheatreBooking
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchTheatreBookingResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}:
    get:
      tags:
      - TheatreBookingApiService
      operationId: getTheatreBooking
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TheatreBooking"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/careProfessional:
    get:
      tags:
      - TheatreBookingApiService
      operationId: listTheatreBookingLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreBookingApiService
      operationId: getTheatreBookingLinkedCareProfessional
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/ealEntry:
    get:
      tags:
      - TheatreBookingApiService
      operationId: listTheatreBookingLinkedEalEntry
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEalEntryResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/ealEntry/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreBookingApiService
      operationId: getTheatreBookingLinkedEalEntry
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ealEntry"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/encounter:
    get:
      tags:
      - TheatreBookingApiService
      operationId: listTheatreBookingLinkedEncounter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEncounterResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreBookingApiService
      operationId: getTheatreBookingLinkedEncounter
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/encounter"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/patient:
    get:
      tags:
      - TheatreBookingApiService
      operationId: listTheatreBookingLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPatientResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/patient/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreBookingApiService
      operationId: getTheatreBookingLinkedPatient
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/patient"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/primaryProcedure:
    get:
      tags:
      - TheatreBookingApiService
      operationId: listTheatreBookingLinkedPrimaryProcedure
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/primaryProcedure/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreBookingApiService
      operationId: getTheatreBookingLinkedPrimaryProcedure
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedure"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/procedureStatuses:
    get:
      tags:
      - TheatreBookingApiService
      operationId: listTheatreBookingLinkedProcedureStatuses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureStatusResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/procedureStatuses/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreBookingApiService
      operationId: getTheatreBookingLinkedProcedureStatuses
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedureStatus"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/theatreSession:
    get:
      tags:
      - TheatreBookingApiService
      operationId: listTheatreBookingLinkedTheatreSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreSessionResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreBooking/{primaryKey}/links/theatreSession/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreBookingApiService
      operationId: getTheatreBookingLinkedTheatreSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBookingProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreSession"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreSession:
    get:
      tags:
      - TheatreSessionApiService
      operationId: listTheatreSession
      parameters:
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreSessionResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreSession/aggregate:
    post:
      tags:
      - TheatreSessionApiService
      operationId: computeTheatreSessionAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AggregateObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AggregateObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreSession/count:
    post:
      tags:
      - TheatreSessionApiService
      operationId: computeTheatreSessionCount
      parameters: []
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountObjectsResponseV2"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreSession/search:
    post:
      tags:
      - TheatreSessionApiService
      operationId: searchTheatreSession
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SearchObjectsRequestV2"
        required: true
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchTheatreSessionResponse"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}:
    get:
      tags:
      - TheatreSessionApiService
      operationId: getTheatreSession
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TheatreSession"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/careProfessionalAllAnaesthetists
  : get:
      tags:
      - TheatreSessionApiService
      operationId: listTheatreSessionLinkedCareProfessionalAllAnaesthetists
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/careProfessionalAllAnaesthetists/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreSessionApiService
      operationId: getTheatreSessionLinkedCareProfessionalAllAnaesthetists
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/careProfessionalAnaesthetist
  : get:
      tags:
      - TheatreSessionApiService
      operationId: listTheatreSessionLinkedCareProfessionalAnaesthetist
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/careProfessionalAnaesthetist/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreSessionApiService
      operationId: getTheatreSessionLinkedCareProfessionalAnaesthetist
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/careProfessionalConsultant
  : get:
      tags:
      - TheatreSessionApiService
      operationId: listTheatreSessionLinkedCareProfessionalConsultant
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/careProfessionalConsultant/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreSessionApiService
      operationId: getTheatreSessionLinkedCareProfessionalConsultant
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/careProfessionalsAllConsultants
  : get:
      tags:
      - TheatreSessionApiService
      operationId: listTheatreSessionLinkedCareProfessionalsAllConsultants
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCareProfessionalResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/careProfessionalsAllConsultants/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreSessionApiService
      operationId: getTheatreSessionLinkedCareProfessionalsAllConsultants
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/careProfessional"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/procedures:
    get:
      tags:
      - TheatreSessionApiService
      operationId: listTheatreSessionLinkedProcedures
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProcedureResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/procedures/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreSessionApiService
      operationId: getTheatreSessionLinkedProcedures
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/procedure"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/specialty:
    get:
      tags:
      - TheatreSessionApiService
      operationId: listTheatreSessionLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListSpecialtyResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreSessionApiService
      operationId: getTheatreSessionLinkedSpecialty
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/specialty"
      security:
      - BearerAuth: []
  /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/theatreBookings:
    get:
      tags:
      - TheatreSessionApiService
      operationId: listTheatreSessionLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |
          The desired size of the page to be returned. Defaults to 1,000.
          See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.
        required: false
        schema:
          type: integer
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: orderBy
        in: query
        required: false
        schema:
          type: string
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTheatreBookingResponse"
      security:
      - BearerAuth: []
  ? /api/v2/ontologies/solution-exchange/objects/theatreSession/{primaryKey}/links/theatreBookings/{linkedObjectPrimaryKey}
  : get:
      tags:
      - TheatreSessionApiService
      operationId: getTheatreSessionLinkedTheatreBookings
      parameters:
      - name: primaryKey
        in: path
        required: true
        schema:
          type: string
      - name: linkedObjectPrimaryKey
        in: path
        required: true
        schema:
          type: string
      - name: select
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSessionProperties"
      - name: excludeRid
        in: query
        description: "A flag to exclude the retrieval of the `__rid` property. \n\
          Setting this to true may improve performance of this endpoint for object\
          \ types in OSV2.\n"
        required: false
        schema:
          type: boolean
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/theatreBooking"
      security:
      - BearerAuth: []
components:
  schemas:
    Admission:
      required:
      - __apiName
      - __primaryKey
      - admissionId
      - admissionMethod
      - admissionStatus
      - admissionTimestamp
      - admissionTitle
      - admissionType
      - dischargeDestinationType
      - dischargePathway
      - dischargeTimestamp
      - encounterId
      - estimatedDischargeDate
      - isDischargeTimeConfirmed
      - localAuthority
      - patientId
      - patientName
      - siteName
      - specialtyId
      - specialtyName
      - ward
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        admissionId:
          type: string
          description: A unique key for the admission
        admissionMethod:
          type: string
          description: Descriptive column for how the patient was admitted to hospital
            https://www.datadictionary.nhs.uk/attributes/admission_source.html
        admissionStatus:
          type: string
          description: Latest status of the admission
        admissionTimestamp:
          type: string
          description: Timestamp of admission
          format: date-time
        admissionTitle:
          type: string
          description: "Title, Patient Name: Date of Birth"
        admissionType:
          type: string
          description: "Admission type, e.g. inpatient, daycase, outpatient"
        dischargeDestinationType:
          type: string
          description: Type of discharge destination https://www.datadictionary.nhs.uk/data_elements/planned_destination_of_discharge__hospital_provider_spell_.html
        dischargePathway:
          type: string
          description: "Discharge pathway: https://www.nhs.uk/nhsengland/keogh-review/documents/quick-guides/quick-guide-discharge-to-access.pdf"
        dischargeTimestamp:
          type: string
          description: Timetamp of patient discharge from hospital
          format: date-time
        encounterId:
          type: string
          description: Encounter
        estimatedDischargeDate:
          type: string
          description: Estimated timestamp of discharge
          format: date-time
        isDischargeTimeConfirmed:
          type: boolean
          description: Patient has confirmed discharge time
        localAuthority:
          type: string
          description: The local authority responsible for the patient
        patientId:
          type: string
          description: Patient
        patientName:
          type: string
          description: Name of patient
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        siteName:
          type: string
          description: The latest hospital site to which patient was admitted
        specialtyId:
          type: string
          description: Specialty
        specialtyName:
          type: string
          description: Specialty name
        ward:
          type: string
          description: The latest ward to which patient was admitted
      description: "All admissions both past and current of patients into hospital.\
        \ The minimum scope of admissions should be those that relate to current or\
        \ past inpatient spells requiring discharge: https://www.datadictionary.nhs.uk/nhs_business_definitions/hospital_provider_spell.html"
    AdmissionProperties:
      type: string
      enum:
      - isDischargeTimeConfirmed
      - patientName
      - patientId
      - dischargeTimestamp
      - estimatedDischargeDate
      - admissionTitle
      - rvGroupIds
      - siteName
      - specialtyId
      - dischargePathway
      - specialtyName
      - dischargeDestinationType
      - encounterId
      - admissionId
      - admissionType
      - admissionTimestamp
      - admissionMethod
      - ward
      - admissionStatus
      - localAuthority
    AggregateObjectsRequestV2:
      type: object
      properties:
        accuracy:
          $ref: "#/components/schemas/AggregationAccuracyRequest"
        aggregation:
          type: array
          items:
            $ref: "#/components/schemas/AggregationV2"
        groupBy:
          type: array
          items:
            $ref: "#/components/schemas/AggregationGroupByV2"
        where:
          $ref: "#/components/schemas/SearchJsonQueryV2"
    AggregateObjectsResponseItemV2:
      type: object
      properties:
        group:
          type: object
          additionalProperties: {}
        metrics:
          type: array
          items:
            $ref: "#/components/schemas/AggregationMetricResultV2"
    AggregateObjectsResponseV2:
      required:
      - accuracy
      type: object
      properties:
        accuracy:
          $ref: "#/components/schemas/AggregationAccuracy"
        data:
          type: array
          items:
            $ref: "#/components/schemas/AggregateObjectsResponseItemV2"
        excludedItems:
          type: integer
    AggregationAccuracy:
      type: string
      enum:
      - ACCURATE
      - APPROXIMATE
    AggregationAccuracyRequest:
      type: string
      enum:
      - REQUIRE_ACCURATE
      - ALLOW_APPROXIMATE
    AggregationDurationGroupingV2:
      required:
      - field
      - type
      - unit
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        unit:
          $ref: "#/components/schemas/TimeUnit"
        value:
          type: integer
      description: |
        Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.
        When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`.
    AggregationExactGroupingV2:
      required:
      - field
      - type
      type: object
      properties:
        field:
          type: string
        maxGroupCount:
          type: integer
        type:
          type: string
      description: Divides objects into groups according to an exact value.
    AggregationFixedWidthGroupingV2:
      required:
      - field
      - fixedWidth
      - type
      type: object
      properties:
        field:
          type: string
        fixedWidth:
          type: integer
        type:
          type: string
      description: Divides objects into groups with the specified width.
    AggregationGroupByV2:
      description: Specifies a grouping for aggregation results.
      discriminator:
        propertyName: type
        mapping:
          duration: "#/components/schemas/AggregationDurationGroupingV2"
          exact: "#/components/schemas/AggregationExactGroupingV2"
          fixedWidth: "#/components/schemas/AggregationFixedWidthGroupingV2"
          ranges: "#/components/schemas/AggregationRangesGroupingV2"
      oneOf:
      - $ref: "#/components/schemas/AggregationFixedWidthGroupingV2"
      - $ref: "#/components/schemas/AggregationRangesGroupingV2"
      - $ref: "#/components/schemas/AggregationExactGroupingV2"
      - $ref: "#/components/schemas/AggregationDurationGroupingV2"
    AggregationMetricResultV2:
      required:
      - name
      type: object
      properties:
        name:
          type: string
        value:
          description: |
            The value of the metric. This will be a double in the case of
            a numeric metric, or a date string in the case of a date metric.
    AggregationRangeV2:
      required:
      - endValue
      - startValue
      type: object
      properties:
        endValue:
          description: Exclusive end.
        startValue:
          description: Inclusive start.
      description: Specifies a range from an inclusive start value to an exclusive
        end value.
    AggregationRangesGroupingV2:
      required:
      - field
      - type
      type: object
      properties:
        field:
          type: string
        ranges:
          type: array
          items:
            $ref: "#/components/schemas/AggregationRangeV2"
        type:
          type: string
      description: Divides objects into groups according to specified ranges.
    AggregationV2:
      description: Specifies an aggregation function.
      discriminator:
        propertyName: type
        mapping:
          approximateDistinct: "#/components/schemas/ApproximateDistinctAggregationV2"
          approximatePercentile: "#/components/schemas/ApproximatePercentileAggregationV2"
          avg: "#/components/schemas/AvgAggregationV2"
          count: "#/components/schemas/CountAggregationV2"
          max: "#/components/schemas/MaxAggregationV2"
          min: "#/components/schemas/MinAggregationV2"
          sum: "#/components/schemas/SumAggregationV2"
      oneOf:
      - $ref: "#/components/schemas/MaxAggregationV2"
      - $ref: "#/components/schemas/MinAggregationV2"
      - $ref: "#/components/schemas/AvgAggregationV2"
      - $ref: "#/components/schemas/SumAggregationV2"
      - $ref: "#/components/schemas/CountAggregationV2"
      - $ref: "#/components/schemas/ApproximateDistinctAggregationV2"
      - $ref: "#/components/schemas/ApproximatePercentileAggregationV2"
    AndQueryV2:
      required:
      - type
      type: object
      properties:
        type:
          type: string
        value:
          type: array
          items:
            $ref: "#/components/schemas/SearchJsonQueryV2"
      description: Returns objects where every query is satisfied.
    Appointment:
      required:
      - __apiName
      - __primaryKey
      - appointmentFreeText
      - attendanceId
      - bookedBy
      - bookedDuration
      - bookingStatus
      - cancellationReason
      - category
      - clinicId
      - code
      - dateTimeBooked
      - dateTimeCancelled
      - endDateTime
      - isFirstAppointment
      - isPoaAppointment
      - patientId
      - poaOutcome
      - priority
      - referralId
      - rttPathwayStatus
      - rttPeriodEndDate
      - rttPeriodLength
      - rttPeriodStartDate
      - specialtyId
      - specialtyName
      - startDateTime
      - treatmentFunctionCode
      - treatmentFunctionName
      - type
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        appointmentFreeText:
          type: string
          description: Operational-only free-text column for notes contained in the
            PAS which operational users sometimes rely on
        attendanceId:
          type: string
          description: ID for the appointment
        bookedBy:
          type: string
          description: Source system ID of the user who booked the appointment
        bookedDuration:
          type: integer
          description: "The duration booked for the appointment (minutes): https://www.datadictionary.nhs.uk/data_elements/expected_duration_of_appointment.html"
        bookingStatus:
          type: string
          description: "The booking status for the appointment (e.g. Attended, Cancelled)"
        cancellationReason:
          type: string
          description: "Reason for appointment cancellation (e.g. Hospital cancelled,\
            \ Patient Cancelled)"
        category:
          type: string
          description: "The category of outpatient appointment. This can indicate\
            \ whether the appointment is a consultation or for clinical testing (e.g.\
            \ Consult, Lab)"
        clinicId:
          type: string
          description: The specific outpatient clinic session that the appointment
            is booked in for. This can be undefined for pre-operative assessment appointments
        code:
          type: string
          description: "The clinic, resource or group code for the appointment. This\
            \ should be the code used to match the appointment to a specific slot\
            \ type in a clinic."
        dateTimeBooked:
          type: string
          description: "Date and time the appointment was booked: https://www.datadictionary.nhs.uk/attributes/service_request_date.html"
          format: date-time
        dateTimeCancelled:
          type: string
          description: "Date and time the appointment was cancelled: https://www.datadictionary.nhs.uk/attributes/appointment_cancelled_date.html"
          format: date-time
        endDateTime:
          type: string
          description: Appointment end date and time
          format: date-time
        isFirstAppointment:
          type: boolean
          description: '`true` if this is the first appointment in the pathway. `false`
            if this is a follow-up appointment:\ https://www.datadictionary.nhs.uk/attributes/appointment_first_attendance.html'
        isPoaAppointment:
          type: boolean
          description: '`True` if the appointment is a pre-operative assessment'
        patientId:
          type: string
          description: The patient the appointment is scheduled for
        poaOutcome:
          type: string
          description: "Outcome for all appointments: https://www.datadictionary.nhs.uk/attributes/outcome_of_attendance.html"
        priority:
          type: string
          description: "The priority of the appointment: https://www.datadictionary.nhs.uk/attributes/priority_type.html\
            \ (e.g. Urgent, Routine)"
        referralId:
          type: string
          description: ID of the linked referral
        rttPathwayStatus:
          type: string
          description: Is on active RTT pathway
        rttPeriodEndDate:
          type: string
          description: Date of RTT clock stop
          format: date
        rttPeriodLength:
          type: integer
          description: RTT period length (days)
        rttPeriodStartDate:
          type: string
          description: Date of RTT clock start
          format: date
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        specialtyId:
          type: string
          description: The specialty ID related to the appointment
        specialtyName:
          type: string
          description: The specialty related to the appointment
        startDateTime:
          type: string
          description: "Appointment start date and time: https://www.datadictionary.nhs.uk/data_elements/appointment_date_and_time.html"
          format: date-time
        treatmentFunctionCode:
          type: string
          description: A unique identifier for the treatment function. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html
        treatmentFunctionName:
          type: string
          description: The corresponding name of the treatment function. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html
        type:
          type: string
          description: "The type of the appointment (e.g. New, F/Up, Telephone F/Up)"
      description: "An Appointment for a patient to be seen by a care professional:\
        \ https://www.datadictionary.nhs.uk/classes/appointment.html. The minimum\
        \ scope of appointments should be those that relate to inpatient bookings\
        \ (pre-operative assessments) as well as those which relate to future or past\
        \ outpatient clinic sessions."
    AppointmentProperties:
      type: string
      enum:
      - priority
      - treatmentFunctionCode
      - dateTimeCancelled
      - endDateTime
      - rvGroupIds
      - cancellationReason
      - bookedDuration
      - rttPathwayStatus
      - specialtyId
      - rttPeriodEndDate
      - isFirstAppointment
      - rttPeriodLength
      - bookedBy
      - patientId
      - code
      - attendanceId
      - bookingStatus
      - treatmentFunctionName
      - category
      - type
      - rttPeriodStartDate
      - appointmentFreeText
      - clinicId
      - specialtyName
      - poaOutcome
      - startDateTime
      - isPoaAppointment
      - dateTimeBooked
      - referralId
    ApproximateDistinctAggregationV2:
      required:
      - field
      - type
      type: object
      properties:
        direction:
          $ref: "#/components/schemas/OrderByDirection"
        field:
          type: string
        name:
          type: string
        type:
          type: string
      description: Computes an approximate number of distinct values for the provided
        field.
    ApproximatePercentileAggregationV2:
      required:
      - approximatePercentile
      - field
      - type
      type: object
      properties:
        approximatePercentile:
          type: number
          format: double
        direction:
          $ref: "#/components/schemas/OrderByDirection"
        field:
          type: string
        name:
          type: string
        type:
          type: string
      description: Computes the approximate percentile value for the provided field.
    AvgAggregationV2:
      required:
      - field
      - type
      type: object
      properties:
        direction:
          $ref: "#/components/schemas/OrderByDirection"
        field:
          type: string
        name:
          type: string
        type:
          type: string
      description: Computes the average value for the provided field.
    BBox:
      type: array
      description: |
        A GeoJSON object MAY have a member named "bbox" to include
        information on the coordinate range for its Geometries, Features, or
        FeatureCollections. The value of the bbox member MUST be an array of
        length 2*n where n is the number of dimensions represented in the
        contained geometries, with all axes of the most southwesterly point
        followed by all axes of the more northeasterly point. The axes order
        of a bbox follows the axes order of geometries.
      items:
        type: number
        format: double
    BoundingBoxValue:
      required:
      - bottomRight
      - topLeft
      type: object
      properties:
        bottomRight:
          $ref: "#/components/schemas/WithinBoundingBoxPoint"
        topLeft:
          $ref: "#/components/schemas/WithinBoundingBoxPoint"
      description: |
        The top left and bottom right coordinate points that make up the bounding box.
    CareProfessional:
      required:
      - __apiName
      - __primaryKey
      - careProfessionalId
      - careProfessionalLocalId
      - isActive
      - name
      - role
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        careProfessionalId:
          type: string
          description: ID for the Care Professional
        careProfessionalLocalId:
          type: string
          description: "Trust local identifier for the care professional, e.g. a GMC\
            \ number"
        isActive:
          type: boolean
          description: '`True` if the Care Professional is currently employed by trust.  Past
            employees are required for completeness within the dataset'
        localSubSpecialties:
          type: array
          description: list of specialty IDs the care professional is responsible
            for
          items:
            type: string
        name:
          type: string
          description: "Care Professional name (Last Name, First Name)"
        role:
          type: string
          description: "Care Professional role allowed values are \"Consultant\",\
            \ \"Anaesthetist\", \"Scrub\", \"ODP\", \"Nurse\" and \"Other\""
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
      description: "Care professionals employed by the trust. This should include\
        \ consultants and anaesthetists at a minimum, but can include all staff members:\
        \ https://www.datadictionary.nhs.uk/classes/care_professional.html. Care professional\
        \ information is used to filter waiting list, theatre and clinic data by the\
        \ primary responsible consultant, as well as viewing which staff members are\
        \ assigned to specific theatre sessions and clinics"
    CareProfessionalProperties:
      type: string
      enum:
      - careProfessionalLocalId
      - role
      - localSubSpecialties
      - name
      - careProfessionalId
      - rvGroupIds
      - isActive
    CenterPoint:
      required:
      - center
      - distance
      type: object
      properties:
        center:
          $ref: "#/components/schemas/CenterPointTypes"
        distance:
          $ref: "#/components/schemas/Distance"
      description: |
        The coordinate point to use as the center of the distance query.
    CenterPointTypes:
      discriminator:
        propertyName: type
        mapping:
          Point: "#/components/schemas/GeoPoint"
      oneOf:
      - $ref: "#/components/schemas/GeoPoint"
    ClinicLetter:
      required:
      - __apiName
      - __primaryKey
      - appointmentId
      - clinicLetterDate
      - clinicLetterId
      - clinicLetterType
      - consultantId
      - patientId
      - specialtyName
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        appointmentId:
          type: string
          description: Appointment the letter relates to
        clinicLetterDate:
          type: string
          description: Timestamp the clinic letter was written
          format: date-time
        clinicLetterId:
          type: string
          description: Unique identifier for the clinic letter
        clinicLetterType:
          type: string
          description: Type of clinic letter
        consultantId:
          type: string
          description: Consultant who wrote the letter
        patientId:
          type: string
          description: Patient the letter relates to
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        specialtyName:
          type: string
          description: Specialty for the linked appointment
      description: "Dataset containing metadata, including clinic letter dates, for\
        \ validation teams to identify new letters summarizing patient appointments,\
        \ diagnoses, treatment decisions, and next steps."
    ClinicLetterProperties:
      type: string
      enum:
      - appointmentId
      - clinicLetterType
      - patientId
      - specialtyName
      - clinicLetterDate
      - clinicLetterId
      - rvGroupIds
      - consultantId
    ClinicSession:
      required:
      - __apiName
      - __primaryKey
      - amPm
      - bookingTeam
      - careProfessionalId
      - clinicCode
      - clinicEndTimestamp
      - clinicFreeText
      - clinicId
      - clinicName
      - clinicStartTimestamp
      - clinicTypeActive
      - clinicTypeId
      - clinicTypeName
      - hasAnnualLeave
      - hasAnnualLeaveString
      - isCancelled
      - isPrivate
      - location
      - overbooked
      - roomId
      - siteId
      - siteName
      - specialtyId
      - startDayOfWeek
      - status
      - statusReason
      - totalBookedDuration
      - totalBookedSlots
      - totalDuration
      - totalSlots
      - totalVacantSlotDuration
      - totalVacantSlots
      - totalVacantSlotsFollowup
      - totalVacantSlotsNew
      - type
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        amPm:
          type: string
          description: Signifies whether the clinic is morning/afternoon/all day
        bookingTeam:
          type: string
          description: "Type of team booking for this clinic e.g., centralised, de-centralised,\
            \ partial for the clinic"
        careProfessionalId:
          type: string
          description: Care professional holding the clinic session
        clinicCode:
          type: string
          description: Clinic/resource code for the clinic. This should match the
            appointment code.
        clinicEndTimestamp:
          type: string
          description: Date and time of the clinic session end
          format: date-time
        clinicFreeText:
          type: string
          description: Optional data field to denote operational-only clinic requirements
            for the clinic
        clinicId:
          type: string
          description: ID for the clinic session
        clinicName:
          type: string
          description: "Name of the clinic (e.g. DOCTOR, D1)"
        clinicStartTimestamp:
          type: string
          description: "Date and time of the clinic session start: https://www.datadictionary.nhs.uk/attributes/session_date.html"
          format: date-time
        clinicTypeActive:
          type: boolean
          description: Defines if clinic type should be available for booking of appointments.
        clinicTypeId:
          type: string
          description: Unique identifier of clinic type
        clinicTypeName:
          type: string
          description: Name of the clinic type
        hasAnnualLeave:
          type: boolean
          description: '`True` if the care professional holding the clinic session
            has an annual leave event during the session'
        hasAnnualLeaveString:
          type: string
          description: Stringified version of the has_annual_leave column
        isCancelled:
          type: boolean
          description: '`True` if the clinic session has been cancelled'
        isPrivate:
          type: boolean
          description: '`True` if clinic is for private patients'
        location:
          type: string
          description: "The physical location the clinic takes place in: https://www.datadictionary.nhs.uk/classes/location.html\
            \ (e.g. LGF, Gate 3)"
        overbooked:
          type: boolean
          description: '`True` if clinic is overbooked'
        roomId:
          type: string
          description: the clinic room ID the session is held in
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        siteId:
          type: string
          description: "The Hospital site ID: https://www.datadictionary.nhs.uk/nhs_business_definitions/hospital_site.html?hl=hospital%2Csite"
        siteName:
          type: string
          description: Hospital site at which the activity will take place
        slotSpecialtyIds:
          type: array
          description: Aggregation of all relevant specialties for a given clinic
            based on slot data
          items:
            type: string
        specialtyId:
          type: string
          description: Primary Specialty of the clinic
        startDayOfWeek:
          type: string
          description: "Clinic start day of week (e.g. Monday, Tuesday)"
        status:
          type: string
          description: "The latest activity status of the clinic (e.g. Active, On\
            \ hold, Cancelled)."
        statusReason:
          type: string
          description: "Optional data field to provide additional operational context\
            \ around the latest status of the clinic (e.g., hold reason, cancellation\
            \ reason)"
        totalBookedDuration:
          type: integer
          description: Total booked duration (minutes)
        totalBookedSlots:
          type: integer
          description: Total number of booked appointment slots in the clinic session
        totalDuration:
          type: integer
          description: Total clinic duration (minutes)
        totalSlots:
          type: integer
          description: "Total number of active appointment slots available in the\
            \ clinic session (e.g., the slot is not on hold or cancelled)"
        totalVacantSlotDuration:
          type: integer
          description: Total unbooked duration (minutes)
        totalVacantSlots:
          type: integer
          description: Total number of vacant appointment slots in the clinic session.
            This should equal the sum of vacant new and follow-up slots. Can be derived
            if vacant new/follow-up slot data is available
        totalVacantSlotsFollowup:
          type: integer
          description: Total number of vacant appointment slots for follow-up appointments
            in the clinic session
        totalVacantSlotsNew:
          type: integer
          description: Total number of vacant appointment slots for new appointments
            in the clinic session
        treatmentFunctionCodes:
          type: array
          description: A unique identifier for the treatment function. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html
          items:
            type: string
        treatmentFunctionNames:
          type: array
          description: The corresponding name of the treatment function. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html
          items:
            type: string
        type:
          type: string
          description: "The type of clinic e.g. pre-op, face-to-face"
      description: "Consultant clinic sessions: https://www.datadictionary.nhs.uk/nhs_business_definitions/consultant_clinic_session.html\
        \ The minimum scope of clinic sessions should be those that relate to outpatient\
        \ clinics"
    ClinicSessionProperties:
      type: string
      enum:
      - isCancelled
      - status
      - totalDuration
      - location
      - rvGroupIds
      - clinicFreeText
      - clinicCode
      - totalVacantSlots
      - clinicEndTimestamp
      - overbooked
      - specialtyId
      - startDayOfWeek
      - totalVacantSlotsFollowup
      - siteId
      - bookingTeam
      - clinicTypeName
      - amPm
      - totalVacantSlotsNew
      - clinicTypeActive
      - roomId
      - hasAnnualLeave
      - slotSpecialtyIds
      - totalBookedSlots
      - treatmentFunctionCodes
      - type
      - careProfessionalId
      - siteName
      - isPrivate
      - clinicId
      - clinicStartTimestamp
      - clinicName
      - treatmentFunctionNames
      - totalBookedDuration
      - clinicTypeId
      - totalVacantSlotDuration
      - statusReason
      - totalSlots
      - hasAnnualLeaveString
    ClinicSlot:
      required:
      - __apiName
      - __primaryKey
      - activityPriority
      - activityType
      - amPm
      - appointmentId
      - careProfessionalId
      - clinicId
      - comment
      - description
      - endTime
      - locationDescription
      - resourceCode
      - sessionType
      - siteId
      - siteName
      - slotDate
      - slotDuration
      - slotId
      - slotType
      - startTime
      - status
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        activityPriority:
          type: string
        activityType:
          type: string
        amPm:
          type: string
        appointmentId:
          type: string
        careProfessionalId:
          type: string
        clinicId:
          type: string
        comment:
          type: string
        description:
          type: string
        endTime:
          type: string
          format: date-time
        locationDescription:
          type: string
        resourceCode:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        serviceIds:
          type: array
          items:
            type: string
        sessionType:
          type: string
        siteId:
          type: string
        siteName:
          type: string
        slotDate:
          type: string
          format: date
        slotDuration:
          type: integer
        slotId:
          type: string
        slotType:
          type: string
        startTime:
          type: string
          format: date-time
        status:
          type: string
      description: 'https://www.datadictionary.nhs.uk/nhs_business_definitions/consultant_clinic_session.html    The
        minimum scope of slot should be those that relate to outpatient clinic sessions.
        It should be considered as a period of time within a session for one or more
        appointments with a Consultant. '
    ClinicSlotProperties:
      type: string
      enum:
      - slotType
      - slotDate
      - status
      - careProfessionalId
      - rvGroupIds
      - activityPriority
      - siteName
      - clinicId
      - comment
      - startTime
      - locationDescription
      - appointmentId
      - resourceCode
      - slotDuration
      - activityType
      - slotId
      - description
      - sessionType
      - siteId
      - endTime
      - serviceIds
      - amPm
    ClinicType:
      required:
      - __apiName
      - __primaryKey
      - clinicTypeActive
      - clinicTypeName
      - specialtyId
      - uniqueId
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        clinicTypeActive:
          type: boolean
          description: Defines if this type of clinic is active and available for
            signposting and booking of patients.
        clinicTypeName:
          type: string
          description: Name of the clinic type.
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        specialtyId:
          type: string
          description: ID of the specialty that runs clinic of this type.
        uniqueId:
          type: string
          description: Unique Identifier of the clinic type.
      description: Type of outpatient clinic.
    ClinicTypeProperties:
      type: string
      enum:
      - clinicTypeActive
      - uniqueId
      - rvGroupIds
      - clinicTypeName
      - specialtyId
    ContainsAllTermsInOrderPrefixLastTerm:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          type: string
      description: "Returns objects where the specified field contains all of the\
        \ terms in the order provided, \nbut they do have to be adjacent to each other.\n\
        The last term can be a partial prefix match.\n"
    ContainsAllTermsInOrderQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          type: string
      description: |
        Returns objects where the specified field contains all of the terms in the order provided,
        but they do have to be adjacent to each other.
    ContainsAllTermsQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        fuzzy:
          type: boolean
        type:
          type: string
        value:
          type: string
      description: |
        Returns objects where the specified field contains all of the whitespace separated words in any
        order in the provided value. This query supports fuzzy matching.
    ContainsAnyTermQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        fuzzy:
          type: boolean
        type:
          type: string
        value:
          type: string
      description: "Returns objects where the specified field contains any of the\
        \ whitespace separated words in any \norder in the provided value. This query\
        \ supports fuzzy matching.\n"
    ContainsQueryV2:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value: {}
      description: Returns objects where the specified array contains a value.
    CountAggregationV2:
      required:
      - type
      type: object
      properties:
        direction:
          $ref: "#/components/schemas/OrderByDirection"
        name:
          type: string
        type:
          type: string
      description: Computes the total count of objects.
    CountObjectsResponseV2:
      type: object
      properties:
        count:
          type: integer
    Diagnosis:
      required:
      - __apiName
      - __primaryKey
      - active
      - diagnosisEndDate
      - diagnosisId
      - diagnosisName
      - diagnosisStartDate
      - encounterId
      - patientId
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        active:
          type: string
          description: This indicates whether the diagnosis is active or inactive.
        diagnosisEndDate:
          type: string
          description: Date when diagnosis was resolved/in remission. This can be
            `null` if the diagnosis is active.
          format: date
        diagnosisId:
          type: string
          description: ID for each diagnosis
        diagnosisName:
          type: string
          description: "Name of diagnosis (e.g. Thyrotoxicosis, Neurofibroma)"
        diagnosisStartDate:
          type: string
          description: Date when diagnosis became active or was coded
          format: date
        encounterId:
          type: string
          description: encounter ID at which the diagnosis was created as part of
        patientId:
          type: string
          description: patient ID for the subject of the diagnosis
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
      description: Contains patient diagnoses related to the in-scope outpatient activity.
        This is used to allow clinical teams to use diagnoses in patient decision-making
        and alerting
    DiagnosisProperties:
      type: string
      enum:
      - patientId
      - encounterId
      - rvGroupIds
      - active
      - diagnosisStartDate
      - diagnosisEndDate
      - diagnosisId
      - diagnosisName
    DiagnosticsWaitlistEntry:
      required:
      - __apiName
      - __primaryKey
      - addedToWaitlistTimestamp
      - diagnosticsDate
      - diagnosticsRequest
      - diagnosticsWaitlistId
      - pathwayId
      - patientId
      - priority
      - sixWeekBreachDate
      - specialtyId
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        addedToWaitlistTimestamp:
          type: string
          description: Timestamp of when the patient was added to the diagnostic waitlist.
          format: date-time
        diagnosticsDate:
          type: string
          description: Booking date of the diagnostics appointment. Remains null if
            the diagnostics appointment has not been booked yet.
          format: date
        diagnosticsRequest:
          type: string
          description: "The diagnostics request being made e.g. Blood Test, CT Scan,\
            \ etc."
        diagnosticsWaitlistId:
          type: string
          description: Primary key - ID for a diagnostic waitlist entry.
        pathwayId:
          type: string
          description: Foreign key to connect to pathway.
        patientId:
          type: string
          description: Foreign key to connect to patient.
        priority:
          type: string
          description: The priority of the diagnostics waitlist entry.
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        sixWeekBreachDate:
          type: string
          description: Date when the diagnostics waitlist entry will breach six weeks
            since it was added to the waitlist.
          format: date
        specialtyId:
          type: string
          description: Foreign key to connect to pathway.
      description: "Diagnostics Request Activity. This consists of diagnostics requests\
        \ made for patients, along with booking dates for those requests."
    DiagnosticsWaitlistEntryProperties:
      type: string
      enum:
      - pathwayId
      - patientId
      - priority
      - diagnosticsWaitlistId
      - rvGroupIds
      - sixWeekBreachDate
      - diagnosticsDate
      - addedToWaitlistTimestamp
      - diagnosticsRequest
      - specialtyId
    Distance:
      required:
      - unit
      - value
      type: object
      properties:
        unit:
          $ref: "#/components/schemas/DistanceUnit"
        value:
          type: number
          format: double
      description: A measurement of distance.
    DistanceUnit:
      type: string
      enum:
      - MILLIMETERS
      - CENTIMETERS
      - METERS
      - KILOMETERS
      - INCHES
      - FEET
      - YARDS
      - MILES
      - NAUTICAL_MILES
    DoesNotIntersectBoundingBoxQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          $ref: "#/components/schemas/BoundingBoxValue"
      description: |
        Returns objects where the specified field does not intersect the bounding box provided.
    DoesNotIntersectPolygonQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          $ref: "#/components/schemas/PolygonValue"
      description: |
        Returns objects where the specified field does not intersect the polygon provided.
    EalEntry:
      required:
      - __apiName
      - __primaryKey
      - dateOf18WeekRttBreach
      - dateOf52WeekRttBreach
      - daysSinceDecidedToAdmitDate
      - daysTo18WeekRttBreach
      - daysTo52WeekRttBreach
      - decidedToAdmitDate
      - ealId
      - episodeId
      - hasRttPathwayDescription
      - isRtt
      - lessThan10WeeksToRttBreach
      - lessThan10WeeksToRttBreachString
      - pathwayId
      - patientId
      - patientName
      - plannedDate
      - priorityType
      - removalDate
      - removalReason
      - removalReasonLocal
      - rttDaysPaused
      - rttPeriod104WeekBreachDate
      - rttPeriod78WeekBreachDate
      - rttPeriodDaysTo104WeekBreach
      - rttPeriodDaysTo78WeekBreach
      - rttPeriodEndDate
      - rttPeriodId
      - rttPeriodIs68WeekWaiter
      - rttPeriodIs68WeekWaiterString
      - rttPeriodIs94WeekWaiter
      - rttPeriodIs94WeekWaiterString
      - rttPeriodLength
      - rttPeriodStartDate
      - rttStatusCode
      - rttTimeBands
      - rttWeeksWaiting
      - title
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        dateOf18WeekRttBreach:
          type: string
          description: Date at which the patient will breach more than 18 weeks waiting
          format: date
        dateOf52WeekRttBreach:
          type: string
          description: Date at which the patient will breach more than 52 weeks waiting
          format: date
        daysSinceDecidedToAdmitDate:
          type: integer
          description: Days since decision to admit was made
        daysTo18WeekRttBreach:
          type: integer
          description: Days until 18 week wait breach date
        daysTo52WeekRttBreach:
          type: integer
          description: Days until 52 week wait breach date
        decidedToAdmitDate:
          type: string
          description: "Date when decision to admit was made: https://www.datadictionary.nhs.uk/attributes/original_decided_to_admit_date.html"
          format: date
        ealId:
          type: string
          description: ID which uniquely identifies each elective admission list entry
        episodeId:
          type: string
          description: Current RTT episode ID
        hasRttPathwayDescription:
          type: string
          description: "Status on RTT pathway (Active, Inactive, Non-RTT)"
        isRtt:
          type: boolean
          description: Defines if this is an active RTT pathway as per the rtt_pathway_status
        lessThan10WeeksToRttBreach:
          type: boolean
          description: "Has been waiting more than 42 weeks, so likely to breach"
        lessThan10WeeksToRttBreachString:
          type: string
          description: Stringified rtt_period_is_42_week_waiter
        pathwayId:
          type: string
          description: "RTT pathway ID: https://www.datadictionary.nhs.uk/classes/patient_pathway.html"
        patientId:
          type: string
          description: ID for the patient related to the elective admission list entry
        patientName:
          type: string
          description: "Patient name (Surname, First name). This column uses the full_name\
            \ value from the patient table, linked on patient_id"
        plannedDate:
          type: string
          description: Planned admission date
          format: date
        priorityType:
          type: string
          description: "Clinical priority of the entry (RCS or Urgent, Cancer, Routine).\
            \ This column uses the priority value from the encounters table, linked\
            \ on encounter_id"
        removalDate:
          type: string
          description: "Date removed from waiting list: https://www.datadictionary.nhs.uk/attributes/elective_admission_list_removal_date.html\
            \ This column uses the removal_date value from the encounters table, linked\
            \ on encounter_id"
          format: date
        removalReason:
          type: string
          description: "Code for reason removed from waiting list: https://www.datadictionary.nhs.uk/attributes/elective_admission_list_removal_reason.html\
            \ This column uses the removal_reason_code value from the encounters table,\
            \ linked on encounter_id"
        removalReasonLocal:
          type: string
          description: "Description of reason removed from waiting list: https://www.datadictionary.nhs.uk/attributes/elective_admission_list_removal_reason.html\
            \ This column uses the removal_reason value from the encounters table,\
            \ linked on encounter_id"
        rttDaysPaused:
          type: integer
          description: Number of days for which the RTT clock has been paused
        rttPeriod104WeekBreachDate:
          type: string
          description: Date at which the patient will breach more than 104 weeks waiting
          format: date
        rttPeriod78WeekBreachDate:
          type: string
          description: Date at which the patient will breach more than 78 weeks waiting
          format: date
        rttPeriodDaysTo104WeekBreach:
          type: integer
          description: Number of days until patient breaches 104 weeks waiting
        rttPeriodDaysTo78WeekBreach:
          type: integer
          description: Number of days until patient breaches 78 weeks waiting
        rttPeriodEndDate:
          type: string
          description: "Clock stop date of most recent RTT period: https://www.datadictionary.nhs.uk/attributes/referral_to_treatment_period_end_date.html"
          format: date
        rttPeriodId:
          type: string
          description: "RTT period ID: https://www.datadictionary.nhs.uk/classes/referral_to_treatment_period.html"
        rttPeriodIs68WeekWaiter:
          type: boolean
          description: '`true` if patient has been waiting for more than 68 weeks'
        rttPeriodIs68WeekWaiterString:
          type: string
          description: Stringified version of if patient has been waiting for more
            than 68 weeks
        rttPeriodIs94WeekWaiter:
          type: boolean
          description: '`true` if patient has been waiting for more than 94 weeks'
        rttPeriodIs94WeekWaiterString:
          type: string
          description: Stringified version of if patient has been waiting for more
            than 94 weeks
        rttPeriodLength:
          type: integer
          description: "Difference in days between coalesce(rtt_period_end_date, current_date)\
            \ and rtt_period_start_date, minus any paused time. None if either rtt_period_start_date\
            \ or rtt_days_paused is None."
        rttPeriodStartDate:
          type: string
          description: "Clock start date of current RTT period: https://www.datadictionary.nhs.uk/attributes/referral_to_treatment_period_start_date.html"
          format: date
        rttStatusCode:
          type: string
          description: RTT status code https://www.datadictionary.nhs.uk/attributes/referral_to_treatment_period_status.html
        rttTimeBands:
          type: string
          description: "Banded version of rtt_period_weeks_waiting, e.g. 00-06WW"
        rttWeeksWaiting:
          type: integer
          description: rtt_period_length / 7
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        title:
          type: string
          description: "Title of EAL entry (Specialty: Surname, Firstname)"
      description: Elective admission list of patients requiring an elective procedure.
        This should contain the same content as the encounters table but with additional
        Referral To Treatment metadata. This information is used to support users
        in identifying patients who may be breaching RTT thresholds
    EalEntryProperties:
      type: string
      enum:
      - pathwayId
      - patientName
      - dateOf18WeekRttBreach
      - rttPeriodIs68WeekWaiterString
      - rvGroupIds
      - rttDaysPaused
      - rttPeriod104WeekBreachDate
      - removalDate
      - ealId
      - daysTo18WeekRttBreach
      - lessThan10WeeksToRttBreachString
      - plannedDate
      - rttPeriod78WeekBreachDate
      - rttPeriodEndDate
      - dateOf52WeekRttBreach
      - rttPeriodIs68WeekWaiter
      - hasRttPathwayDescription
      - rttPeriodLength
      - decidedToAdmitDate
      - patientId
      - rttTimeBands
      - daysTo52WeekRttBreach
      - lessThan10WeeksToRttBreach
      - removalReason
      - episodeId
      - rttPeriodId
      - rttWeeksWaiting
      - rttPeriodDaysTo104WeekBreach
      - rttPeriodStartDate
      - removalReasonLocal
      - title
      - daysSinceDecidedToAdmitDate
      - isRtt
      - priorityType
      - rttPeriodIs94WeekWaiter
      - rttStatusCode
      - rttPeriodDaysTo78WeekBreach
      - rttPeriodIs94WeekWaiterString
    Encounter:
      required:
      - __apiName
      - __primaryKey
      - administrativeCategoryCode
      - administrativeCategoryDescription
      - admissionMethod
      - admissionStatus
      - admissionSubStatus
      - admissionType
      - atsTotalTheatreTime
      - calculatedTotalTheatreTime
      - createdBy
      - createdDate
      - criticalCareBedStatus
      - ealId
      - encounterFreeText
      - encounterId
      - encounterType
      - estimatedTotalTheatreTime
      - externalId
      - hasFutureTci
      - hasTci
      - intendedManagementCode
      - intendedManagementDescription
      - intendedPrimaryProcedureAnaestheticType
      - intendedPrimaryProcedureAnaesthetistRequired
      - intendedPrimaryProcedureCode
      - intendedPrimaryProcedureDescription
      - intendedPrimaryProcedureFreeText
      - intendedPrimaryProcedureFreeTextLong
      - isBooked
      - isMetricEncounter
      - isSuitableForPooledList
      - lastCovidSwabBookingStatus
      - lastCovidSwabOutcome
      - lastMrsaSwabBookingStatus
      - lastMrsaSwabOutcome
      - lastPoaBookingStatus
      - lastPoaOutcome
      - lastPoaScheduledOrAttendedDatetime
      - latestRcsClinicalHarmReview
      - localTreatmentFunction
      - needsReprioritisation
      - pathwayId
      - patientCancellationCount
      - patientId
      - patientName
      - periOpRiskStratificationOutcome
      - poaRequired
      - primaryConsultantId
      - primaryConsultantName
      - primaryProcedureStartTime
      - primaryProcedureType
      - priority
      - priorityLastUpdated
      - priorityOrdered
      - referralPriority
      - removalDate
      - removalReason
      - removalReasonCode
      - removed
      - site
      - siteId
      - specialtyId
      - specialtyName
      - suspectedCancerPathway
      - tciDate
      - tciStatus
      - title
      - transferStatus
      - treatmentFunctionCode
      - treatmentFunctionName
      - waitlistCode
      - ward
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        administrativeCategoryCode:
          type: string
          description: "Administrative category code (on admission): https://www.datadictionary.nhs.uk/data_elements/administrative_category_code__on_admission_.html"
        administrativeCategoryDescription:
          type: string
          description: "Administrative category description (on admission): https://www.datadictionary.nhs.uk/data_elements/administrative_category_code__on_admission_.html"
        admissionMethod:
          type: string
          description: Status column to signify the method of admission. Values should
            correspond to the descriptions for https://www.datadictionary.nhs.uk/attributes/method_of_admission.html
        admissionStatus:
          type: string
          description: Patient admission status
        admissionSubStatus:
          type: string
          description: Sub category of admission status
        admissionType:
          type: string
          description: Type of admission (Inpatient or Daycase)
        atsTotalTheatreTime:
          type: integer
          description: Estimated total time in theatre in minutes to be used for ATS
            calculation. Trusts are expected to choose between estimated_total_theatre_time
            and calculated_total_theatre_time.
        calculatedTotalTheatreTime:
          type: integer
          description: "Calculated total time in theatre in minutes, based on historical\
            \ average"
        createdBy:
          type: string
          description: Full name of the user who created the encounter
        createdDate:
          type: string
          description: Date the encounter was created
          format: date
        criticalCareBedStatus:
          type: string
          description: Identifies the status of a critical care bed if a patient requires
            it
        ealId:
          type: string
          description: "ID for the corresponding EAL entry: https://www.datadictionary.nhs.uk/classes/elective_admission_list_entry.html"
        encounterFreeText:
          type: string
          description: Textual details relating to the patients waiting list entry
        encounterId:
          type: string
          description: "ID, a unique identifier for the encounter"
        encounterType:
          type: string
          description: "Type of encounter (Inpatient or Outpatient). Note that if\
            \ only encounters relating to the Elective Admission List are included,\
            \ this column will always be \"Inpatient\""
        estimatedTotalTheatreTime:
          type: integer
          description: "Estimated total procedure time in theatre, in minutes"
        externalId:
          type: string
          description: External ID for the encounter used in an external source system
            (i.e. PAS). This can be used to provide a direct URL link from the encounter
            to the record in the PAS
        hasFutureTci:
          type: boolean
          description: '`True` if patient has a TCI date in the future'
        hasTci:
          type: boolean
          description: '`True` if tci_date is not null'
        intendedManagementCode:
          type: string
          description: https://www.datadictionary.nhs.uk/attributes/intended_management.html
        intendedManagementDescription:
          type: string
          description: "Textual description of the intended management. Derived from\
            \ the intended_management_code, per https://www.datadictionary.nhs.uk/attributes/intended_management.html"
        intendedPrimaryProcedureAnaestheticType:
          type: string
          description: "Anaesthetic type to be used for the intended primary procedure\
            \ (GA/LA). This column uses the intended_procedure_anaesthetic_type value\
            \ from the primary procedure linked to this encounter in the procedure\
            \ table, linked on encounter_id"
        intendedPrimaryProcedureAnaesthetistRequired:
          type: boolean
          description: '`true` if anaesthetist is required for intended primary procedure'
        intendedPrimaryProcedureCode:
          type: string
          description: "OPCS code of intended primary procedure: https://www.datadictionary.nhs.uk/data_elements/primary_procedure__opcs_.html.\
            \ This column uses the intended_procedure_code value from the primary\
            \ procedure linked to this encounter in the procedure table, linked on\
            \ encounter_id"
        intendedPrimaryProcedureDescription:
          type: string
          description: "Description of the intended primary procedure. This column\
            \ uses the intended_procedure_description value from the primary procedure\
            \ linked to this encounter in the procedure table, linked on encounter_id"
        intendedPrimaryProcedureFreeText:
          type: string
          description: "Free text description of the intended primary procedure. This\
            \ column uses the intended_procedure_free_text value from the primary\
            \ procedure linked to this encounter in the procedure table, linked on\
            \ encounter_id"
        intendedPrimaryProcedureFreeTextLong:
          type: string
          description: Full textual description of intended primary procedure
        isBooked:
          type: boolean
          description: '`True` if patient is booked in for treatment'
        isMetricEncounter:
          type: boolean
          description: "`True` if this encounter is used to derive metrics, `False`\
            \ if this encounter should be excluded from metric derivations."
        isSuitableForPooledList:
          type: boolean
          description: '`True` if the patient can be added to a pooled list'
        issues:
          type: array
          description: List of patient readiness issues that have been raised on this
            encounter
          items:
            type: string
        lastCovidSwabBookingStatus:
          type: string
          description: Most recent booking status for COVID swab test. If the trust
            uses Cerner then you will need to supply this property according to their
            custom derivation logic.
        lastCovidSwabOutcome:
          type: string
          description: Outcome of the most recent COVID swab test. If the trust uses
            Cerner then you will need to supply this property according to their custom
            derivation logic.
        lastMrsaSwabBookingStatus:
          type: string
          description: Most recent booking status for MRSA swab test. If the trust
            uses Cerner then you will need to supply this property according to their
            custom derivation logic.
        lastMrsaSwabOutcome:
          type: string
          description: Outcome of the most recent MRSA swab test. If the trust uses
            Cerner then you will need to supply this property according to their custom
            derivation logic.
        lastPoaBookingStatus:
          type: string
          description: The most recent booking status for the POA appointment. If
            the trust uses Cerner then you will need to supply this property according
            to their custom derivation logic.
        lastPoaOutcome:
          type: string
          description: Outcome of the most recent POA appointment. If the trust uses
            Cerner then you will need to supply this property according to their custom
            derivation logic.
        lastPoaScheduledOrAttendedDatetime:
          type: string
          description: Scheduled or attended datetime of the most recent POA appointment.
            If the trust uses Cerner then you will need to supply this property according
            to their custom derivation logic.
          format: date-time
        latestRcsClinicalHarmReview:
          type: string
          description: Outcome of the most recent clinical harm review
        localTreatmentFunction:
          type: string
          description: https://www.datadictionary.nhs.uk/classes/local_sub-specialty.html
        needsReprioritisation:
          type: boolean
          description: "`True` if this encounter needs to be reprioritised (often\
            \ defined by a TCI date in the past, or non-P Codes)"
        pathwayId:
          type: string
          description: "Pathway ID: https://www.datadictionary.nhs.uk/classes/patient_pathway.html"
        patientCancellationCount:
          type: integer
          description: The number of times the patient has had a cancelled theatre
            booking for this encounter
        patientId:
          type: string
          description: ID for the patient requiring treatment
        patientName:
          type: string
          description: "Full patient name (Surname, Firstname). This column uses the\
            \ full_name value from the patient table, linked on patient_id"
        periOpRiskStratificationOutcome:
          type: string
          description: Outcome of peri-op risk stratification. This value may provide
            additional useful information to help scheduling and booking teams determine
            whether or not a patient can be booked in for surgery.
        poaRequired:
          type: string
          description: Signifies whether a POA is required for this encounter
        primaryConsultantId:
          type: string
          description: ID for the primary consultant who is responsible for the encounter
        primaryConsultantName:
          type: string
          description: "Name of the primary consultant who is responsible for the\
            \ encounter. This column uses the name value from the care-professional\
            \ table, linked on primary_consultant_id"
        primaryProcedureStartTime:
          type: string
          description: "Primary procedure start time (if the encounter has been booked\
            \ in). This column uses the procedure_start_time value from the primary\
            \ procedure linked to this encounter in the procedure table, linked on\
            \ encounter_id"
          format: date-time
        primaryProcedureType:
          type: string
          description: "Type of the primary procedure. This column uses the procedure_type\
            \ value from the primary procedure linked to this encounter in the procedure\
            \ table, linked on encounter_id"
        priority:
          type: string
          description: Clinical priority of the encounter
        priorityLastUpdated:
          type: string
          description: Timestamp recording the last time the priority was updated
          format: date-time
        priorityOrdered:
          type: string
          description: "Ordered priority (used for sorting). This should have the\
            \ numeric order of the clinical priority appended to the priority string,\
            \ e.g. `01. <priority>`"
        referralPriority:
          type: string
          description: "GP referral priority of the encounter (RCS or Urgent, Cancer,\
            \ Routine)"
        removalDate:
          type: string
          description: Date the encounter was closed
          format: date
        removalReason:
          type: string
          description: "String description of closure reason: https://www.datadictionary.nhs.uk/data_elements/elective_admission_list_removal_reason_code.html"
        removalReasonCode:
          type: string
          description: "Code for removal reason (`null` if encounter is open): https://www.datadictionary.nhs.uk/data_elements/elective_admission_list_removal_reason_code.html"
        removed:
          type: boolean
          description: '`True` if the encounter is closed (if removal_date is in the
            past)'
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        site:
          type: string
          description: "Hospital site name. This column uses the name field from the\
            \ site table, linked on site_id"
        siteId:
          type: string
          description: Hospital site ID
        specialtyId:
          type: string
          description: ID for the specialty which classifies the encounter
        specialtyName:
          type: string
          description: "Name of the specialty which classifies the encounter. This\
            \ column uses the specialty_name field from the specialty table, linked\
            \ on specialty_id"
        suspectedCancerPathway:
          type: boolean
          description: Indicates whether the patient is waiting for treatment on a
            suspected cancer pathway
        tciDate:
          type: string
          description: To Come In date (`null` if the encounter is unbooked)
          format: date
        tciStatus:
          type: string
          description: To Come In status of the encounter
        title:
          type: string
          description: "Encounter title (Specialty, Full Name)"
        transferStatus:
          type: string
          description: "Status of the patient transfer. The value would usually be\
            \ one of Transferred, null, Rejected, Proposed, Pending Validation"
        treatmentFunctionCode:
          type: string
          description: Treatment function code which the waitlist entry belongs to
        treatmentFunctionName:
          type: string
          description: Treatment function name which the waitlist entry belongs to
        waitlistCode:
          type: string
          description: "Code identifying the waiting list that the encounter is a\
            \ member of: https://www.datadictionary.nhs.uk/classes/waiting_list.html"
        ward:
          type: string
          description: "Name of the ward the patient is, or was, staying in, (NULL\
            \ if patient was never in a ward)"
      description: "All encounters, either booked or unbooked, for patients who have\
        \ or will receive treatment at the trust. The minimum scope of encounters\
        \ should be those that relate to present or past entries on the trust Elective\
        \ Admission List: https://www.datadictionary.nhs.uk/classes/elective_admission_list.html.\
        \ Encounters are used to display waiting list information and support users\
        \ in booking patients into available theatre sessions"
    EncounterProperties:
      type: string
      enum:
      - calculatedTotalTheatreTime
      - criticalCareBedStatus
      - patientName
      - hasTci
      - lastPoaBookingStatus
      - rvGroupIds
      - primaryConsultantName
      - isBooked
      - removalDate
      - ealId
      - intendedPrimaryProcedureDescription
      - lastPoaScheduledOrAttendedDatetime
      - patientCancellationCount
      - removed
      - priorityLastUpdated
      - lastMrsaSwabBookingStatus
      - admissionMethod
      - needsReprioritisation
      - ward
      - createdDate
      - encounterFreeText
      - hasFutureTci
      - primaryConsultantId
      - patientId
      - estimatedTotalTheatreTime
      - transferStatus
      - treatmentFunctionName
      - administrativeCategoryCode
      - lastMrsaSwabOutcome
      - suspectedCancerPathway
      - referralPriority
      - removalReason
      - createdBy
      - tciStatus
      - intendedPrimaryProcedureFreeTextLong
      - specialtyName
      - lastCovidSwabOutcome
      - encounterId
      - intendedManagementDescription
      - intendedPrimaryProcedureAnaestheticType
      - latestRcsClinicalHarmReview
      - primaryProcedureStartTime
      - administrativeCategoryDescription
      - periOpRiskStratificationOutcome
      - intendedManagementCode
      - pathwayId
      - priority
      - treatmentFunctionCode
      - primaryProcedureType
      - encounterType
      - isSuitableForPooledList
      - waitlistCode
      - intendedPrimaryProcedureAnaesthetistRequired
      - specialtyId
      - isMetricEncounter
      - admissionSubStatus
      - atsTotalTheatreTime
      - site
      - removalReasonCode
      - lastPoaOutcome
      - externalId
      - localTreatmentFunction
      - siteId
      - tciDate
      - poaRequired
      - issues
      - title
      - lastCovidSwabBookingStatus
      - intendedPrimaryProcedureFreeText
      - intendedPrimaryProcedureCode
      - admissionType
      - priorityOrdered
      - admissionStatus
    EqualsQueryV2:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value: {}
      description: Returns objects where the specified field is equal to a value.
    ErsService:
      required:
      - __apiName
      - __primaryKey
      - active
      - referralReason
      - serviceDirectoryId
      - serviceName
      - serviceType
      - siteId
      - uniqueId
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        active:
          type: boolean
          description: Flag to define if the service is currently active/published
            in eRS.
        referralReason:
          type: string
          description: Description of the valid reason for GP's to refer into that
            service.
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        serviceDirectoryId:
          type: string
          description: Unique Identifier of the Service in eRS Directory of Services.
        serviceName:
          type: string
          description: Name of the Service.
        serviceType:
          type: string
          description: Defines if the referral needs to go through a triage step or
            not (RAS / Non-RAS).
        siteId:
          type: string
          description: Identifier of the Hospital Site or Health Centre linked to
            the service.
        specialtyIds:
          type: array
          description: Identifiers of all Specialties that run clinic sessions which
            have slots that are linked to this service.
          items:
            type: string
        uniqueId:
          type: string
          description: Unique Identifier for the eRS Service in Source System.
      description: Services published in the eRS Service Directory.
    ErsServiceProperties:
      type: string
      enum:
      - referralReason
      - specialtyIds
      - uniqueId
      - serviceDirectoryId
      - serviceType
      - rvGroupIds
      - active
      - serviceName
      - siteId
    GeoPoint:
      required:
      - coordinates
      - type
      type: object
      properties:
        bbox:
          $ref: "#/components/schemas/BBox"
        coordinates:
          $ref: "#/components/schemas/Position"
        type:
          type: string
    GtQueryV2:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value: {}
      description: Returns objects where the specified field is greater than a value.
    GteQueryV2:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value: {}
      description: Returns objects where the specified field is greater than or equal
        to a value.
    IntersectsBoundingBoxQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          $ref: "#/components/schemas/BoundingBoxValue"
      description: |
        Returns objects where the specified field intersects the bounding box provided.
    IntersectsPolygonQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          $ref: "#/components/schemas/PolygonValue"
      description: |
        Returns objects where the specified field intersects the polygon provided.
    IsNullQueryV2:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          type: boolean
      description: Returns objects based on the existence of the specified field.
    LinearRing:
      minItems: 4
      type: array
      description: |
        A linear ring is a closed LineString with four or more positions.

        The first and last positions are equivalent, and they MUST contain
        identical values; their representation SHOULD also be identical.

        A linear ring is the boundary of a surface or the boundary of a hole in
        a surface.

        A linear ring MUST follow the right-hand rule with respect to the area
        it bounds, i.e., exterior rings are counterclockwise, and holes are
        clockwise.
      items:
        $ref: "#/components/schemas/Position"
    ListAdmissionResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Admission"
        nextPageToken:
          type: string
    ListAppointmentResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Appointment"
        nextPageToken:
          type: string
    ListCareProfessionalResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessional"
        nextPageToken:
          type: string
    ListClinicLetterResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ClinicLetter"
        nextPageToken:
          type: string
    ListClinicSessionResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSession"
        nextPageToken:
          type: string
    ListClinicSlotResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSlot"
        nextPageToken:
          type: string
    ListClinicTypeResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ClinicType"
        nextPageToken:
          type: string
    ListDiagnosisResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Diagnosis"
        nextPageToken:
          type: string
    ListDiagnosticsWaitlistEntryResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntry"
        nextPageToken:
          type: string
    ListEalEntryResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/EalEntry"
        nextPageToken:
          type: string
    ListEncounterResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Encounter"
        nextPageToken:
          type: string
    ListErsServiceResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ErsService"
        nextPageToken:
          type: string
    ListOutpatientActivityResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivity"
        nextPageToken:
          type: string
    ListPatientPathwayResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathway"
        nextPageToken:
          type: string
    ListPatientResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Patient"
        nextPageToken:
          type: string
    ListProcedureResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Procedure"
        nextPageToken:
          type: string
    ListProcedureStatusResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatus"
        nextPageToken:
          type: string
    ListProcedureTypeResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureType"
        nextPageToken:
          type: string
    ListReferralResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Referral"
        nextPageToken:
          type: string
    ListSiteResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Site"
        nextPageToken:
          type: string
    ListSpecialtyResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Specialty"
        nextPageToken:
          type: string
    ListStaffUnavailabilityResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/StaffUnavailability"
        nextPageToken:
          type: string
    ListTestResultResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/TestResult"
        nextPageToken:
          type: string
    ListTheatreBookingResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBooking"
        nextPageToken:
          type: string
    ListTheatreSessionResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSession"
        nextPageToken:
          type: string
    LtQueryV2:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value: {}
      description: Returns objects where the specified field is less than a value.
    LteQueryV2:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value: {}
      description: Returns objects where the specified field is less than or equal
        to a value.
    MaxAggregationV2:
      required:
      - field
      - type
      type: object
      properties:
        direction:
          $ref: "#/components/schemas/OrderByDirection"
        field:
          type: string
        name:
          type: string
        type:
          type: string
      description: Computes the maximum value for the provided field.
    MinAggregationV2:
      required:
      - field
      - type
      type: object
      properties:
        direction:
          $ref: "#/components/schemas/OrderByDirection"
        field:
          type: string
        name:
          type: string
        type:
          type: string
      description: Computes the minimum value for the provided field.
    NotQueryV2:
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
        value:
          $ref: "#/components/schemas/SearchJsonQueryV2"
      description: Returns objects where the query is not satisfied.
    OrQueryV2:
      required:
      - type
      type: object
      properties:
        type:
          type: string
        value:
          type: array
          items:
            $ref: "#/components/schemas/SearchJsonQueryV2"
      description: Returns objects where at least 1 query is satisfied.
    OrderByDirection:
      type: string
      enum:
      - ASC
      - DESC
    OutpatientActivity:
      required:
      - __apiName
      - __primaryKey
      - bookedBy
      - dateAddedToWaitingList
      - daysToBookWithin
      - daysWaiting
      - division
      - dueDate
      - earliestDueDate
      - encounterId
      - externalId
      - fullName
      - isPrivate
      - isReferral
      - lastAppointmentId
      - lastCancelledAppointmentId
      - mrn
      - newOrFollowUp
      - nextAppointmentId
      - nextCancelledAppointmentId
      - outpatientActivityFreeText
      - pathwayId
      - patientId
      - patientIsOnCancerPathway
      - primaryCareProfessionalId
      - priority
      - referralDate
      - referralId
      - removed
      - removedTimestamp
      - requestedAppointmentType
      - rttPathwayStatus
      - rttPeriodEndDate
      - rttPeriodLength
      - rttPeriodStartDate
      - rttPeriodStatusCode
      - siteId
      - siteName
      - source
      - sourceListName
      - sourceUniqueWaitingListEntryId
      - specialtyId
      - specialtyName
      - status
      - statusUpdatedAt
      - title
      - treatmentFunctionCode
      - treatmentFunctionName
      - waitingListEntryId
      - weeksWaiting
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        bookedBy:
          type: string
          description: The source system user identifier of the individual booker
            for this activity.
        dateAddedToWaitingList:
          type: string
          description: Date added to waiting list. This is the date at which an appointment
            was requested for the activity
          format: date
        daysToBookWithin:
          type: integer
          description: Number of days within which the patient must be booked in (before
            the due_date)
        daysWaiting:
          type: integer
          description: Days waiting since added to waiting list
        division:
          type: string
          description: "A higher level divison of specialty e.g. Medicine, Surgery,\
            \ Women's and Oncology, etc."
        dueDate:
          type: string
          description: Date by which patient should be scheduled for an appointment
          format: date
        earliestDueDate:
          type: string
          description: Earliest date the patient can be scheduled for an appointment
          format: date
        encounterId:
          type: string
          description: ID of the linked encounter
        externalId:
          type: string
          description: "An external identifier to help identify the activity in the\
            \ source system (e.g., FIN Number in Cerner)"
        fullName:
          type: string
          description: Full Name of Patient
        isPrivate:
          type: boolean
          description: '`True` if activity is for a private patient'
        isReferral:
          type: boolean
          description: '`True` if activity is an outpatient referral'
        issues:
          type: array
          description: List of patient readiness issues that have been raised on this
            activity
          items:
            type: string
        lastAppointmentId:
          type: string
          description: Foreign key linking the activity to the previous/past relevant
            outpatient appointment
        lastCancelledAppointmentId:
          type: string
          description: Foreign key to the previous/past relevant appointment for the
            activity which has been cancelled
        mrn:
          type: string
          description: Patient MRN
        newOrFollowUp:
          type: string
          description: Indicates whether the appointment is a New or Follow-Up appointment
        nextAppointmentId:
          type: string
          description: Foreign key linking the activity to the next relevant outpatient
            appointment
        nextCancelledAppointmentId:
          type: string
          description: Foreign key to the next relevant appointment for the activity
            which has been cancelled
        outpatientActivityFreeText:
          type: string
          description: Optional data field to denote operational-only scheduling requirements
            for the activity
        pathwayId:
          type: string
          description: "the ID for the pathway the activity is a part of: https://www.datadictionary.nhs.uk/classes/patient_pathway.html"
        patientId:
          type: string
          description: the patient receiving a service
        patientIsOnCancerPathway:
          type: boolean
          description: '`True` if patient is on cancer pathway'
        primaryCareProfessionalId:
          type: string
          description: Primary care professional administering the activity
        priority:
          type: string
          description: "The priority of the request for activity: https://www.datadictionary.nhs.uk/classes/activity_priority.html\
            \ (e.g. Urgent, Routine)"
        referralDate:
          type: string
          description: Date the linked referral was received
          format: date
        referralId:
          type: string
          description: ID of the linked referral
        removed:
          type: boolean
          description: '`True` if the record has been removed from the waiting list.'
        removedTimestamp:
          type: string
          description: The date and time of removal from the waiting list
          format: date-time
        requestedAppointmentType:
          type: string
          description: "Reqested appointment type (e.g. Cardiology F/Up, Endocrinology\
            \ New)"
        rttPathwayStatus:
          type: string
          description: Is on active RTT pathway
        rttPeriodEndDate:
          type: string
          description: Date of RTT clock stop
          format: date
        rttPeriodLength:
          type: integer
          description: RTT period length (days)
        rttPeriodStartDate:
          type: string
          description: Date of RTT clock start
          format: date
        rttPeriodStatusCode:
          type: string
          description: The status code of the RTT Period. https://www.datadictionary.nhs.uk/attributes/referral_to_treatment_period_status.html
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        siteId:
          type: string
          description: Hospital site ID
        siteName:
          type: string
          description: Hospital site at which the activity will take place
        source:
          type: string
          description: "The source of the activity record (e.g. eRS, PAS)"
        sourceListName:
          type: string
          description: "The name of the source waiting list the entry originates from\
            \ (e.g. OWL, FOWL)"
        sourceUniqueWaitingListEntryId:
          type: string
          description: ID for the waiting list entry used in the original source system
        specialtyId:
          type: string
          description: the main specialty for the activity
        specialtyName:
          type: string
          description: Name of main specialty for the activity
        status:
          type: string
          description: "Status (e.g. Due, Past Due, Booked, Cancelled, Deferred)"
        statusUpdatedAt:
          type: string
          description: Captures the time and date when the status of the outpatient
            activity
          format: date-time
        title:
          type: string
          description: "Activity display title (Full Name, Specialty)"
        treatmentFunctionCode:
          type: string
          description: A unique identifier for the treatment function. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html
        treatmentFunctionName:
          type: string
          description: The corresponding name of the treatment function. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html
        waitingListEntryId:
          type: string
          description: ID for the outpatient activity
        weeksWaiting:
          type: integer
          description: Weeks waiting since added to waiting list
      description: "All outpatient activity, either booked or unbooked: https://www.datadictionary.nhs.uk/classes/activity.html\
        \ The minimum scope of outpatient activity should be those that relate to\
        \ past or present entries on the Outpatient Waiting List"
    OutpatientActivityProperties:
      type: string
      enum:
      - lastAppointmentId
      - rvGroupIds
      - fullName
      - mrn
      - nextCancelledAppointmentId
      - patientIsOnCancerPathway
      - referralDate
      - removed
      - rttPeriodEndDate
      - waitingListEntryId
      - dateAddedToWaitingList
      - daysToBookWithin
      - rttPeriodLength
      - patientId
      - isReferral
      - primaryCareProfessionalId
      - treatmentFunctionName
      - outpatientActivityFreeText
      - siteName
      - isPrivate
      - dueDate
      - specialtyName
      - encounterId
      - newOrFollowUp
      - nextAppointmentId
      - weeksWaiting
      - pathwayId
      - priority
      - treatmentFunctionCode
      - sourceListName
      - status
      - requestedAppointmentType
      - rttPathwayStatus
      - specialtyId
      - source
      - externalId
      - sourceUniqueWaitingListEntryId
      - siteId
      - rttPeriodStatusCode
      - statusUpdatedAt
      - bookedBy
      - issues
      - earliestDueDate
      - rttPeriodStartDate
      - lastCancelledAppointmentId
      - title
      - division
      - removedTimestamp
      - daysWaiting
      - referralId
    Patient:
      required:
      - __apiName
      - __primaryKey
      - addressLine1
      - addressLine2
      - age
      - dateOfBirth
      - dateOfDeath
      - deceased
      - firstName
      - fullName
      - genderIdentity
      - mrn
      - nextOfKinName
      - nextOfKinNumber
      - nhsNumber
      - personId
      - phoneNumber
      - postcode
      - registeredGp
      - sex
      - surname
      - title
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        addressLine1:
          type: string
          description: Patient address line 1
        addressLine2:
          type: string
          description: Patient address line 2
        age:
          type: string
          description: Patient age (years)
          format: long
        dateOfBirth:
          type: string
          description: Date of birth
          format: date
        dateOfDeath:
          type: string
          description: Date of death (`null` if the patient is not deceased)
          format: date
        deceased:
          type: boolean
          description: '`True` if the patient is deceased'
        firstName:
          type: string
          description: First name
        fullName:
          type: string
          description: "Last Name, First Name"
        genderIdentity:
          type: string
          description: "The individual's perception of their own gender. In some cases,\
            \ this may not be the same as the patient's registered birth gender, or\
            \ their current administrative gender."
        mrn:
          type: string
          description: Medical record number/hospital number
        nextOfKinName:
          type: string
          description: Next of kin name
        nextOfKinNumber:
          type: string
          description: Next of kin contact number
        nhsNumber:
          type: string
          description: "NHS number, National-level identifier for a patient https://www.datadictionary.nhs.uk/attributes/nhs_number.html"
        personId:
          type: string
          description: "ID, a unique identifier for each patient"
        phoneNumber:
          type: string
          description: Patient primary phone number
        postcode:
          type: string
          description: Patient postcode
        registeredGp:
          type: string
          description: GP Practice address where the patient is registered
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        sex:
          type: string
          description: Patient Sex (Male/Female/Indeterminate)
        surname:
          type: string
          description: Surname
        title:
          type: string
          description: "Mode of address for this patient (e.g. (Mr, Mrs, Ms, Dr)"
      description: "A person with a specific disease or condition who received treatment\
        \ from the trust, or any registrable birth: https://www.datadictionary.nhs.uk/classes/patient.html.\
        \ The patient table at minimum should contain details on patients who are\
        \ on the trust Elective Admission List or Outpatient Waiting List, as well\
        \ as patients who were previously on the Elective Admission List or Outpatient\
        \ Waiting List but have now been removed. This information is required to\
        \ support users in identifying patients on waiting lists as well as booking\
        \ them into theatre sessions."
    PatientPathway:
      required:
      - __apiName
      - __primaryKey
      - admissionMethodCode
      - age
      - consultantId
      - consultantName
      - covidPriority
      - covidPriorityDate
      - dataSource
      - dateOfBirth
      - directorate
      - division
      - dtaDate
      - intendedProcedureDescription
      - lastAppointment
      - lastAppointmentDate
      - lastAppointmentDescription
      - lastClinicLetterDate
      - lastClinicLetterType
      - lastOpaDate
      - lastOpaOutcome
      - lastPathwayActivity
      - lastPathwayActivityDate
      - lastTestResultDate
      - latestReferralReceivedDate
      - localSubSpecialtyCode
      - localSubSpecialtyDescription
      - mrn
      - nextAppointment
      - nextAppointmentDate
      - nextAppointmentDescription
      - nextAppointmentStatus
      - nextDiagnosticsDate
      - nextOpaDate
      - nhsCcg
      - nhsNumber
      - owlClinicCode
      - owlFlag
      - owlGroupCode
      - pathwayClass
      - pathwayId
      - pathwayStatus
      - pathwayType
      - patientDeceased
      - patientId
      - patientName
      - referralDate
      - referralPriority
      - referralReceivedDate
      - referralSource
      - siteId
      - siteName
      - specialtyId
      - specialtyName
      - tciDate
      - treatmentFunctionCode
      - treatmentFunctionName
      - ubrn
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        admissionMethodCode:
          type: string
          description: Code corresponding to how the patient was admitted https://www.datadictionary.nhs.uk/data_elements/admission_method_code__hospital_provider_spell_.html.
        age:
          type: string
          description: The age of the patient
          format: long
        consultantId:
          type: string
          description: ID for the primary consultant responsible for the patient's
            care.
        consultantName:
          type: string
          description: The name of the primary consultant associated with the RTT
            pathway
        covidPriority:
          type: string
          description: "Covid Priority e.g.: 1a,1b,2,3,4"
        covidPriorityDate:
          type: string
          description: Date Covid Priority was entered on WL
          format: date
        dataSource:
          type: string
          description: Name of the source system this pathway originated from.
        dateOfBirth:
          type: string
          description: The date of birth of the patient
          format: date
        directorate:
          type: string
          description: An umbrella category for a team that sits on top of division
            and speciality.
        division:
          type: string
          description: "A higher level divison of specialty e.g. Medicine, Surgery,\
            \ Women's and Oncology, etc."
        dtaDate:
          type: string
          description: Decision to admit date.
          format: date
        intendedProcedureDescription:
          type: string
          description: The description of the intended procedure that the patient
            needs.
        lastAppointment:
          type: string
          description: Type of the last appointment that occured.
        lastAppointmentDate:
          type: string
          description: Date of last patient appointment as an inpatient or outpatient.
          format: date
        lastAppointmentDescription:
          type: string
          description: Description of last patient appointment as an inpatient or
            outpatient.
        lastClinicLetterDate:
          type: string
          description: The date of the last clinic letter for the patient
          format: date-time
        lastClinicLetterType:
          type: string
          description: The type of the last clinic letter for the patient
        lastOpaDate:
          type: string
          description: Date of the last outpatient appointment the patient had.
          format: date
        lastOpaOutcome:
          type: string
          description: The outcome of the last outpatient appointment the associated
            patient has attended.
        lastPathwayActivity:
          type: string
          description: "The last activity recorded for the pathway - could be an appointment,\
            \ a clinic letter, a conversation, etc."
        lastPathwayActivityDate:
          type: string
          description: The date of the last activity recorded for the pathway
          format: date
        lastTestResultDate:
          type: string
          description: The date of the last test result for the patient
          format: date-time
        latestReferralReceivedDate:
          type: string
          description: "Date when the latest referral on the pathway was created.\
            \ This field should ONLY be provided if the referral input dataset is\
            \ NOT provided. In cases where the referral input dataset is provided,\
            \ this field should not be provided and instead will be derived."
          format: date
        localSubSpecialtyCode:
          type: string
          description: Local sub specialty code https://www.datadictionary.nhs.uk/data_elements/local_sub-specialty_code.html
        localSubSpecialtyDescription:
          type: string
          description: Local sub specialty description https://www.datadictionary.nhs.uk/data_elements/local_sub-specialty_code.html
        mrn:
          type: string
          description: The MRN/CRN of the patient
        nextAppointment:
          type: string
          description: Type of the next appointment that is due to occur.
        nextAppointmentDate:
          type: string
          description: Date of next patient appointment inpatient or outpatient.
          format: date
        nextAppointmentDescription:
          type: string
          description: Description of next patient appointment inpatient or outpatient.
        nextAppointmentStatus:
          type: string
          description: Whether the next appointment is dated or undated.
        nextDiagnosticsDate:
          type: string
          description: Date of next diagnostics appointment.
          format: date
        nextOpaDate:
          type: string
          description: Date of next outpatient appointment.
          format: date
        nhsCcg:
          type: string
          description: NHS Clinical Commissioning group code https://www.datadictionary.nhs.uk/nhs_business_definitions/clinical_commissioning_group.html
        nhsNumber:
          type: string
          description: The NHS number of the patient
        owlClinicCode:
          type: string
          description: Clinic code entered on outpatient waiting list. Can be derived
            from ccs-appointment.
        owlFlag:
          type: boolean
          description: Whether the patient is on an outpatient waiting list
        owlGroupCode:
          type: string
          description: Clinic group code entered on outpatient waiting list. Can be
            derived from ccs-appointment.
        pathwayClass:
          type: string
          description: Indicates whether the pathway is Admitted vs Non-Admitted
        pathwayId:
          type: string
          description: "Primary Key: https://www.datadictionary.nhs.uk/attributes/patient_pathway_identifier.html"
        pathwayStatus:
          type: string
          description: "Whether the pathway is an Active RTT Pathway, an Inactive\
            \ RTT Pathway or a Non-RTT Pathway"
        pathwayType:
          type: string
          description: Different categories indicating the type of pathway the patient
            is on
        patientDeceased:
          type: boolean
          description: Is the patient deceased
        patientId:
          type: string
          description: Unique Identifier of the patient.
        patientName:
          type: string
          description: Full name of the patient
        referralDate:
          type: string
          description: "Date when the original referral on the pathway was created.\
            \ This field should ONLY be provided if the referral input dataset is\
            \ NOT provided. In cases where the referral input dataset is provided,\
            \ this field should not be provided and instead will be derived."
          format: date
        referralPriority:
          type: string
          description: "The priority of the original referral on the pathway. https://www.datadictionary.nhs.uk/GPDataSet/Referral.html.\
            \ This field should ONLY be provided if the referral input dataset is\
            \ NOT provided. In cases where the referral input dataset is provided,\
            \ this field should not be provided and instead will be derived."
        referralReceivedDate:
          type: string
          description: "Date when the original referral on the pathway was received\
            \ in primary care. https://www.datadictionary.nhs.uk/attributes/referral_request_received_date.html.\
            \ This field should ONLY be provided if the referral input dataset is\
            \ NOT provided. In cases where the referral input dataset is provided,\
            \ this field should not be provided and instead will be derived."
          format: date
        referralSource:
          type: string
          description: "The source (care setting) for the original referral on the\
            \ pathway. https://www.datadictionary.nhs.uk/GPDataSet/Referral.html.\
            \ This field should ONLY be provided if the referral input dataset is\
            \ NOT provided. In cases where the referral input dataset is provided,\
            \ this field should not be provided and instead will be derived."
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        siteId:
          type: string
          description: "ID for the hospital site where the patient is receiving care:\
            \ https://www.datadictionary.nhs.uk/nhs_business_definitions/hospital_site.html"
        siteName:
          type: string
          description: The name of the hospital site corresponding with the RTT pathway
        specialtyId:
          type: string
          description: Main specialty code https://www.datadictionary.nhs.uk/attributes/main_specialty_code.html
        specialtyName:
          type: string
          description: RTT Period specialty name
        tciDate:
          type: string
          description: Scheduled date for patient to come in. Used in tandem with
            next_opa_date to determine prospective clock stops.
          format: date
        treatmentFunctionCode:
          type: string
          description: A unique identifier for the treatment function. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html
        treatmentFunctionName:
          type: string
          description: The corresponding name of the treatment function. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html
        ubrn:
          type: string
          description: "The unique booking reference number of the original referral\
            \ on the pathway. https://www.datadictionary.nhs.uk/attributes/unique_booking_reference_number__converted_.html.\
            \ This field should ONLY be provided if the referral input dataset is\
            \ NOT provided. In cases where the referral input dataset is provided,\
            \ this field should not be provided and instead will be derived."
      description: "A dataset which contains a record per Patient Pathway (https://www.datadictionary.nhs.uk/classes/patient_pathway.html).\
        \ This dataset will used to track linked patient pathways for active RTT Periods.\
        \ Additionally, this dataset will consist of all patient pathways (even closed)\
        \ for historical analysis."
    PatientPathwayProperties:
      type: string
      enum:
      - lastTestResultDate
      - patientName
      - rvGroupIds
      - mrn
      - nextAppointmentStatus
      - covidPriorityDate
      - referralDate
      - ubrn
      - pathwayType
      - dtaDate
      - age
      - intendedProcedureDescription
      - patientId
      - pathwayStatus
      - treatmentFunctionName
      - lastOpaDate
      - referralPriority
      - consultantId
      - siteName
      - nextAppointmentDescription
      - referralSource
      - pathwayClass
      - specialtyName
      - lastOpaOutcome
      - lastAppointment
      - nextDiagnosticsDate
      - owlClinicCode
      - directorate
      - pathwayId
      - treatmentFunctionCode
      - localSubSpecialtyCode
      - lastAppointmentDescription
      - lastClinicLetterDate
      - nhsNumber
      - dateOfBirth
      - owlFlag
      - specialtyId
      - lastPathwayActivity
      - dataSource
      - consultantName
      - covidPriority
      - nhsCcg
      - owlGroupCode
      - siteId
      - patientDeceased
      - admissionMethodCode
      - nextOpaDate
      - tciDate
      - localSubSpecialtyDescription
      - nextAppointment
      - lastPathwayActivityDate
      - lastAppointmentDate
      - latestReferralReceivedDate
      - division
      - referralReceivedDate
      - lastClinicLetterType
      - nextAppointmentDate
    PatientProperties:
      type: string
      enum:
      - age
      - deceased
      - nhsNumber
      - rvGroupIds
      - fullName
      - mrn
      - nextOfKinNumber
      - title
      - dateOfBirth
      - firstName
      - sex
      - registeredGp
      - surname
      - genderIdentity
      - dateOfDeath
      - personId
      - postcode
      - phoneNumber
      - addressLine1
      - nextOfKinName
      - addressLine2
    Polygon:
      required:
      - type
      type: object
      properties:
        bbox:
          $ref: "#/components/schemas/BBox"
        coordinates:
          type: array
          items:
            $ref: "#/components/schemas/LinearRing"
        type:
          type: string
    PolygonValue:
      discriminator:
        propertyName: type
        mapping:
          Polygon: "#/components/schemas/Polygon"
      oneOf:
      - $ref: "#/components/schemas/Polygon"
    Position:
      maxItems: 3
      minItems: 2
      type: array
      description: |
        GeoJSon fundamental geometry construct.

        A position is an array of numbers. There MUST be two or more elements.
        The first two elements are longitude and latitude, precisely in that order and using decimal numbers.
        Altitude or elevation MAY be included as an optional third element.

        Implementations SHOULD NOT extend positions beyond three elements
        because the semantics of extra elements are unspecified and ambiguous.
        Historically, some implementations have used a fourth element to carry
        a linear referencing measure (sometimes denoted as "M") or a numerical
        timestamp, but in most situations a parser will not be able to properly
        interpret these values. The interpretation and meaning of additional
        elements is beyond the scope of this specification, and additional
        elements MAY be ignored by parsers.
      items:
        type: number
        format: double
    Procedure:
      required:
      - __apiName
      - __primaryKey
      - actualProcedureTimeKnifeToSkinClosure
      - actualProcedureTimeTotalTheatreTime
      - admissionMethodDescription
      - anaestheticTypeToBeUsed
      - anaesthetistRequired
      - encounterId
      - estimatedProcedureTimeKnifeToSkinClosure
      - estimatedProcedureTimeStrategy
      - estimatedProcedureTimeTotalTheatreTime
      - expectedLengthOfStay
      - intendedProcedureCode
      - intendedProcedureDescription
      - intendedProcedureFreeText
      - isPrimaryProcedure
      - patientId
      - primaryConsultantId
      - priority
      - priorityOrdered
      - procedureDate
      - procedureId
      - procedureOrdered
      - procedureTimeOrOrder
      - theatreSessionId
      - title
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        actualProcedureTimeKnifeToSkinClosure:
          type: integer
          description: Actual time from knife to skin to skin closure during the procedure
            (in minutes)
        actualProcedureTimeTotalTheatreTime:
          type: integer
          description: Actual total theatre time utilised to carry out the procedure
            (in minutes)
        admissionMethodDescription:
          type: string
          description: "Status column to signify if the admission was, or is, planned\
            \ or unplanned. If the data is restricted to procedures related to elective\
            \ admission list entries, then this column will only contain \"Planned\"\
            \ values. This column uses the admission_method value from the encounters\
            \ table, linked on encounter_id"
        anaestheticTypeToBeUsed:
          type: string
          description: "Which type of anaesthetic (if any) was, or will be, used in\
            \ the procedure"
        anaesthetistRequired:
          type: boolean
          description: '`true` if an anaesthetist is required for this procedure.  can
            be used if not known'
        encounterId:
          type: string
          description: "Encounter at which the procedure was, or will be, performed"
        estimatedProcedureTimeKnifeToSkinClosure:
          type: integer
          description: Estimated time from knife to skin to skin closure during the
            procedure in minutes
        estimatedProcedureTimeStrategy:
          type: string
          description: Textual description of the strategy used to estimate procedure
            time
        estimatedProcedureTimeTotalTheatreTime:
          type: integer
          description: Estimated total theatre time utilised to carry out the procedure
            (in minutes)
        expectedLengthOfStay:
          type: string
          description: "Textual description of the length of time the patient will\
            \ stay in hospital e.g. \"36 Hours\", \"5 Days\""
        intendedProcedureCode:
          type: string
          description: "OPCS code of the intended procedure: https://www.datadictionary.nhs.uk/data_elements/primary_procedure__opcs_.html"
        intendedProcedureDescription:
          type: string
          description: Description of the intended primary procedure
        intendedProcedureFreeText:
          type: string
          description: Free text comments related to the intended primary procedure
        isPrimaryProcedure:
          type: boolean
          description: '`True` if this procedure is the primary procedure of the encounter'
        patientId:
          type: string
          description: "ID for the patient on which the procedure was, or will be,\
            \ performed"
        primaryConsultantId:
          type: string
          description: ID for the primary consultant performing the procedure
        priority:
          type: string
          description: "Clinical priority of the linked Encounter (RCS or Urgent,\
            \ Cancer, Routine). This column uses the priority value from the encounters\
            \ table, linked on encounter_id"
        priorityOrdered:
          type: string
          description: "Ordered priority (used for sorting). This should have the\
            \ numeric order of the clinical priority appended to the priority string,\
            \ e.g. `01: Urgent`. This column uses the priority_ordered value from\
            \ the encounters table, linked on encounter_id"
        procedureDate:
          type: string
          description: "Date of procedure: https://www.datadictionary.nhs.uk/data_elements/procedure_date.html"
          format: date
        procedureId:
          type: string
          description: ID for the procedure
        procedureOrdered:
          type: integer
          description: A ranking of procedures within a specific theatre session by
            start time (the lowest ranked procedure will appear first)
        procedureTimeOrOrder:
          type: string
          description: Start time of procedure using a 24 hour clock in string format
            (hh:mm:ss) https://www.datadictionary.nhs.uk/nhs_business_definitions/procedure_time.html
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        theatreSessionId:
          type: string
          description: "theatre session at which the procedure was, or will be, performed\
            \ (if booked)"
        title:
          type: string
          description: "A textual title for the procedure. Recommended format is `{patient\
            \ name}: {procedure description}`"
      description: "Information about procedures performed on, or planned to be performed\
        \ on, a Patient. The procedure list should be limited to procedures that are\
        \ related to encounters in the encounters table. For more information on procedures,\
        \ please see https://www.datadictionary.nhs.uk/nhs_business_definitions/patient_procedure.html.\
        \ Procedures are used in the applications to provide further information on\
        \ theatre bookings, such as primary procedure start time, expected length\
        \ and description. Procedure data is also displayed on patient visualisations\
        \ so users can see past and upcoming procedures"
    ProcedureProperties:
      type: string
      enum:
      - priority
      - admissionMethodDescription
      - procedureTimeOrOrder
      - actualProcedureTimeKnifeToSkinClosure
      - rvGroupIds
      - actualProcedureTimeTotalTheatreTime
      - estimatedProcedureTimeKnifeToSkinClosure
      - procedureOrdered
      - procedureId
      - expectedLengthOfStay
      - isPrimaryProcedure
      - estimatedProcedureTimeStrategy
      - estimatedProcedureTimeTotalTheatreTime
      - intendedProcedureCode
      - primaryConsultantId
      - procedureDate
      - intendedProcedureDescription
      - patientId
      - anaesthetistRequired
      - title
      - intendedProcedureFreeText
      - encounterId
      - priorityOrdered
      - anaestheticTypeToBeUsed
      - theatreSessionId
    ProcedureStatus:
      required:
      - __apiName
      - __primaryKey
      - covidSwabAppointmentId
      - covidSwabAttendedDatetime
      - covidSwabBookedDatetime
      - covidSwabBookingStatus
      - covidSwabOutcome
      - encounterId
      - isPrimaryProcedure
      - mrsaSwabAppointmentId
      - mrsaSwabAttendedDatetime
      - mrsaSwabBookedDatetime
      - mrsaSwabBookingStatus
      - mrsaSwabOutcome
      - patientId
      - poaAppointmentId
      - poaBookedDatetime
      - poaBookingStatus
      - poaOrdering
      - poaOutcome
      - poaOutcomeFreeText
      - poaScheduledOrAttendedDatetime
      - procedureId
      - procedureStatusId
      - theatreBookingId
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        covidSwabAppointmentId:
          type: string
          description: ID for the COVID swab appointment
        covidSwabAttendedDatetime:
          type: string
          description: Timestamp at which the COVID swab appointment was attended
          format: date-time
        covidSwabBookedDatetime:
          type: string
          description: Timestamp at which the COVID swab appointment was booked
          format: date-time
        covidSwabBookingStatus:
          type: string
          description: COVID swab appointment booking status
        covidSwabOutcome:
          type: string
          description: COVID swab appointment outcome
        encounterId:
          type: string
          description: ID for the encounter related to the procedure
        isPrimaryProcedure:
          type: boolean
          description: '`True` if this procedure is the primary procedure of the encounter'
        mrsaSwabAppointmentId:
          type: string
          description: ID for the MRSA swab appointment
        mrsaSwabAttendedDatetime:
          type: string
          description: Timestamp at which the MRSA swab appointment was attended
          format: date-time
        mrsaSwabBookedDatetime:
          type: string
          description: Timestamp at which the MRSA swab appointment was booked
          format: date-time
        mrsaSwabBookingStatus:
          type: string
          description: MRSA swab booking status
        mrsaSwabOutcome:
          type: string
          description: MRSA swab appointment outcome
        patientId:
          type: string
          description: ID for the patient related to the procedure
        poaAppointmentId:
          type: string
          description: ID for the POA appointment related to the procedure
        poaBookedDatetime:
          type: string
          description: Timestamp at which the POA appointment was booked
          format: date-time
        poaBookingStatus:
          type: string
          description: The booking status for the POA appointment
        poaOrdering:
          type: integer
          description: Order of the pre-operative assessment for an encounter. An
            order of 1 indicates the most recent appointment.
        poaOutcome:
          type: string
          description: Outcome of POA appointment
        poaOutcomeFreeText:
          type: string
          description: Free text comments relating to POA outcome
        poaScheduledOrAttendedDatetime:
          type: string
          description: "Timestamp at which the POA appointment is scheduled, or was\
            \ attended"
          format: date-time
        procedureId:
          type: string
          description: ID for the procedure
        procedureStatusId:
          type: string
          description: "ID, a unique identifier for each record"
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        theatreBookingId:
          type: string
          description: ID for the theatre booking event at which the procedure takes
            place
      description: "Contains a record per procedure, along with metadata that indicates\
        \ the readiness of each procedure. This information is used to highlight any\
        \ procedure issues when patients are booked in for treatment, such as the\
        \ status of Pre-Operative Assessments, COVID swabs and MRSA swabs."
    ProcedureStatusProperties:
      type: string
      enum:
      - poaBookedDatetime
      - patientId
      - theatreBookingId
      - covidSwabBookedDatetime
      - covidSwabBookingStatus
      - rvGroupIds
      - mrsaSwabBookedDatetime
      - covidSwabAppointmentId
      - poaOutcomeFreeText
      - poaScheduledOrAttendedDatetime
      - poaAppointmentId
      - procedureStatusId
      - mrsaSwabOutcome
      - poaOutcome
      - covidSwabAttendedDatetime
      - covidSwabOutcome
      - encounterId
      - procedureId
      - poaOrdering
      - mrsaSwabAppointmentId
      - mrsaSwabBookingStatus
      - isPrimaryProcedure
      - mrsaSwabAttendedDatetime
      - poaBookingStatus
    ProcedureType:
      required:
      - __apiName
      - __primaryKey
      - procedureCode
      - procedureDescription
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        procedureCode:
          type: string
          description: "Primary Key: Procedure code"
        procedureDescription:
          type: string
          description: Procedure Description
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
      description: List of available procedures
    ProcedureTypeProperties:
      type: string
      enum:
      - procedureDescription
      - procedureCode
      - rvGroupIds
    Referral:
      required:
      - __apiName
      - __primaryKey
      - dateReferralAccepted
      - dateReferralCreated
      - dateReferralReceived
      - daysToBookWithin
      - daysWaiting
      - dueDate
      - earliestDueDate
      - fullName
      - mrn
      - patientId
      - patientIsOnCancerPathway
      - primaryCareProfessionalId
      - priority
      - referralId
      - referralNotes
      - referralSource
      - removed
      - removedTimestamp
      - requestedAppointmentType
      - rttPathwayStatus
      - rttPeriodEndDate
      - rttPeriodLength
      - rttPeriodStartDate
      - serviceId
      - serviceName
      - serviceType
      - siteId
      - siteName
      - source
      - sourceUniqueId
      - specialtyId
      - specialtyName
      - status
      - title
      - ubrn
      - weeksWaiting
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        dateReferralAccepted:
          type: string
          description: Date referral was accepted by the service/trust
          format: date
        dateReferralCreated:
          type: string
          description: Date the referral was created.
          format: date
        dateReferralReceived:
          type: string
          description: Date referral was received by the service/trust
          format: date
        daysToBookWithin:
          type: integer
          description: Number of days within which the patient must be booked in (before
            the due_date)
        daysWaiting:
          type: integer
          description: Days waiting since the referral was received
        dueDate:
          type: string
          description: Date by which patient should be scheduled for an appointment
          format: date
        earliestDueDate:
          type: string
          description: Earliest date the patient can be scheduled for an appointment
          format: date
        fullName:
          type: string
          description: Full Name of Patient
        mrn:
          type: string
          description: Patient MRN
        pathwayId:
          type: array
          description: "The ID of the pathway the referral is linked to: https://www.datadictionary.nhs.uk/classes/patient_pathway.html.\
            \ Note: a single pathway ID is expected but there is the option to provide\
            \ more than one pathway ID in the case of data quality issues resulting\
            \ in more than one pathway being linked to a referral."
          items:
            type: string
        patientId:
          type: string
          description: the patient receiving a service
        patientIsOnCancerPathway:
          type: boolean
          description: '`True` if patient is on cancer pathway'
        primaryCareProfessionalId:
          type: string
          description: Primary care professional assigned to the referral
        priority:
          type: string
          description: "The priority of the referral request: https://www.datadictionary.nhs.uk/classes/activity_priority.html\
            \ (e.g. Urgent, Routine)"
        referralId:
          type: string
          description: ID for the referral
        referralNotes:
          type: string
          description: Accompanying notes sent alongside the referral
        referralSource:
          type: string
          description: The source of referral of each Consultant Out-Patient Episode.
            https://www.datadictionary.nhs.uk/attributes/source_of_referral_for_out-patients.html
        removed:
          type: boolean
          description: '`True` if the record has been removed.'
        removedTimestamp:
          type: string
          description: The date and time of removal
          format: date-time
        requestedAppointmentType:
          type: string
          description: "Requested appointment type (e.g. Cardiology F/Up, Endocrinology\
            \ New) for the referral"
        rttPathwayStatus:
          type: string
          description: Is on active RTT pathway
        rttPeriodEndDate:
          type: string
          description: Date of RTT clock stop
          format: date
        rttPeriodLength:
          type: integer
          description: RTT period length (days)
        rttPeriodStartDate:
          type: string
          description: Date of RTT clock start
          format: date
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        serviceId:
          type: string
          description: ID of the eRS service under which the referral was received
        serviceName:
          type: string
          description: Name of the eRS service under which the referral was received
        serviceType:
          type: string
          description: Type of the eRS service under which the referral was received
        siteId:
          type: string
          description: Hospital site ID
        siteName:
          type: string
          description: Hospital site for the referral
        source:
          type: string
          description: "The source of the activity record (e.g. eRS, PAS)"
        sourceUniqueId:
          type: string
          description: ID for the referral used in the original source system
        specialtyId:
          type: string
          description: the main specialty for the referral
        specialtyName:
          type: string
          description: Name of main specialty for the referral
        status:
          type: string
          description: "Status (e.g. Accepted, Rejected, Open, Awaiting Triage)"
        title:
          type: string
          description: "Referral display title (Full Name, Specialty)"
        ubrn:
          type: string
          description: The unique booking reference number of the referral. https://www.datadictionary.nhs.uk/attributes/unique_booking_reference_number__converted_.html
        weeksWaiting:
          type: integer
          description: Weeks waiting since the referral was received
      description: "All referrals: https://www.datadictionary.nhs.uk/classes/referral_request.html\
        \ The minimum scope of referrals should be those that relate to past or present\
        \ referrals for outpatient appointments"
    ReferralProperties:
      type: string
      enum:
      - pathwayId
      - priority
      - dateReferralAccepted
      - status
      - rvGroupIds
      - fullName
      - mrn
      - serviceName
      - patientIsOnCancerPathway
      - requestedAppointmentType
      - rttPathwayStatus
      - specialtyId
      - dateReferralCreated
      - removed
      - rttPeriodEndDate
      - source
      - ubrn
      - referralNotes
      - siteId
      - daysToBookWithin
      - sourceUniqueId
      - dateReferralReceived
      - rttPeriodLength
      - patientId
      - primaryCareProfessionalId
      - serviceType
      - earliestDueDate
      - rttPeriodStartDate
      - siteName
      - title
      - referralSource
      - dueDate
      - specialtyName
      - removedTimestamp
      - daysWaiting
      - serviceId
      - referralId
      - weeksWaiting
    SearchAdmissionResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Admission"
        nextPageToken:
          type: string
    SearchAppointmentResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Appointment"
        nextPageToken:
          type: string
    SearchCareProfessionalResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/CareProfessional"
        nextPageToken:
          type: string
    SearchClinicLetterResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ClinicLetter"
        nextPageToken:
          type: string
    SearchClinicSessionResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSession"
        nextPageToken:
          type: string
    SearchClinicSlotResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ClinicSlot"
        nextPageToken:
          type: string
    SearchClinicTypeResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ClinicType"
        nextPageToken:
          type: string
    SearchDiagnosisResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Diagnosis"
        nextPageToken:
          type: string
    SearchDiagnosticsWaitlistEntryResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/DiagnosticsWaitlistEntry"
        nextPageToken:
          type: string
    SearchEalEntryResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/EalEntry"
        nextPageToken:
          type: string
    SearchEncounterResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Encounter"
        nextPageToken:
          type: string
    SearchErsServiceResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ErsService"
        nextPageToken:
          type: string
    SearchJsonQueryV2:
      discriminator:
        propertyName: type
        mapping:
          and: "#/components/schemas/AndQueryV2"
          contains: "#/components/schemas/ContainsQueryV2"
          containsAllTerms: "#/components/schemas/ContainsAllTermsQuery"
          containsAllTermsInOrder: "#/components/schemas/ContainsAllTermsInOrderQuery"
          containsAllTermsInOrderPrefixLastTerm: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm"
          containsAnyTerm: "#/components/schemas/ContainsAnyTermQuery"
          doesNotIntersectBoundingBox: "#/components/schemas/DoesNotIntersectBoundingBoxQuery"
          doesNotIntersectPolygon: "#/components/schemas/DoesNotIntersectPolygonQuery"
          eq: "#/components/schemas/EqualsQueryV2"
          gt: "#/components/schemas/GtQueryV2"
          gte: "#/components/schemas/GteQueryV2"
          intersectsBoundingBox: "#/components/schemas/IntersectsBoundingBoxQuery"
          intersectsPolygon: "#/components/schemas/IntersectsPolygonQuery"
          isNull: "#/components/schemas/IsNullQueryV2"
          lt: "#/components/schemas/LtQueryV2"
          lte: "#/components/schemas/LteQueryV2"
          not: "#/components/schemas/NotQueryV2"
          or: "#/components/schemas/OrQueryV2"
          startsWith: "#/components/schemas/StartsWithQuery"
          withinBoundingBox: "#/components/schemas/WithinBoundingBoxQuery"
          withinDistanceOf: "#/components/schemas/WithinDistanceOfQuery"
          withinPolygon: "#/components/schemas/WithinPolygonQuery"
      oneOf:
      - $ref: "#/components/schemas/LtQueryV2"
      - $ref: "#/components/schemas/GtQueryV2"
      - $ref: "#/components/schemas/LteQueryV2"
      - $ref: "#/components/schemas/GteQueryV2"
      - $ref: "#/components/schemas/EqualsQueryV2"
      - $ref: "#/components/schemas/IsNullQueryV2"
      - $ref: "#/components/schemas/ContainsQueryV2"
      - $ref: "#/components/schemas/AndQueryV2"
      - $ref: "#/components/schemas/OrQueryV2"
      - $ref: "#/components/schemas/NotQueryV2"
      - $ref: "#/components/schemas/StartsWithQuery"
      - $ref: "#/components/schemas/ContainsAllTermsInOrderQuery"
      - $ref: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm"
      - $ref: "#/components/schemas/ContainsAnyTermQuery"
      - $ref: "#/components/schemas/ContainsAllTermsQuery"
      - $ref: "#/components/schemas/WithinDistanceOfQuery"
      - $ref: "#/components/schemas/WithinBoundingBoxQuery"
      - $ref: "#/components/schemas/IntersectsBoundingBoxQuery"
      - $ref: "#/components/schemas/DoesNotIntersectBoundingBoxQuery"
      - $ref: "#/components/schemas/WithinPolygonQuery"
      - $ref: "#/components/schemas/IntersectsPolygonQuery"
      - $ref: "#/components/schemas/DoesNotIntersectPolygonQuery"
    SearchObjectsRequestV2:
      type: object
      properties:
        excludeRid:
          type: boolean
          description: |
            A flag to exclude the retrieval of the `__rid` property.
            Setting this to true may improve performance of this endpoint for object types in OSV2.
        orderBy:
          $ref: "#/components/schemas/SearchOrderByV2"
        pageSize:
          type: integer
        pageToken:
          type: string
        select:
          type: array
          description: |
            The API names of the object type properties to include in the response.
          items:
            type: string
        where:
          $ref: "#/components/schemas/SearchJsonQueryV2"
    SearchOrderByV2:
      type: object
      properties:
        fields:
          type: array
          items:
            $ref: "#/components/schemas/SearchOrderingV2"
      description: Specifies the ordering of search results by a field and an ordering
        direction.
    SearchOrderingV2:
      required:
      - field
      type: object
      properties:
        direction:
          type: string
          description: Specifies the ordering direction (can be either `asc` or `desc`)
        field:
          type: string
    SearchOutpatientActivityResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/OutpatientActivity"
        nextPageToken:
          type: string
    SearchPatientPathwayResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/PatientPathway"
        nextPageToken:
          type: string
    SearchPatientResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Patient"
        nextPageToken:
          type: string
    SearchProcedureResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Procedure"
        nextPageToken:
          type: string
    SearchProcedureStatusResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureStatus"
        nextPageToken:
          type: string
    SearchProcedureTypeResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ProcedureType"
        nextPageToken:
          type: string
    SearchReferralResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Referral"
        nextPageToken:
          type: string
    SearchSiteResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Site"
        nextPageToken:
          type: string
    SearchSpecialtyResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Specialty"
        nextPageToken:
          type: string
    SearchStaffUnavailabilityResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/StaffUnavailability"
        nextPageToken:
          type: string
    SearchTestResultResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/TestResult"
        nextPageToken:
          type: string
    SearchTheatreBookingResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/TheatreBooking"
        nextPageToken:
          type: string
    SearchTheatreSessionResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/TheatreSession"
        nextPageToken:
          type: string
    Site:
      required:
      - __apiName
      - __primaryKey
      - id
      - name
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        id:
          type: string
          description: "Primary Key: Site ID https://www.datadictionary.nhs.uk/attributes/organisation_site_identifier.html"
        name:
          type: string
          description: "Site Name: https://www.datadictionary.nhs.uk/attributes/organisation_site_name.html"
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values are derived from `rv_modules` and the `restricted-view-policy`
            dataset
          items:
            type: string
      description: "Hospital Site: https://www.datadictionary.nhs.uk/nhs_business_definitions/hospital_site.html.\
        \ Site information is required to allow users to filter waiting lists and\
        \ theatre sessions by hospital site."
    SiteProperties:
      type: string
      enum:
      - id
      - name
      - rvGroupIds
    Specialty:
      required:
      - __apiName
      - __primaryKey
      - isActiveSpecialty
      - specialtyId
      - specialtyName
      - theatreSpecialty
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        isActiveSpecialty:
          type: boolean
          description: '`true` if this is currently an active specialty at this trust'
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        specialtyId:
          type: string
          description: "ID for the specialty/treatment function. This should match\
            \ the codes listed in the NHS Data Dictionary: https://www.datadictionary.nhs.uk/supporting_information/main_specialty_and_treatment_function_codes_table.html"
        specialtyName:
          type: string
          description: "Textual description of the specialty/treatment function. This\
            \ should match the descriptions listed in the NHS Data Dictionary: https://www.datadictionary.nhs.uk/supporting_information/main_specialty_and_treatment_function_codes_table.html"
        theatreSpecialty:
          type: boolean
          description: '`true` if the specialty requires theatre sessions at this
            trust'
      description: "A reference dataset which contains a record per specialty and\
        \ treatment function. This is derived from the following NHS Data Dictionary\
        \ class: https://www.datadictionary.nhs.uk/supporting_information/main_specialty_and_treatment_function_codes_table.html.\
        \ Specialty and treatment function information is required to allow application\
        \ users to filter data so that they only view data relevant to them."
    SpecialtyProperties:
      type: string
      enum:
      - specialtyName
      - rvGroupIds
      - isActiveSpecialty
      - theatreSpecialty
      - specialtyId
    StaffUnavailability:
      required:
      - __apiName
      - __primaryKey
      - careProfessionalId
      - dateOfLeave
      - hours
      - id
      - leaveEndTime
      - leaveStartTime
      - leaveState
      - notes
      - title
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        careProfessionalId:
          type: string
          description: id of the care professional
        dateOfLeave:
          type: string
          description: Date on which the care professional is on leave
          format: date
        hours:
          type: string
          description: Total length of leave requested
          format: long
        id:
          type: string
          description: "Primary Key: Id for the row"
        leaveEndTime:
          type: string
          description: Time till which the care professional is unavailable on the
            date_of_leave date
          format: date-time
        leaveStartTime:
          type: string
          description: Time from which the care professional is unavailable on the
            date_of_leave date
          format: date-time
        leaveState:
          type: string
          description: Specifies whether leave is requested or confirmed.
        notes:
          type: string
          description: "Note describing the type of leave, example: Study Leave, Annual\
            \ Leave, On Call"
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        title:
          type: string
          description: Descriptive title formed by concatenating few important columns
      description: "Records absence and unavailability dates for staff. Each row is\
        \ a day of unavailability for a given staff member, with detail on what particular\
        \ kind of unavailability is it (e.g., Annual Leave, Study Leave, On Call),\
        \ status of request (Requested vs Confirmed), number of hours (if partial),\
        \ and additional notes. This is used for theatre staffing allocation workflow."
    StaffUnavailabilityProperties:
      type: string
      enum:
      - id
      - notes
      - hours
      - leaveEndTime
      - careProfessionalId
      - rvGroupIds
      - dateOfLeave
      - title
      - leaveStartTime
      - leaveState
    StartsWithQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          type: string
      description: Returns objects where the specified field starts with the provided
        value.
    SumAggregationV2:
      required:
      - field
      - type
      type: object
      properties:
        direction:
          $ref: "#/components/schemas/OrderByDirection"
        field:
          type: string
        name:
          type: string
        type:
          type: string
      description: Computes the sum of values for the provided field.
    TestResult:
      required:
      - __apiName
      - __primaryKey
      - attendanceId
      - expiryDate
      - orderingSpecialtyName
      - patientId
      - testDate
      - testId
      - testName
      - testResultId
      - testValueType
      - unit
      - value
      - valueDouble
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        attendanceId:
          type: string
          description: Attendance ID at which the test was performed
        expiryDate:
          type: string
          description: Date of test expiry. This can be `null` if the test has no
            expiry date.
          format: date-time
        orderingSpecialtyName:
          type: string
          description: Specialty for the linked appointment
        patientId:
          type: string
          description: patient ID for the subject of the test
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values are derived from `rv_modules` and the `restricted-view-policy`
            dataset
          items:
            type: string
        testDate:
          type: string
          description: Date the test was taken
          format: date-time
        testId:
          type: string
          description: Standardised test code. This can be either SNOMED or ICD10.
        testName:
          type: string
          description: "String name of test (e.g. Free T4 Level, blood or Platelet\
            \ count, blood, Covid). Only Covid test results are needed for OPTICA,\
            \ and must be called \"Covid positive\"."
        testResultId:
          type: string
          description: ID for the test result
        testValueType:
          type: string
          description: Indicates the data type of the test result value
        unit:
          type: string
          description: Unit of measurement for the value of the test (e.g. mL/L)
        value:
          type: string
          description: "Value of test result (e.g. 102, Target not detected, positive/negative).\
            \ Must be a Yes/No for OPTICA."
        valueDouble:
          type: number
          description: Double version of value
          format: double
      description: "Tests and test results ('clinical investigations') related to\
        \ the in-scope outpatient activity. This is used to allow clinical teams to\
        \ use test results in their patient decision-making and alerting. For OPTICA,\
        \ only Covid test results are needed for current and past admissions."
    TestResultProperties:
      type: string
      enum:
      - patientId
      - orderingSpecialtyName
      - attendanceId
      - testDate
      - testName
      - rvGroupIds
      - testId
      - unit
      - expiryDate
      - testValueType
      - value
      - valueDouble
      - testResultId
    TheatreBooking:
      required:
      - __apiName
      - __primaryKey
      - adjustedExpectedDuration
      - bookingCancelled
      - cancellationDate
      - cancellationReason
      - cancellationReasonFreeText
      - cancelledOtd
      - criticalCareBedStatus
      - datetimeBooked
      - ealId
      - encounterId
      - expectedDuration
      - fullName
      - intendedManagementCode
      - intendedPrimaryProcedureAnaesthetistRequired
      - intendedPrimaryProcedureDescription
      - intendedPrimaryProcedureFreeText
      - mrn
      - patientId
      - postOpBedRequired
      - primaryConsultantId
      - primaryConsultantName
      - primaryProcedureId
      - primaryProcedureStartTimeOrOrder
      - priority
      - riskDescription
      - riskRating
      - rttPathwayId
      - status
      - statusRender
      - theatreBookingId
      - theatreSessionDate
      - theatreSessionId
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        adjustedExpectedDuration:
          type: string
          description: "Granular calculated expected duration for the booking, i.e.\
            \ average duration per procedure for given specialty or clinician"
          format: long
        bookingCancelled:
          type: boolean
          description: "`True` if the booking_status is \"Cancelled\", `False` otherwise."
        cancellationDate:
          type: string
          description: The date on which the booking was cancelled
          format: date
        cancellationReason:
          type: string
          description: Textual reason for the cancellation of theatre booking
        cancellationReasonFreeText:
          type: string
          description: Additional free text coming from the theatres system regarding
            a cancellation
        cancelledOtd:
          type: boolean
          description: Flag to show whether the cancellation occured on the theatre
            session date.  if the booking status is inconsistant with the cancelation
            date.
        criticalCareBedStatus:
          type: string
          description: Identifies the status of a critical care bed if a patient requires
            it. Derived from the encounter
        datetimeBooked:
          type: string
          description: Timestamp when booking was created
          format: date-time
        ealId:
          type: string
          description: ID for the EAL entry that the booking is created for
        encounterId:
          type: string
          description: ID for the encounter the booking is created for
        expectedDuration:
          type: string
          description: Expected duration of booking in minutes
          format: long
        fullName:
          type: string
          description: "Full name for the patient associated with the booking. This\
            \ column uses the full_name value from the ccs-patient-v2 table, linked\
            \ on patient_id"
        intendedManagementCode:
          type: string
          description: https://www.datadictionary.nhs.uk/attributes/intended_management.html.
            Derived from the Encounter
        intendedPrimaryProcedureAnaesthetistRequired:
          type: boolean
          description: '`true` if anaesthetist is required for intended primary procedure'
        intendedPrimaryProcedureDescription:
          type: string
          description: "Textual description of the intended primary procedure to be\
            \ carried out within this booking. This column uses the intended_primary_procedure_description\
            \ value from the ccs-procedure table, linked on primary_procedure_id"
        intendedPrimaryProcedureFreeText:
          type: string
          description: "Free text comments related to the linked primary procedure.\
            \ This column uses the intended_primary_procedure_description value from\
            \ the ccs-procedure table, linked on primary_procedure_id"
        mrn:
          type: string
          description: "MRN for the patient associated with the booking. This column\
            \ uses the mrn value from the ccs-patient-v2 table, linked on patient_id"
        patientId:
          type: string
          description: ID for the patient booked in
        postOpBedRequired:
          type: boolean
          description: '`true` if a bed is required post operation for the patient'
        primaryConsultantId:
          type: string
          description: ID for the primary consultant associated to the theatre session
        primaryConsultantName:
          type: string
          description: Name of the primary consultant allocated to the theatre booking
        primaryProcedureId:
          type: string
          description: ID for the primary procedure the booking is created for
        primaryProcedureStartTimeOrOrder:
          type: string
          description: "Primary procedure start datetime in string format (yyyy-MM-dd\
            \ hh:mm:ss). This is used for sorting bookings within a theatre session\
            \ on the front end. This column uses the procedure_time_or_order value\
            \ from the ccs-procedure table, linked on primary_procedure_id"
        priority:
          type: string
          description: "Clinical priority of the linked Encounter (RCS or Urgent,\
            \ Cancer, Routine). This column uses the priority value from the ccs-encounters-v2\
            \ table, linked on encounter_id"
        riskDescription:
          type: string
          description: Textual description of the risk for patients flagged as high
            or medium risk in the risk_rating field
        riskRating:
          type: string
          description: Categorisation of the patient risk for this booking. The booking
            will be flagged to users in the front end if this value is "High Risk"
        rttPathwayId:
          type: string
          description: "RTT pathway ID: https://www.datadictionary.nhs.uk/classes/patient_pathway.html.\
            \ Derived from EAL"
        rvGroupIds:
          type: array
          items:
            type: string
        status:
          type: string
          description: Booking status of the theatre booking
        statusRender:
          type: string
          description: Colour render that is applied to the status column value in
            the front end
        theatreBookingId:
          type: string
          description: ID for the theatre booking event
        theatreSessionDate:
          type: string
          description: Date of theatre session the booking is assigned to. Derived
            using theatre_Session_id.
          format: date
        theatreSessionId:
          type: string
          description: ID for the theatre session the booking has been created in
      description: Contains theatre booking event information relating to encounters
        listed in the Encounters table. Theatre booking information is used to support
        users in booking patients into available theatre sessions and managing the
        readiness of upcoming theatre sessions
    TheatreBookingProperties:
      type: string
      enum:
      - intendedManagementCode
      - statusRender
      - criticalCareBedStatus
      - adjustedExpectedDuration
      - priority
      - theatreBookingId
      - status
      - rvGroupIds
      - cancellationReason
      - primaryConsultantName
      - datetimeBooked
      - fullName
      - mrn
      - intendedPrimaryProcedureAnaesthetistRequired
      - ealId
      - intendedPrimaryProcedureDescription
      - cancelledOtd
      - riskRating
      - expectedDuration
      - primaryConsultantId
      - patientId
      - primaryProcedureStartTimeOrOrder
      - postOpBedRequired
      - cancellationDate
      - bookingCancelled
      - intendedPrimaryProcedureFreeText
      - primaryProcedureId
      - encounterId
      - cancellationReasonFreeText
      - riskDescription
      - rttPathwayId
      - theatreSessionDate
      - theatreSessionId
    TheatreSession:
      required:
      - __apiName
      - __primaryKey
      - actualUtilisation
      - actualUtilisationStatus
      - actualUtilisedMinutes
      - adjustedBookedUtilisation
      - adjustedBookedUtilisationStatus
      - adjustedDurationMinutes
      - amPm
      - anaesthetistRequired
      - bookedMinutes
      - bookedUtilisation
      - bookedUtilisationStatus
      - bookingCancellationsOnTheDayCount
      - bookingCancellationsTotalCount
      - cancelled
      - consultantLeaveStatus
      - countBedsRequired
      - countCriticalCareBedsRequired
      - countOfBookings
      - date
      - dayOfWeek
      - dayOfWeekIndex
      - dayOfWeekOrdered
      - doubleBookedConsultant
      - doubleBookedTheatre
      - durationMinutes
      - endTime
      - excludeFromPoa
      - excludeFromTheatreScheduling
      - hasAnnualLeave
      - hasAnnualLeaveString
      - mnemonic
      - mnemonicShort
      - plannedDurationMinutes
      - plannedEndTime
      - plannedStartTime
      - pooledList
      - primaryAnaesthetistId
      - primaryAnaesthetistName
      - primaryConsultantId
      - primaryConsultantName
      - shortDisplayName
      - site
      - siteId
      - sortKey
      - specialtyId
      - specialtyName
      - startTime
      - status
      - stretchedEndTime
      - stretchedStartTime
      - theatreId
      - theatreName
      - theatreSessionId
      - theatreType
      - type
      - unbookedMinutes
      - unbookedMinutesStatus
      - usableUnbookedMinutes
      - weekDelta
      - weekDeltaString
      - weekDeltaStringDetails
      type: object
      properties:
        __apiName:
          type: string
        __primaryKey:
          type: string
        __rid:
          type: string
        actualUtilisation:
          type: number
          description: "Actual session utilisation ratio, defined as (actual utilised\
            \ time / available time)."
          format: double
        actualUtilisationStatus:
          type: string
          description: Used to specify colour rendering for the `actual_utilisation`
            value in frontend applications. Default values (> 1.0 Blue | >= 0.90 Green
            | >= 0.85 Yellow | >= 0.75 Orange | < 0.75 Red)
        actualUtilisedMinutes:
          type: integer
          description: Actual session utilisation duration
        adjustedBookedUtilisation:
          type: number
          description: "Adjusted booked utilisation percentage, defined as (time booked\
            \ / time available taking into account turnaround time between patients)"
          format: double
        adjustedBookedUtilisationStatus:
          type: string
          description: Used to specify colour rendering for the `adjusted_booked_utilisation`
            value in front-end applications. Default values (> 1.0 Blue | >= 0.90
            Green | >= 0.85 Yellow | >= 0.75 Orange | < 0.75 Red)
        adjustedDurationMinutes:
          type: integer
          description: Used to derive `adjusted_booked_utilisation`by dividing by
            planned_session_time
        amPm:
          type: string
          description: Session duration block (AM/PM/AD)
        anaesthetistIds:
          type: array
          description: Array of all IDs for anaesthetists assigned to the session
          items:
            type: string
        anaesthetistNames:
          type: array
          description: "Array of all names for anaesthetists assigned to the session.\
            \ This column uses the name field from the care-professional table, linked\
            \ on anaesthetist_ids"
          items:
            type: string
        anaesthetistRequired:
          type: boolean
          description: '`True` if an anaesthetist is required for the session'
        bookedMinutes:
          type: integer
          description: Minutes within the session allocated to booked patients
        bookedUtilisation:
          type: number
          description: "Booked utilisation ratio, defined as (minutes booked / total\
            \ minutes available)"
          format: double
        bookedUtilisationStatus:
          type: string
          description: Used to specify colour rendering for the `booked_utilisation`
            value in frontend applications. Default values (> 1.0 Blue | >= 0.90 Green
            | >= 0.85 Yellow | >= 0.75 Orange | < 0.75 Red)
        bookingCancellationsOnTheDayCount:
          type: integer
          description: The total number of booking cancellations for this session
            on the day or the day before
        bookingCancellationsTotalCount:
          type: integer
          description: The total number of booking cancellations for this session
        cancelled:
          type: boolean
          description: '`True` if the status field has the value "Cancelled"'
        comments:
          type: array
          description: Comments on theatre session for scheduling purposes
          items:
            type: string
        consultantIds:
          type: array
          description: Array of all IDs for consultants assigned to the session
          items:
            type: string
        consultantLeaveStatus:
          type: string
          description: Annual leave status of the primary consultant on the session
        consultantNames:
          type: array
          description: "Array of all names for consultants assigned to the session.\
            \ This column uses the name field from the care-professional table, linked\
            \ on consultant_ids"
          items:
            type: string
        countBedsRequired:
          type: string
          description: Count of the (post-op) beds required for bookings in the theatre
            session. Derived from the intended management of the bookings. Does not
            take into account bookings with a status of Cancelled or Rescheduled
          format: long
        countCriticalCareBedsRequired:
          type: string
          description: Count of the critical care beds required for bookings in the
            theatre session. Does not take into account bookings with a status of
            Cancelled or Rescheduled
          format: long
        countOfBookings:
          type: string
          description: "Count of booked patients, not including bookings with a status\
            \ of Cancelled or Rescheduled"
          format: long
        date:
          type: string
          description: "Date of theatre session: https://www.datadictionary.nhs.uk/attributes/session_date.html"
          format: date
        dayOfWeek:
          type: string
          description: Day of the week of the theatre session
        dayOfWeekIndex:
          type: integer
          description: Index of the day of the week of the theatre session where Monday
            is 1
        dayOfWeekOrdered:
          type: string
          description: "Day of the week of the theatre session prepended with the\
            \ index for ordering, e.g., where Monday is 1 - Monday"
        doubleBookedConsultant:
          type: boolean
          description: '`True` if the primary consultant is double booked. This can
            be derived by counting the number of sessions for each consultant during
            the same timeslot'
        doubleBookedTheatre:
          type: boolean
          description: '`True` if the theatre is double booked. This can be derived
            by counting the number of sessions in each theatre during the same timeslot'
        durationMinutes:
          type: integer
          description: Theatre session length in minutes
        endTime:
          type: string
          description: Theatre session actual end time
          format: date-time
        excludeFromPoa:
          type: boolean
          description: '`True` if this session should not be displayed in front end
            applications designed to support Pre-Operative Assessment management'
        excludeFromTheatreScheduling:
          type: boolean
          description: '`True` if the session should not be displayed in front end
            applications designed to support theatre management'
        hasAnnualLeave:
          type: boolean
          description: '`True` if the primary consultant assigned to the session has
            an annual leave event during the session'
        hasAnnualLeaveString:
          type: string
          description: "Reason/type of leave if the primary consultant is on leave,\
            \ otherwise null"
        mnemonic:
          type: string
          description: Theatre session mnemonic (abbreviation used by the planned
            care team to identify the slot). This can be a custom value for each trust
        mnemonicShort:
          type: string
          description: Shortened slot mnemonic
        plannedDurationMinutes:
          type: integer
          description: Theatre session planned length in minutes
        plannedEndTime:
          type: string
          description: Theatre session planned end time
          format: date-time
        plannedStartTime:
          type: string
          description: Theatre session planned start time
          format: date-time
        pooledList:
          type: boolean
          description: "`True` if this is a pooled patient waiting list, shared between\
            \ multiple surgeons"
        primaryAnaesthetistId:
          type: string
          description: ID for the primary anaethetist allocated to the theatre session
        primaryAnaesthetistName:
          type: string
          description: "Name of the primary anaethetist allocated to the theatre session.\
            \ This column uses the name field from the care-professional table, linked\
            \ on primary_anaesthetist_id"
        primaryConsultantId:
          type: string
          description: ID for the primary surgeon allocated to the theatre session
        primaryConsultantName:
          type: string
          description: "Name of the primary surgeon allocated to the theatre session.\
            \ This column uses the name value from the care-professional table, linked\
            \ on primary_consultant_id"
        rvGroupIds:
          type: array
          description: Designed to be used in group-based restricted view policies.
            The default values arederived from `object_id` and the `restricted-view-policy`
            dataset
          items:
            type: string
        shortDisplayName:
          type: string
          description: "Contains concatenation of anaesthetic type, utilisation and\
            \ primary consultant name"
        site:
          type: string
          description: "Hospital site where the operating theatre is located. This\
            \ column uses the name field from the site table, linked on site_id"
        siteId:
          type: string
          description: "ID for the hospital site where the operating theatre is located:\
            \ https://www.datadictionary.nhs.uk/nhs_business_definitions/hospital_site.html"
        sortKey:
          type: string
          description: concatination of properties that can be used to customize the
            sorting of sessions in frontend applications
        specialtyId:
          type: string
          description: Specialty assigned for the session
        specialtyName:
          type: string
          description: "Name of the specialty assigned to the session. This column\
            \ uses the specialty_name field from the specialty table, linked on specialty_id"
        startTime:
          type: string
          description: Theatre session actual start time
          format: date-time
        status:
          type: string
          description: The current status of the theatre session
        stretchedEndTime:
          type: string
          description: Planned end time mapping for calendar module
          format: date-time
        stretchedStartTime:
          type: string
          description: Planned start time mapping for calendar module
          format: date-time
        theatreId:
          type: string
          description: ID for the operating theatre the session will take place in
        theatreName:
          type: string
          description: "Name of the operating theatre in which the session will occur:\
            \ https://www.datadictionary.nhs.uk/classes/operating_theatre.html"
        theatreSessionId:
          type: string
          description: ID for the theatre session
        theatreType:
          type: string
          description: "Textual description of the theatre type (Main Theatre, Treatment\
            \ Centre, Paediatric Theatre, Other)"
        type:
          type: string
          description: "Type of theatre session (Elective, Non-Elective)"
        unbookedMinutes:
          type: integer
          description: Minutes within the session that are unallocated
        unbookedMinutesStatus:
          type: string
          description: Used to specify which colour the unbooked_minutes value is
            displayed as in the front-end. Default values (< 0 Blue | < 30 Green |
            < 60 Yellow | >= 60 Red)
        usableUnbookedMinutes:
          type: integer
          description: Usable booked minutes (e.g. removing turnaround time between
            patients)
        weekDelta:
          type: integer
          description: Number of weeks difference from `date` to the current week
            (negative if `date` is in the past)
        weekDeltaString:
          type: string
          description: Textual description of the week delta (e.g. Week 10)
        weekDeltaStringDetails:
          type: string
          description: "Textual description of the week delta with date (e.g. Week\
            \ 10: 01-01-2022)"
      description: "Theatre session; an allocation of theatre time to a surgeon to\
        \ perform procedures: https://www.datadictionary.nhs.uk/nhs_business_definitions/operating_theatre_session.html\
        \ Theatre session information is used to support users in booking patients\
        \ into available theatre sessions and managing the readiness of upcoming theatre\
        \ sessions"
    TheatreSessionProperties:
      type: string
      enum:
      - comments
      - anaesthetistIds
      - rvGroupIds
      - primaryConsultantName
      - anaesthetistNames
      - bookingCancellationsOnTheDayCount
      - pooledList
      - weekDeltaStringDetails
      - actualUtilisationStatus
      - consultantLeaveStatus
      - plannedStartTime
      - actualUtilisedMinutes
      - cancelled
      - plannedDurationMinutes
      - usableUnbookedMinutes
      - excludeFromTheatreScheduling
      - primaryConsultantId
      - stretchedStartTime
      - hasAnnualLeave
      - bookedMinutes
      - excludeFromPoa
      - actualUtilisation
      - adjustedBookedUtilisationStatus
      - adjustedDurationMinutes
      - dayOfWeekOrdered
      - shortDisplayName
      - specialtyName
      - bookedUtilisation
      - doubleBookedConsultant
      - consultantIds
      - mnemonic
      - dayOfWeek
      - theatreName
      - doubleBookedTheatre
      - dayOfWeekIndex
      - theatreId
      - status
      - theatreType
      - countCriticalCareBedsRequired
      - weekDelta
      - durationMinutes
      - specialtyId
      - mnemonicShort
      - sortKey
      - site
      - bookingCancellationsTotalCount
      - siteId
      - endTime
      - bookedUtilisationStatus
      - amPm
      - plannedEndTime
      - unbookedMinutesStatus
      - date
      - countBedsRequired
      - anaesthetistRequired
      - type
      - countOfBookings
      - primaryAnaesthetistId
      - unbookedMinutes
      - startTime
      - weekDeltaString
      - adjustedBookedUtilisation
      - primaryAnaesthetistName
      - stretchedEndTime
      - consultantNames
      - hasAnnualLeaveString
      - theatreSessionId
    TimeUnit:
      type: string
      enum:
      - MILLISECONDS
      - SECONDS
      - MINUTES
      - HOURS
      - DAYS
      - WEEKS
      - MONTHS
      - YEARS
      - QUARTERS
    WithinBoundingBoxPoint:
      discriminator:
        propertyName: type
        mapping:
          Point: "#/components/schemas/GeoPoint"
      oneOf:
      - $ref: "#/components/schemas/GeoPoint"
    WithinBoundingBoxQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          $ref: "#/components/schemas/BoundingBoxValue"
      description: |
        Returns objects where the specified field contains a point within the bounding box provided.
    WithinDistanceOfQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          $ref: "#/components/schemas/CenterPoint"
      description: |
        Returns objects where the specified field contains a point within the distance provided of the center point.
    WithinPolygonQuery:
      required:
      - field
      - type
      - value
      type: object
      properties:
        field:
          type: string
        type:
          type: string
        value:
          $ref: "#/components/schemas/PolygonValue"
      description: |
        Returns objects where the specified field contains a point within the polygon provided.
    admission:
      required:
      - admissionId
      - admissionMethod
      - admissionStatus
      - admissionTimestamp
      - admissionTitle
      - admissionType
      - dischargeDestinationType
      - dischargePathway
      - dischargeTimestamp
      - encounterId
      - estimatedDischargeDate
      - isDischargeTimeConfirmed
      - localAuthority
      - patientId
      - patientName
      - siteName
      - specialtyId
      - specialtyName
      - ward
      type: object
      properties:
        admissionId:
          type: string
        admissionMethod:
          type: string
        admissionStatus:
          type: string
        admissionTimestamp:
          type: string
          format: date-time
        admissionTitle:
          type: string
        admissionType:
          type: string
        dischargeDestinationType:
          type: string
        dischargePathway:
          type: string
        dischargeTimestamp:
          type: string
          format: date-time
        encounterId:
          type: string
        estimatedDischargeDate:
          type: string
          format: date-time
        isDischargeTimeConfirmed:
          type: boolean
        localAuthority:
          type: string
        patientId:
          type: string
        patientName:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        siteName:
          type: string
        specialtyId:
          type: string
        specialtyName:
          type: string
        ward:
          type: string
    appointment:
      required:
      - appointmentFreeText
      - attendanceId
      - bookedBy
      - bookedDuration
      - bookingStatus
      - cancellationReason
      - category
      - clinicId
      - code
      - dateTimeBooked
      - dateTimeCancelled
      - endDateTime
      - isFirstAppointment
      - isPoaAppointment
      - patientId
      - poaOutcome
      - priority
      - referralId
      - rttPathwayStatus
      - rttPeriodEndDate
      - rttPeriodLength
      - rttPeriodStartDate
      - specialtyId
      - specialtyName
      - startDateTime
      - treatmentFunctionCode
      - treatmentFunctionName
      - type
      type: object
      properties:
        appointmentFreeText:
          type: string
        attendanceId:
          type: string
        bookedBy:
          type: string
        bookedDuration:
          type: integer
        bookingStatus:
          type: string
        cancellationReason:
          type: string
        category:
          type: string
        clinicId:
          type: string
        code:
          type: string
        dateTimeBooked:
          type: string
          format: date-time
        dateTimeCancelled:
          type: string
          format: date-time
        endDateTime:
          type: string
          format: date-time
        isFirstAppointment:
          type: boolean
        isPoaAppointment:
          type: boolean
        patientId:
          type: string
        poaOutcome:
          type: string
        priority:
          type: string
        referralId:
          type: string
        rttPathwayStatus:
          type: string
        rttPeriodEndDate:
          type: string
          format: date
        rttPeriodLength:
          type: integer
        rttPeriodStartDate:
          type: string
          format: date
        rvGroupIds:
          type: array
          items:
            type: string
        specialtyId:
          type: string
        specialtyName:
          type: string
        startDateTime:
          type: string
          format: date-time
        treatmentFunctionCode:
          type: string
        treatmentFunctionName:
          type: string
        type:
          type: string
    careProfessional:
      required:
      - careProfessionalId
      - careProfessionalLocalId
      - isActive
      - name
      - role
      type: object
      properties:
        careProfessionalId:
          type: string
        careProfessionalLocalId:
          type: string
        isActive:
          type: boolean
        localSubSpecialties:
          type: array
          items:
            type: string
        name:
          type: string
        role:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
    clinicLetter:
      required:
      - appointmentId
      - clinicLetterDate
      - clinicLetterId
      - clinicLetterType
      - consultantId
      - patientId
      - specialtyName
      type: object
      properties:
        appointmentId:
          type: string
        clinicLetterDate:
          type: string
          format: date-time
        clinicLetterId:
          type: string
        clinicLetterType:
          type: string
        consultantId:
          type: string
        patientId:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        specialtyName:
          type: string
    clinicSession:
      required:
      - amPm
      - bookingTeam
      - careProfessionalId
      - clinicCode
      - clinicEndTimestamp
      - clinicFreeText
      - clinicId
      - clinicName
      - clinicStartTimestamp
      - clinicTypeActive
      - clinicTypeId
      - clinicTypeName
      - hasAnnualLeave
      - hasAnnualLeaveString
      - isCancelled
      - isPrivate
      - location
      - overbooked
      - roomId
      - siteId
      - siteName
      - specialtyId
      - startDayOfWeek
      - status
      - statusReason
      - totalBookedDuration
      - totalBookedSlots
      - totalDuration
      - totalSlots
      - totalVacantSlotDuration
      - totalVacantSlots
      - totalVacantSlotsFollowup
      - totalVacantSlotsNew
      - type
      type: object
      properties:
        amPm:
          type: string
        bookingTeam:
          type: string
        careProfessionalId:
          type: string
        clinicCode:
          type: string
        clinicEndTimestamp:
          type: string
          format: date-time
        clinicFreeText:
          type: string
        clinicId:
          type: string
        clinicName:
          type: string
        clinicStartTimestamp:
          type: string
          format: date-time
        clinicTypeActive:
          type: boolean
        clinicTypeId:
          type: string
        clinicTypeName:
          type: string
        hasAnnualLeave:
          type: boolean
        hasAnnualLeaveString:
          type: string
        isCancelled:
          type: boolean
        isPrivate:
          type: boolean
        location:
          type: string
        overbooked:
          type: boolean
        roomId:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        siteId:
          type: string
        siteName:
          type: string
        slotSpecialtyIds:
          type: array
          items:
            type: string
        specialtyId:
          type: string
        startDayOfWeek:
          type: string
        status:
          type: string
        statusReason:
          type: string
        totalBookedDuration:
          type: integer
        totalBookedSlots:
          type: integer
        totalDuration:
          type: integer
        totalSlots:
          type: integer
        totalVacantSlotDuration:
          type: integer
        totalVacantSlots:
          type: integer
        totalVacantSlotsFollowup:
          type: integer
        totalVacantSlotsNew:
          type: integer
        treatmentFunctionCodes:
          type: array
          items:
            type: string
        treatmentFunctionNames:
          type: array
          items:
            type: string
        type:
          type: string
    clinicSlot:
      required:
      - activityPriority
      - activityType
      - amPm
      - appointmentId
      - careProfessionalId
      - clinicId
      - comment
      - description
      - endTime
      - locationDescription
      - resourceCode
      - sessionType
      - siteId
      - siteName
      - slotDate
      - slotDuration
      - slotId
      - slotType
      - startTime
      - status
      type: object
      properties:
        activityPriority:
          type: string
        activityType:
          type: string
        amPm:
          type: string
        appointmentId:
          type: string
        careProfessionalId:
          type: string
        clinicId:
          type: string
        comment:
          type: string
        description:
          type: string
        endTime:
          type: string
          format: date-time
        locationDescription:
          type: string
        resourceCode:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        serviceIds:
          type: array
          items:
            type: string
        sessionType:
          type: string
        siteId:
          type: string
        siteName:
          type: string
        slotDate:
          type: string
          format: date
        slotDuration:
          type: integer
        slotId:
          type: string
        slotType:
          type: string
        startTime:
          type: string
          format: date-time
        status:
          type: string
    clinicType:
      required:
      - clinicTypeActive
      - clinicTypeName
      - specialtyId
      - uniqueId
      type: object
      properties:
        clinicTypeActive:
          type: boolean
        clinicTypeName:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        specialtyId:
          type: string
        uniqueId:
          type: string
    diagnosis:
      required:
      - active
      - diagnosisEndDate
      - diagnosisId
      - diagnosisName
      - diagnosisStartDate
      - encounterId
      - patientId
      type: object
      properties:
        active:
          type: string
        diagnosisEndDate:
          type: string
          format: date
        diagnosisId:
          type: string
        diagnosisName:
          type: string
        diagnosisStartDate:
          type: string
          format: date
        encounterId:
          type: string
        patientId:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
    diagnosticsWaitlistEntry:
      required:
      - addedToWaitlistTimestamp
      - diagnosticsDate
      - diagnosticsRequest
      - diagnosticsWaitlistId
      - pathwayId
      - patientId
      - priority
      - sixWeekBreachDate
      - specialtyId
      type: object
      properties:
        addedToWaitlistTimestamp:
          type: string
          format: date-time
        diagnosticsDate:
          type: string
          format: date
        diagnosticsRequest:
          type: string
        diagnosticsWaitlistId:
          type: string
        pathwayId:
          type: string
        patientId:
          type: string
        priority:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        sixWeekBreachDate:
          type: string
          format: date
        specialtyId:
          type: string
    ealEntry:
      required:
      - dateOf18WeekRttBreach
      - dateOf52WeekRttBreach
      - daysSinceDecidedToAdmitDate
      - daysTo18WeekRttBreach
      - daysTo52WeekRttBreach
      - decidedToAdmitDate
      - ealId
      - episodeId
      - hasRttPathwayDescription
      - isRtt
      - lessThan10WeeksToRttBreach
      - lessThan10WeeksToRttBreachString
      - pathwayId
      - patientId
      - patientName
      - plannedDate
      - priorityType
      - removalDate
      - removalReason
      - removalReasonLocal
      - rttDaysPaused
      - rttPeriod104WeekBreachDate
      - rttPeriod78WeekBreachDate
      - rttPeriodDaysTo104WeekBreach
      - rttPeriodDaysTo78WeekBreach
      - rttPeriodEndDate
      - rttPeriodId
      - rttPeriodIs68WeekWaiter
      - rttPeriodIs68WeekWaiterString
      - rttPeriodIs94WeekWaiter
      - rttPeriodIs94WeekWaiterString
      - rttPeriodLength
      - rttPeriodStartDate
      - rttStatusCode
      - rttTimeBands
      - rttWeeksWaiting
      - title
      type: object
      properties:
        dateOf18WeekRttBreach:
          type: string
          format: date
        dateOf52WeekRttBreach:
          type: string
          format: date
        daysSinceDecidedToAdmitDate:
          type: integer
        daysTo18WeekRttBreach:
          type: integer
        daysTo52WeekRttBreach:
          type: integer
        decidedToAdmitDate:
          type: string
          format: date
        ealId:
          type: string
        episodeId:
          type: string
        hasRttPathwayDescription:
          type: string
        isRtt:
          type: boolean
        lessThan10WeeksToRttBreach:
          type: boolean
        lessThan10WeeksToRttBreachString:
          type: string
        pathwayId:
          type: string
        patientId:
          type: string
        patientName:
          type: string
        plannedDate:
          type: string
          format: date
        priorityType:
          type: string
        removalDate:
          type: string
          format: date
        removalReason:
          type: string
        removalReasonLocal:
          type: string
        rttDaysPaused:
          type: integer
        rttPeriod104WeekBreachDate:
          type: string
          format: date
        rttPeriod78WeekBreachDate:
          type: string
          format: date
        rttPeriodDaysTo104WeekBreach:
          type: integer
        rttPeriodDaysTo78WeekBreach:
          type: integer
        rttPeriodEndDate:
          type: string
          format: date
        rttPeriodId:
          type: string
        rttPeriodIs68WeekWaiter:
          type: boolean
        rttPeriodIs68WeekWaiterString:
          type: string
        rttPeriodIs94WeekWaiter:
          type: boolean
        rttPeriodIs94WeekWaiterString:
          type: string
        rttPeriodLength:
          type: integer
        rttPeriodStartDate:
          type: string
          format: date
        rttStatusCode:
          type: string
        rttTimeBands:
          type: string
        rttWeeksWaiting:
          type: integer
        rvGroupIds:
          type: array
          items:
            type: string
        title:
          type: string
    encounter:
      required:
      - administrativeCategoryCode
      - administrativeCategoryDescription
      - admissionMethod
      - admissionStatus
      - admissionSubStatus
      - admissionType
      - atsTotalTheatreTime
      - calculatedTotalTheatreTime
      - createdBy
      - createdDate
      - criticalCareBedStatus
      - ealId
      - encounterFreeText
      - encounterId
      - encounterType
      - estimatedTotalTheatreTime
      - externalId
      - hasFutureTci
      - hasTci
      - intendedManagementCode
      - intendedManagementDescription
      - intendedPrimaryProcedureAnaestheticType
      - intendedPrimaryProcedureAnaesthetistRequired
      - intendedPrimaryProcedureCode
      - intendedPrimaryProcedureDescription
      - intendedPrimaryProcedureFreeText
      - intendedPrimaryProcedureFreeTextLong
      - isBooked
      - isMetricEncounter
      - isSuitableForPooledList
      - lastCovidSwabBookingStatus
      - lastCovidSwabOutcome
      - lastMrsaSwabBookingStatus
      - lastMrsaSwabOutcome
      - lastPoaBookingStatus
      - lastPoaOutcome
      - lastPoaScheduledOrAttendedDatetime
      - latestRcsClinicalHarmReview
      - localTreatmentFunction
      - needsReprioritisation
      - pathwayId
      - patientCancellationCount
      - patientId
      - patientName
      - periOpRiskStratificationOutcome
      - poaRequired
      - primaryConsultantId
      - primaryConsultantName
      - primaryProcedureStartTime
      - primaryProcedureType
      - priority
      - priorityLastUpdated
      - priorityOrdered
      - referralPriority
      - removalDate
      - removalReason
      - removalReasonCode
      - removed
      - site
      - siteId
      - specialtyId
      - specialtyName
      - suspectedCancerPathway
      - tciDate
      - tciStatus
      - title
      - transferStatus
      - treatmentFunctionCode
      - treatmentFunctionName
      - waitlistCode
      - ward
      type: object
      properties:
        administrativeCategoryCode:
          type: string
        administrativeCategoryDescription:
          type: string
        admissionMethod:
          type: string
        admissionStatus:
          type: string
        admissionSubStatus:
          type: string
        admissionType:
          type: string
        atsTotalTheatreTime:
          type: integer
        calculatedTotalTheatreTime:
          type: integer
        createdBy:
          type: string
        createdDate:
          type: string
          format: date
        criticalCareBedStatus:
          type: string
        ealId:
          type: string
        encounterFreeText:
          type: string
        encounterId:
          type: string
        encounterType:
          type: string
        estimatedTotalTheatreTime:
          type: integer
        externalId:
          type: string
        hasFutureTci:
          type: boolean
        hasTci:
          type: boolean
        intendedManagementCode:
          type: string
        intendedManagementDescription:
          type: string
        intendedPrimaryProcedureAnaestheticType:
          type: string
        intendedPrimaryProcedureAnaesthetistRequired:
          type: boolean
        intendedPrimaryProcedureCode:
          type: string
        intendedPrimaryProcedureDescription:
          type: string
        intendedPrimaryProcedureFreeText:
          type: string
        intendedPrimaryProcedureFreeTextLong:
          type: string
        isBooked:
          type: boolean
        isMetricEncounter:
          type: boolean
        isSuitableForPooledList:
          type: boolean
        issues:
          type: array
          items:
            type: string
        lastCovidSwabBookingStatus:
          type: string
        lastCovidSwabOutcome:
          type: string
        lastMrsaSwabBookingStatus:
          type: string
        lastMrsaSwabOutcome:
          type: string
        lastPoaBookingStatus:
          type: string
        lastPoaOutcome:
          type: string
        lastPoaScheduledOrAttendedDatetime:
          type: string
          format: date-time
        latestRcsClinicalHarmReview:
          type: string
        localTreatmentFunction:
          type: string
        needsReprioritisation:
          type: boolean
        pathwayId:
          type: string
        patientCancellationCount:
          type: integer
        patientId:
          type: string
        patientName:
          type: string
        periOpRiskStratificationOutcome:
          type: string
        poaRequired:
          type: string
        primaryConsultantId:
          type: string
        primaryConsultantName:
          type: string
        primaryProcedureStartTime:
          type: string
          format: date-time
        primaryProcedureType:
          type: string
        priority:
          type: string
        priorityLastUpdated:
          type: string
          format: date-time
        priorityOrdered:
          type: string
        referralPriority:
          type: string
        removalDate:
          type: string
          format: date
        removalReason:
          type: string
        removalReasonCode:
          type: string
        removed:
          type: boolean
        rvGroupIds:
          type: array
          items:
            type: string
        site:
          type: string
        siteId:
          type: string
        specialtyId:
          type: string
        specialtyName:
          type: string
        suspectedCancerPathway:
          type: boolean
        tciDate:
          type: string
          format: date
        tciStatus:
          type: string
        title:
          type: string
        transferStatus:
          type: string
        treatmentFunctionCode:
          type: string
        treatmentFunctionName:
          type: string
        waitlistCode:
          type: string
        ward:
          type: string
    ersService:
      required:
      - active
      - referralReason
      - serviceDirectoryId
      - serviceName
      - serviceType
      - siteId
      - uniqueId
      type: object
      properties:
        active:
          type: boolean
        referralReason:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        serviceDirectoryId:
          type: string
        serviceName:
          type: string
        serviceType:
          type: string
        siteId:
          type: string
        specialtyIds:
          type: array
          items:
            type: string
        uniqueId:
          type: string
    outpatientActivity:
      required:
      - bookedBy
      - dateAddedToWaitingList
      - daysToBookWithin
      - daysWaiting
      - division
      - dueDate
      - earliestDueDate
      - encounterId
      - externalId
      - fullName
      - isPrivate
      - isReferral
      - lastAppointmentId
      - lastCancelledAppointmentId
      - mrn
      - newOrFollowUp
      - nextAppointmentId
      - nextCancelledAppointmentId
      - outpatientActivityFreeText
      - pathwayId
      - patientId
      - patientIsOnCancerPathway
      - primaryCareProfessionalId
      - priority
      - referralDate
      - referralId
      - removed
      - removedTimestamp
      - requestedAppointmentType
      - rttPathwayStatus
      - rttPeriodEndDate
      - rttPeriodLength
      - rttPeriodStartDate
      - rttPeriodStatusCode
      - siteId
      - siteName
      - source
      - sourceListName
      - sourceUniqueWaitingListEntryId
      - specialtyId
      - specialtyName
      - status
      - statusUpdatedAt
      - title
      - treatmentFunctionCode
      - treatmentFunctionName
      - waitingListEntryId
      - weeksWaiting
      type: object
      properties:
        bookedBy:
          type: string
        dateAddedToWaitingList:
          type: string
          format: date
        daysToBookWithin:
          type: integer
        daysWaiting:
          type: integer
        division:
          type: string
        dueDate:
          type: string
          format: date
        earliestDueDate:
          type: string
          format: date
        encounterId:
          type: string
        externalId:
          type: string
        fullName:
          type: string
        isPrivate:
          type: boolean
        isReferral:
          type: boolean
        issues:
          type: array
          items:
            type: string
        lastAppointmentId:
          type: string
        lastCancelledAppointmentId:
          type: string
        mrn:
          type: string
        newOrFollowUp:
          type: string
        nextAppointmentId:
          type: string
        nextCancelledAppointmentId:
          type: string
        outpatientActivityFreeText:
          type: string
        pathwayId:
          type: string
        patientId:
          type: string
        patientIsOnCancerPathway:
          type: boolean
        primaryCareProfessionalId:
          type: string
        priority:
          type: string
        referralDate:
          type: string
          format: date
        referralId:
          type: string
        removed:
          type: boolean
        removedTimestamp:
          type: string
          format: date-time
        requestedAppointmentType:
          type: string
        rttPathwayStatus:
          type: string
        rttPeriodEndDate:
          type: string
          format: date
        rttPeriodLength:
          type: integer
        rttPeriodStartDate:
          type: string
          format: date
        rttPeriodStatusCode:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        siteId:
          type: string
        siteName:
          type: string
        source:
          type: string
        sourceListName:
          type: string
        sourceUniqueWaitingListEntryId:
          type: string
        specialtyId:
          type: string
        specialtyName:
          type: string
        status:
          type: string
        statusUpdatedAt:
          type: string
          format: date-time
        title:
          type: string
        treatmentFunctionCode:
          type: string
        treatmentFunctionName:
          type: string
        waitingListEntryId:
          type: string
        weeksWaiting:
          type: integer
    patient:
      required:
      - addressLine1
      - addressLine2
      - age
      - dateOfBirth
      - dateOfDeath
      - deceased
      - firstName
      - fullName
      - genderIdentity
      - mrn
      - nextOfKinName
      - nextOfKinNumber
      - nhsNumber
      - personId
      - phoneNumber
      - postcode
      - registeredGp
      - sex
      - surname
      - title
      type: object
      properties:
        addressLine1:
          type: string
        addressLine2:
          type: string
        age:
          type: string
          format: long
        dateOfBirth:
          type: string
          format: date
        dateOfDeath:
          type: string
          format: date
        deceased:
          type: boolean
        firstName:
          type: string
        fullName:
          type: string
        genderIdentity:
          type: string
        mrn:
          type: string
        nextOfKinName:
          type: string
        nextOfKinNumber:
          type: string
        nhsNumber:
          type: string
        personId:
          type: string
        phoneNumber:
          type: string
        postcode:
          type: string
        registeredGp:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        sex:
          type: string
        surname:
          type: string
        title:
          type: string
    patientPathway:
      required:
      - admissionMethodCode
      - age
      - consultantId
      - consultantName
      - covidPriority
      - covidPriorityDate
      - dataSource
      - dateOfBirth
      - directorate
      - division
      - dtaDate
      - intendedProcedureDescription
      - lastAppointment
      - lastAppointmentDate
      - lastAppointmentDescription
      - lastClinicLetterDate
      - lastClinicLetterType
      - lastOpaDate
      - lastOpaOutcome
      - lastPathwayActivity
      - lastPathwayActivityDate
      - lastTestResultDate
      - latestReferralReceivedDate
      - localSubSpecialtyCode
      - localSubSpecialtyDescription
      - mrn
      - nextAppointment
      - nextAppointmentDate
      - nextAppointmentDescription
      - nextAppointmentStatus
      - nextDiagnosticsDate
      - nextOpaDate
      - nhsCcg
      - nhsNumber
      - owlClinicCode
      - owlFlag
      - owlGroupCode
      - pathwayClass
      - pathwayId
      - pathwayStatus
      - pathwayType
      - patientDeceased
      - patientId
      - patientName
      - referralDate
      - referralPriority
      - referralReceivedDate
      - referralSource
      - siteId
      - siteName
      - specialtyId
      - specialtyName
      - tciDate
      - treatmentFunctionCode
      - treatmentFunctionName
      - ubrn
      type: object
      properties:
        admissionMethodCode:
          type: string
        age:
          type: string
          format: long
        consultantId:
          type: string
        consultantName:
          type: string
        covidPriority:
          type: string
        covidPriorityDate:
          type: string
          format: date
        dataSource:
          type: string
        dateOfBirth:
          type: string
          format: date
        directorate:
          type: string
        division:
          type: string
        dtaDate:
          type: string
          format: date
        intendedProcedureDescription:
          type: string
        lastAppointment:
          type: string
        lastAppointmentDate:
          type: string
          format: date
        lastAppointmentDescription:
          type: string
        lastClinicLetterDate:
          type: string
          format: date-time
        lastClinicLetterType:
          type: string
        lastOpaDate:
          type: string
          format: date
        lastOpaOutcome:
          type: string
        lastPathwayActivity:
          type: string
        lastPathwayActivityDate:
          type: string
          format: date
        lastTestResultDate:
          type: string
          format: date-time
        latestReferralReceivedDate:
          type: string
          format: date
        localSubSpecialtyCode:
          type: string
        localSubSpecialtyDescription:
          type: string
        mrn:
          type: string
        nextAppointment:
          type: string
        nextAppointmentDate:
          type: string
          format: date
        nextAppointmentDescription:
          type: string
        nextAppointmentStatus:
          type: string
        nextDiagnosticsDate:
          type: string
          format: date
        nextOpaDate:
          type: string
          format: date
        nhsCcg:
          type: string
        nhsNumber:
          type: string
        owlClinicCode:
          type: string
        owlFlag:
          type: boolean
        owlGroupCode:
          type: string
        pathwayClass:
          type: string
        pathwayId:
          type: string
        pathwayStatus:
          type: string
        pathwayType:
          type: string
        patientDeceased:
          type: boolean
        patientId:
          type: string
        patientName:
          type: string
        referralDate:
          type: string
          format: date
        referralPriority:
          type: string
        referralReceivedDate:
          type: string
          format: date
        referralSource:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        siteId:
          type: string
        siteName:
          type: string
        specialtyId:
          type: string
        specialtyName:
          type: string
        tciDate:
          type: string
          format: date
        treatmentFunctionCode:
          type: string
        treatmentFunctionName:
          type: string
        ubrn:
          type: string
    procedure:
      required:
      - actualProcedureTimeKnifeToSkinClosure
      - actualProcedureTimeTotalTheatreTime
      - admissionMethodDescription
      - anaestheticTypeToBeUsed
      - anaesthetistRequired
      - encounterId
      - estimatedProcedureTimeKnifeToSkinClosure
      - estimatedProcedureTimeStrategy
      - estimatedProcedureTimeTotalTheatreTime
      - expectedLengthOfStay
      - intendedProcedureCode
      - intendedProcedureDescription
      - intendedProcedureFreeText
      - isPrimaryProcedure
      - patientId
      - primaryConsultantId
      - priority
      - priorityOrdered
      - procedureDate
      - procedureId
      - procedureOrdered
      - procedureTimeOrOrder
      - theatreSessionId
      - title
      type: object
      properties:
        actualProcedureTimeKnifeToSkinClosure:
          type: integer
        actualProcedureTimeTotalTheatreTime:
          type: integer
        admissionMethodDescription:
          type: string
        anaestheticTypeToBeUsed:
          type: string
        anaesthetistRequired:
          type: boolean
        encounterId:
          type: string
        estimatedProcedureTimeKnifeToSkinClosure:
          type: integer
        estimatedProcedureTimeStrategy:
          type: string
        estimatedProcedureTimeTotalTheatreTime:
          type: integer
        expectedLengthOfStay:
          type: string
        intendedProcedureCode:
          type: string
        intendedProcedureDescription:
          type: string
        intendedProcedureFreeText:
          type: string
        isPrimaryProcedure:
          type: boolean
        patientId:
          type: string
        primaryConsultantId:
          type: string
        priority:
          type: string
        priorityOrdered:
          type: string
        procedureDate:
          type: string
          format: date
        procedureId:
          type: string
        procedureOrdered:
          type: integer
        procedureTimeOrOrder:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        theatreSessionId:
          type: string
        title:
          type: string
    procedureStatus:
      required:
      - covidSwabAppointmentId
      - covidSwabAttendedDatetime
      - covidSwabBookedDatetime
      - covidSwabBookingStatus
      - covidSwabOutcome
      - encounterId
      - isPrimaryProcedure
      - mrsaSwabAppointmentId
      - mrsaSwabAttendedDatetime
      - mrsaSwabBookedDatetime
      - mrsaSwabBookingStatus
      - mrsaSwabOutcome
      - patientId
      - poaAppointmentId
      - poaBookedDatetime
      - poaBookingStatus
      - poaOrdering
      - poaOutcome
      - poaOutcomeFreeText
      - poaScheduledOrAttendedDatetime
      - procedureId
      - procedureStatusId
      - theatreBookingId
      type: object
      properties:
        covidSwabAppointmentId:
          type: string
        covidSwabAttendedDatetime:
          type: string
          format: date-time
        covidSwabBookedDatetime:
          type: string
          format: date-time
        covidSwabBookingStatus:
          type: string
        covidSwabOutcome:
          type: string
        encounterId:
          type: string
        isPrimaryProcedure:
          type: boolean
        mrsaSwabAppointmentId:
          type: string
        mrsaSwabAttendedDatetime:
          type: string
          format: date-time
        mrsaSwabBookedDatetime:
          type: string
          format: date-time
        mrsaSwabBookingStatus:
          type: string
        mrsaSwabOutcome:
          type: string
        patientId:
          type: string
        poaAppointmentId:
          type: string
        poaBookedDatetime:
          type: string
          format: date-time
        poaBookingStatus:
          type: string
        poaOrdering:
          type: integer
        poaOutcome:
          type: string
        poaOutcomeFreeText:
          type: string
        poaScheduledOrAttendedDatetime:
          type: string
          format: date-time
        procedureId:
          type: string
        procedureStatusId:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        theatreBookingId:
          type: string
    referral:
      required:
      - dateReferralAccepted
      - dateReferralCreated
      - dateReferralReceived
      - daysToBookWithin
      - daysWaiting
      - dueDate
      - earliestDueDate
      - fullName
      - mrn
      - patientId
      - patientIsOnCancerPathway
      - primaryCareProfessionalId
      - priority
      - referralId
      - referralNotes
      - referralSource
      - removed
      - removedTimestamp
      - requestedAppointmentType
      - rttPathwayStatus
      - rttPeriodEndDate
      - rttPeriodLength
      - rttPeriodStartDate
      - serviceId
      - serviceName
      - serviceType
      - siteId
      - siteName
      - source
      - sourceUniqueId
      - specialtyId
      - specialtyName
      - status
      - title
      - ubrn
      - weeksWaiting
      type: object
      properties:
        dateReferralAccepted:
          type: string
          format: date
        dateReferralCreated:
          type: string
          format: date
        dateReferralReceived:
          type: string
          format: date
        daysToBookWithin:
          type: integer
        daysWaiting:
          type: integer
        dueDate:
          type: string
          format: date
        earliestDueDate:
          type: string
          format: date
        fullName:
          type: string
        mrn:
          type: string
        pathwayId:
          type: array
          items:
            type: string
        patientId:
          type: string
        patientIsOnCancerPathway:
          type: boolean
        primaryCareProfessionalId:
          type: string
        priority:
          type: string
        referralId:
          type: string
        referralNotes:
          type: string
        referralSource:
          type: string
        removed:
          type: boolean
        removedTimestamp:
          type: string
          format: date-time
        requestedAppointmentType:
          type: string
        rttPathwayStatus:
          type: string
        rttPeriodEndDate:
          type: string
          format: date
        rttPeriodLength:
          type: integer
        rttPeriodStartDate:
          type: string
          format: date
        rvGroupIds:
          type: array
          items:
            type: string
        serviceId:
          type: string
        serviceName:
          type: string
        serviceType:
          type: string
        siteId:
          type: string
        siteName:
          type: string
        source:
          type: string
        sourceUniqueId:
          type: string
        specialtyId:
          type: string
        specialtyName:
          type: string
        status:
          type: string
        title:
          type: string
        ubrn:
          type: string
        weeksWaiting:
          type: integer
    site:
      required:
      - id
      - name
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
    specialty:
      required:
      - isActiveSpecialty
      - specialtyId
      - specialtyName
      - theatreSpecialty
      type: object
      properties:
        isActiveSpecialty:
          type: boolean
        rvGroupIds:
          type: array
          items:
            type: string
        specialtyId:
          type: string
        specialtyName:
          type: string
        theatreSpecialty:
          type: boolean
    staffUnavailability:
      required:
      - careProfessionalId
      - dateOfLeave
      - hours
      - id
      - leaveEndTime
      - leaveStartTime
      - leaveState
      - notes
      - title
      type: object
      properties:
        careProfessionalId:
          type: string
        dateOfLeave:
          type: string
          format: date
        hours:
          type: string
          format: long
        id:
          type: string
        leaveEndTime:
          type: string
          format: date-time
        leaveStartTime:
          type: string
          format: date-time
        leaveState:
          type: string
        notes:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        title:
          type: string
    testResult:
      required:
      - attendanceId
      - expiryDate
      - orderingSpecialtyName
      - patientId
      - testDate
      - testId
      - testName
      - testResultId
      - testValueType
      - unit
      - value
      - valueDouble
      type: object
      properties:
        attendanceId:
          type: string
        expiryDate:
          type: string
          format: date-time
        orderingSpecialtyName:
          type: string
        patientId:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        testDate:
          type: string
          format: date-time
        testId:
          type: string
        testName:
          type: string
        testResultId:
          type: string
        testValueType:
          type: string
        unit:
          type: string
        value:
          type: string
        valueDouble:
          type: number
          format: double
    theatreBooking:
      required:
      - adjustedExpectedDuration
      - bookingCancelled
      - cancellationDate
      - cancellationReason
      - cancellationReasonFreeText
      - cancelledOtd
      - criticalCareBedStatus
      - datetimeBooked
      - ealId
      - encounterId
      - expectedDuration
      - fullName
      - intendedManagementCode
      - intendedPrimaryProcedureAnaesthetistRequired
      - intendedPrimaryProcedureDescription
      - intendedPrimaryProcedureFreeText
      - mrn
      - patientId
      - postOpBedRequired
      - primaryConsultantId
      - primaryConsultantName
      - primaryProcedureId
      - primaryProcedureStartTimeOrOrder
      - priority
      - riskDescription
      - riskRating
      - rttPathwayId
      - status
      - statusRender
      - theatreBookingId
      - theatreSessionDate
      - theatreSessionId
      type: object
      properties:
        adjustedExpectedDuration:
          type: string
          format: long
        bookingCancelled:
          type: boolean
        cancellationDate:
          type: string
          format: date
        cancellationReason:
          type: string
        cancellationReasonFreeText:
          type: string
        cancelledOtd:
          type: boolean
        criticalCareBedStatus:
          type: string
        datetimeBooked:
          type: string
          format: date-time
        ealId:
          type: string
        encounterId:
          type: string
        expectedDuration:
          type: string
          format: long
        fullName:
          type: string
        intendedManagementCode:
          type: string
        intendedPrimaryProcedureAnaesthetistRequired:
          type: boolean
        intendedPrimaryProcedureDescription:
          type: string
        intendedPrimaryProcedureFreeText:
          type: string
        mrn:
          type: string
        patientId:
          type: string
        postOpBedRequired:
          type: boolean
        primaryConsultantId:
          type: string
        primaryConsultantName:
          type: string
        primaryProcedureId:
          type: string
        primaryProcedureStartTimeOrOrder:
          type: string
        priority:
          type: string
        riskDescription:
          type: string
        riskRating:
          type: string
        rttPathwayId:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        status:
          type: string
        statusRender:
          type: string
        theatreBookingId:
          type: string
        theatreSessionDate:
          type: string
          format: date
        theatreSessionId:
          type: string
    theatreSession:
      required:
      - actualUtilisation
      - actualUtilisationStatus
      - actualUtilisedMinutes
      - adjustedBookedUtilisation
      - adjustedBookedUtilisationStatus
      - adjustedDurationMinutes
      - amPm
      - anaesthetistRequired
      - bookedMinutes
      - bookedUtilisation
      - bookedUtilisationStatus
      - bookingCancellationsOnTheDayCount
      - bookingCancellationsTotalCount
      - cancelled
      - consultantLeaveStatus
      - countBedsRequired
      - countCriticalCareBedsRequired
      - countOfBookings
      - date
      - dayOfWeek
      - dayOfWeekIndex
      - dayOfWeekOrdered
      - doubleBookedConsultant
      - doubleBookedTheatre
      - durationMinutes
      - endTime
      - excludeFromPoa
      - excludeFromTheatreScheduling
      - hasAnnualLeave
      - hasAnnualLeaveString
      - mnemonic
      - mnemonicShort
      - plannedDurationMinutes
      - plannedEndTime
      - plannedStartTime
      - pooledList
      - primaryAnaesthetistId
      - primaryAnaesthetistName
      - primaryConsultantId
      - primaryConsultantName
      - shortDisplayName
      - site
      - siteId
      - sortKey
      - specialtyId
      - specialtyName
      - startTime
      - status
      - stretchedEndTime
      - stretchedStartTime
      - theatreId
      - theatreName
      - theatreSessionId
      - theatreType
      - type
      - unbookedMinutes
      - unbookedMinutesStatus
      - usableUnbookedMinutes
      - weekDelta
      - weekDeltaString
      - weekDeltaStringDetails
      type: object
      properties:
        actualUtilisation:
          type: number
          format: double
        actualUtilisationStatus:
          type: string
        actualUtilisedMinutes:
          type: integer
        adjustedBookedUtilisation:
          type: number
          format: double
        adjustedBookedUtilisationStatus:
          type: string
        adjustedDurationMinutes:
          type: integer
        amPm:
          type: string
        anaesthetistIds:
          type: array
          items:
            type: string
        anaesthetistNames:
          type: array
          items:
            type: string
        anaesthetistRequired:
          type: boolean
        bookedMinutes:
          type: integer
        bookedUtilisation:
          type: number
          format: double
        bookedUtilisationStatus:
          type: string
        bookingCancellationsOnTheDayCount:
          type: integer
        bookingCancellationsTotalCount:
          type: integer
        cancelled:
          type: boolean
        comments:
          type: array
          items:
            type: string
        consultantIds:
          type: array
          items:
            type: string
        consultantLeaveStatus:
          type: string
        consultantNames:
          type: array
          items:
            type: string
        countBedsRequired:
          type: string
          format: long
        countCriticalCareBedsRequired:
          type: string
          format: long
        countOfBookings:
          type: string
          format: long
        date:
          type: string
          format: date
        dayOfWeek:
          type: string
        dayOfWeekIndex:
          type: integer
        dayOfWeekOrdered:
          type: string
        doubleBookedConsultant:
          type: boolean
        doubleBookedTheatre:
          type: boolean
        durationMinutes:
          type: integer
        endTime:
          type: string
          format: date-time
        excludeFromPoa:
          type: boolean
        excludeFromTheatreScheduling:
          type: boolean
        hasAnnualLeave:
          type: boolean
        hasAnnualLeaveString:
          type: string
        mnemonic:
          type: string
        mnemonicShort:
          type: string
        plannedDurationMinutes:
          type: integer
        plannedEndTime:
          type: string
          format: date-time
        plannedStartTime:
          type: string
          format: date-time
        pooledList:
          type: boolean
        primaryAnaesthetistId:
          type: string
        primaryAnaesthetistName:
          type: string
        primaryConsultantId:
          type: string
        primaryConsultantName:
          type: string
        rvGroupIds:
          type: array
          items:
            type: string
        shortDisplayName:
          type: string
        site:
          type: string
        siteId:
          type: string
        sortKey:
          type: string
        specialtyId:
          type: string
        specialtyName:
          type: string
        startTime:
          type: string
          format: date-time
        status:
          type: string
        stretchedEndTime:
          type: string
          format: date-time
        stretchedStartTime:
          type: string
          format: date-time
        theatreId:
          type: string
        theatreName:
          type: string
        theatreSessionId:
          type: string
        theatreType:
          type: string
        type:
          type: string
        unbookedMinutes:
          type: integer
        unbookedMinutesStatus:
          type: string
        usableUnbookedMinutes:
          type: integer
        weekDelta:
          type: integer
        weekDeltaString:
          type: string
        weekDeltaStringDetails:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer